const AUTO
pub const AUTO = 0用途
常量 AUTO,定义了相关的协议或算法配置参数。
#gpu#gpu 是 Xu 标准库提供的底层 GPU 设备与资源抽象层。支持无窗口设备创建、缓冲区、2D 纹理与 Mipmap、采样器、着色器、图形与计算管线、命令录制(CommandEncoder)、栅栏同步以及精确字节回读(Readback)。
所有 GPU 资源支持通过 close 显式释放或析构时自动 drop。设备及资源操作应保持在主线程;纹理格式定义见 gpu/layout。
@main
#gpu
fn main() {
$device := gpu.open(gpu.DeviceOptions{backend: gpu.AUTO, debug: false, shader_formats: 0}) or {
println("GPU backend unavailable")
return
}
$buffer := device.buffer(4, gpu.BUFFER_VERTEX) or >>
input := [u8(0), u8(127), u8(128), u8(255)]
device.upload(&buffer, 0, &input) or >>
$result := device.download(&buffer, 0, 4) or >>
result.wait() or >>
$output := [u8(0), u8(0), u8(0), u8(0)]
result.read($&output) or >>
println("downloaded byte:", output[3])
}预期输出:downloaded byte: 255。
const AUTOpub const AUTO = 0常量 AUTO,定义了相关的协议或算法配置参数。
const METALpub const METAL = 1常量 METAL,定义了相关的协议或算法配置参数。
const VULKANpub const VULKAN = 2常量 VULKAN,定义了相关的协议或算法配置参数。
const D3D12pub const D3D12 = 3常量 D3D12,定义了相关的协议或算法配置参数。
const SHADER_SPIRVpub const SHADER_SPIRV = 1常量 SHADER_SPIRV,定义了相关的协议或算法配置参数。
const SHADER_DXBCpub const SHADER_DXBC = 2常量 SHADER_DXBC,定义了相关的协议或算法配置参数。
const SHADER_DXILpub const SHADER_DXIL = 4常量 SHADER_DXIL,定义了相关的协议或算法配置参数。
const SHADER_MSLpub const SHADER_MSL = 8常量 SHADER_MSL,定义了相关的协议或算法配置参数。
const SHADER_METALLIBpub const SHADER_METALLIB = 16常量 SHADER_METALLIB,定义了相关的协议或算法配置参数。
const BUFFER_VERTEXpub const BUFFER_VERTEX = 1常量 BUFFER_VERTEX,定义了相关的协议或算法配置参数。
const BUFFER_INDEXpub const BUFFER_INDEX = 2常量 BUFFER_INDEX,定义了相关的协议或算法配置参数。
const BUFFER_INDIRECTpub const BUFFER_INDIRECT = 4常量 BUFFER_INDIRECT,定义了相关的协议或算法配置参数。
const BUFFER_GRAPHICS_STORAGE_READpub const BUFFER_GRAPHICS_STORAGE_READ = 8常量 BUFFER_GRAPHICS_STORAGE_READ,定义了相关的协议或算法配置参数。
const BUFFER_COMPUTE_STORAGE_READpub const BUFFER_COMPUTE_STORAGE_READ = 16常量 BUFFER_COMPUTE_STORAGE_READ,定义了相关的协议或算法配置参数。
const BUFFER_COMPUTE_STORAGE_WRITEpub const BUFFER_COMPUTE_STORAGE_WRITE = 32常量 BUFFER_COMPUTE_STORAGE_WRITE,定义了相关的协议或算法配置参数。
const TRANSFER_ALIGNMENTpub const TRANSFER_ALIGNMENT = 4常量 TRANSFER_ALIGNMENT,定义了相关的协议或算法配置参数。
struct DeviceOptionspub struct DeviceOptions {
pub backend int
pub debug bool
pub shader_formats int
}Gpu 配置参数与选项集合。
backend intdebug boolshader_formats intstruct Devicepub struct Device {
}Device 上下文或状态结构体。
此类型没有公开字段。
struct Bufferpub struct Buffer {
}Buffer 上下文或状态结构体。
此类型没有公开字段。
struct Fencepub struct Fence {
}Fence 上下文或状态结构体。
此类型没有公开字段。
struct Readbackpub struct Readback {
}Readback 上下文或状态结构体。
此类型没有公开字段。
struct Statspub struct Stats {
pub buffer_count int
pub buffer_bytes int
pub submission_count int
pub staging_bytes int
pub texture_count int
pub texture_bytes int
pub sampler_count int
pub shader_count int
pub pipeline_count int
pub encoder_count int
pub render_pass_count int
pub compute_pipeline_count int
pub compute_pass_count int
pub surface_count int
pub frame_count int
}承载 buffer_count、buffer_bytes、submission_count、staging_bytes、texture_count 等属性的结构体。
buffer_count intbuffer_bytes intsubmission_count intstaging_bytes inttexture_count inttexture_bytes intsampler_count intshader_count intpipeline_count intencoder_count intrender_pass_count intcompute_pipeline_count intcompute_pass_count intsurface_count intframe_count intis_availablepub fn is_available(options DeviceOptions) bool判断是否 available。
options DeviceOptionsbool — 是否成立
openpub fn open(options DeviceOptions) Device打开资源或建立网络连接。失败时抛出错误,调用方需处理或继续传播。
options DeviceOptionsDevice — 该类型的值
(&Device) backendpub fn (device &Device) backend() int在 &Device 上执行 backend 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Device) shader_formatspub fn (device &Device) shader_formats() int&Device 上的操作:执行 shader formats 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Device) statspub fn (device &Device) stats() Stats在 &Device 上执行 stats 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。Stats — 该类型的值
(&Device) bufferpub fn (device &Device) buffer(size_bytes int, usage int) Buffer&Device 上的操作:缓冲。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。size_bytes intusage intBuffer — 该类型的值
(&Buffer) size_bytespub fn (buffer &Buffer) size_bytes() int&Buffer 上的操作:尺寸字节。
buffer &BufferBuffer 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Device) uploadpub fn (device &Device) upload(buffer &Buffer, offset int, bytes &[]u8) Fence在 &Device 上执行 upload 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。buffer &Bufferoffset intbytes &[]u8Fence — 该类型的值
(&Device) copypub fn (device &Device) copy(source &Buffer, source_offset int, destination &Buffer, destination_offset int, size_bytes int) Fence&Device 上的操作:拷贝。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。source &Buffersource_offset intdestination &Bufferdestination_offset intsize_bytes intFence — 该类型的值
(&Device) downloadpub fn (device &Device) download(buffer &Buffer, offset int, size_bytes int) Readback在 &Device 上执行 download 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。buffer &Bufferoffset intsize_bytes intReadback — 该类型的值
(&Fence) readypub fn (fence &Fence) ready() bool在 &Fence 上执行 ready 操作。失败时抛出错误,调用方需处理或继续传播。
fence &FenceFence 实例;以只读借用传入,调用方仍持有实例。bool — 是否成立
(&Fence) waitpub fn (fence &Fence) wait() int&Fence 上的操作:等待。失败时抛出错误,调用方需处理或继续传播。
fence &FenceFence 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Readback) readypub fn (readback &Readback) ready() bool在 &Readback 上执行 ready 操作。失败时抛出错误,调用方需处理或继续传播。
readback &ReadbackReadback 实例;以只读借用传入,调用方仍持有实例。bool — 是否成立
(&Readback) waitpub fn (readback &Readback) wait() int&Readback 上的操作:等待。失败时抛出错误,调用方需处理或继续传播。
readback &ReadbackReadback 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Readback) size_bytespub fn (readback &Readback) size_bytes() int&Readback 上的操作:尺寸字节。
readback &ReadbackReadback 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Readback) readpub fn (readback &Readback) read(output $&[]u8) int&Readback 上的操作:读出最多 max 字节。失败时抛出错误,调用方需处理或继续传播。
readback &ReadbackReadback 实例;以只读借用传入,调用方仍持有实例。output $&[]u8int — 该类型的值
($&Device) closepub fn (device $&Device) close() int$&Device 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
device $&DeviceDevice 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&Buffer) closepub fn (buffer $&Buffer) close() int$&Buffer 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
buffer $&BufferBuffer 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&Fence) closepub fn (fence $&Fence) close() int$&Fence 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
fence $&FenceFence 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&Readback) closepub fn (readback $&Readback) close() int$&Readback 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
readback $&ReadbackReadback 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
const LOADpub const LOAD = 0常量 LOAD,定义了相关的协议或算法配置参数。
const CLEARpub const CLEAR = 1常量 CLEAR,定义了相关的协议或算法配置参数。
const DISCARDpub const DISCARD = 2常量 DISCARD,定义了相关的协议或算法配置参数。
const STOREpub const STORE = 0常量 STORE,定义了相关的协议或算法配置参数。
const DONT_STOREpub const DONT_STORE = 1常量 DONT_STORE,定义了相关的协议或算法配置参数。
const INDEX16pub const INDEX16 = 2常量 INDEX16,定义了相关的协议或算法配置参数。
const INDEX32pub const INDEX32 = 4常量 INDEX32,定义了相关的协议或算法配置参数。
struct Colorpub struct Color {
pub r f64
pub g f64
pub b f64
pub a f64
}承载 r、g、b、a 等属性的结构体。
r f64g f64b f64a f64struct ColorAttachmentpub struct ColorAttachment {
pub view TextureSlice
pub load int
pub store int
pub clear Color
}承载 view、load、store、clear 等属性的结构体。
view TextureSliceload intstore intclear Colorstruct DepthAttachmentpub struct DepthAttachment {
}DepthAttachment 上下文或状态结构体。
此类型没有公开字段。
no_depthpub fn no_depth() DepthAttachment执行 no depth 操作。
无需传入参数。
DepthAttachment — 该类型的值
depth_attachmentpub fn depth_attachment(texture &Texture, load int, store int, clear f64) DepthAttachment执行 depth attachment 操作。
texture &Textureload intstore intclear f64DepthAttachment — 该类型的值
struct CommandEncoderpub struct CommandEncoder {
}CommandEncoder 上下文或状态结构体。
此类型没有公开字段。
struct RenderPasspub struct RenderPass {
}RenderPass 上下文或状态结构体。
此类型没有公开字段。
(&Device) command_encoderpub fn (device &Device) command_encoder() CommandEncoder&Device 上的操作:执行 command encoder 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。CommandEncoder — 该类型的值
(&CommandEncoder) begin_renderpub fn (encoder &CommandEncoder) begin_render(color ColorAttachment, depth DepthAttachment) RenderPass&CommandEncoder 上的操作:执行 begin render 操作。失败时抛出错误,调用方需处理或继续传播。
encoder &CommandEncoderCommandEncoder 实例;以只读借用传入,调用方仍持有实例。color ColorAttachmentdepth DepthAttachmentRenderPass — 该类型的值
($&CommandEncoder) submitpub fn (encoder $&CommandEncoder) submit() Fence在 $&CommandEncoder 上执行 submit 操作。失败时抛出错误,调用方需处理或继续传播。
encoder $&CommandEncoderCommandEncoder 实例;以独占借用传入,方法可修改它,调用方仍持有实例。Fence — 该类型的值
(&RenderPass) pipelinepub fn (pass &RenderPass) pipeline(pipeline &GraphicsPipeline) int在 &RenderPass 上执行 pipeline 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。pipeline &GraphicsPipelineint — 该类型的值
(&RenderPass) vertex_bufferpub fn (pass &RenderPass) vertex_buffer(slot int, buffer &Buffer, offset int) int&RenderPass 上的操作:执行 vertex buffer 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。slot intbuffer &Bufferoffset intint — 该类型的值
(&RenderPass) index_bufferpub fn (pass &RenderPass) index_buffer(buffer &Buffer, offset int, element_size int) int&RenderPass 上的操作:下标缓冲。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。buffer &Bufferoffset intelement_size intint — 索引值;有效范围和特殊值见用途说明
(&RenderPass) samplerpub fn (pass &RenderPass) sampler(stage int, slot int, texture &Texture, sampler &Sampler) int在 &RenderPass 上执行 sampler 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。stage intslot inttexture &Texturesampler &Samplerint — 该类型的值
(&RenderPass) uniformpub fn (pass &RenderPass) uniform(stage int, slot int, bytes &[]u8) int在 &RenderPass 上执行 uniform 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。stage intslot intbytes &[]u8int — 该类型的值
(&RenderPass) viewportpub fn (pass &RenderPass) viewport(x int, y int, width int, height int) int在 &RenderPass 上执行 viewport 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。x inty intwidth intheight intint — 该类型的值
(&RenderPass) scissorpub fn (pass &RenderPass) scissor(x int, y int, width int, height int) int在 &RenderPass 上执行 scissor 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。x inty intwidth intheight intint — 该类型的值
(&RenderPass) drawpub fn (pass &RenderPass) draw(vertex_count int, first_vertex int, instance_count int, first_instance int) int在 &RenderPass 上执行 draw 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。vertex_count intfirst_vertex intinstance_count intfirst_instance intint — 该类型的值
(&RenderPass) draw_indexedpub fn (pass &RenderPass) draw_indexed(index_count int, first_index int, vertex_offset int, instance_count int, first_instance int) int&RenderPass 上的操作:执行 draw indexed 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。index_count intfirst_index intvertex_offset intinstance_count intfirst_instance intint — 索引值;有效范围和特殊值见用途说明
($&RenderPass) endpub fn (pass $&RenderPass) end() int在 $&RenderPass 上执行 end 操作。失败时抛出错误,调用方需处理或继续传播。
pass $&RenderPassRenderPass 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&CommandEncoder) closepub fn (encoder $&CommandEncoder) close() int$&CommandEncoder 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
encoder $&CommandEncoderCommandEncoder 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
const MAX_COMPUTE_STORAGE_BUFFERSpub const MAX_COMPUTE_STORAGE_BUFFERS = 8常量 MAX_COMPUTE_STORAGE_BUFFERS,定义了相关的协议或算法配置参数。
const MAX_COMPUTE_THREADSpub const MAX_COMPUTE_THREADS = 1024常量 MAX_COMPUTE_THREADS,定义了相关的协议或算法配置参数。
const MAX_COMPUTE_THREADS_Zpub const MAX_COMPUTE_THREADS_Z = 64常量 MAX_COMPUTE_THREADS_Z,定义了相关的协议或算法配置参数。
const MAX_COMPUTE_GROUPS_PER_DIMENSIONpub const MAX_COMPUTE_GROUPS_PER_DIMENSION = 65535常量 MAX_COMPUTE_GROUPS_PER_DIMENSION,定义了相关的协议或算法配置参数。
struct ComputePipelineDescpub struct ComputePipelineDesc {
pub format int
pub entrypoint string
pub read_buffers int
pub write_buffers int
pub uniform_sizes []int
pub threads_x int
pub threads_y int
pub threads_z int
}承载 format、entrypoint、read_buffers、write_buffers、uniform_sizes 等属性的结构体。
format intentrypoint stringread_buffers intwrite_buffers intuniform_sizes []intthreads_x intthreads_y intthreads_z intstruct ComputePipelinepub struct ComputePipeline {
}ComputePipeline 上下文或状态结构体。
此类型没有公开字段。
struct StorageBufferWritepub struct StorageBufferWrite {
}StorageBufferWrite 上下文或状态结构体。
此类型没有公开字段。
write_bufferpub fn write_buffer(buffer &Buffer, cycle bool) StorageBufferWrite写入缓冲。
buffer &Buffercycle boolStorageBufferWrite — 该类型的值
struct ComputePasspub struct ComputePass {
}ComputePass 上下文或状态结构体。
此类型没有公开字段。
(&Device) compute_pipelinepub fn (device &Device) compute_pipeline(desc &ComputePipelineDesc, code &[]u8) ComputePipeline&Device 上的操作:执行 compute pipeline 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。desc &ComputePipelineDesccode &[]u8ComputePipeline — 该类型的值
(&CommandEncoder) begin_computepub fn (encoder &CommandEncoder) begin_compute(writes &[]StorageBufferWrite) ComputePass&CommandEncoder 上的操作:执行 begin compute 操作。失败时抛出错误,调用方需处理或继续传播。
encoder &CommandEncoderCommandEncoder 实例;以只读借用传入,调用方仍持有实例。writes &[]StorageBufferWriteComputePass — 该类型的值
(&ComputePass) pipelinepub fn (pass &ComputePass) pipeline(pipeline &ComputePipeline) int在 &ComputePass 上执行 pipeline 操作。失败时抛出错误,调用方需处理或继续传播。
pass &ComputePassComputePass 实例;以只读借用传入,调用方仍持有实例。pipeline &ComputePipelineint — 该类型的值
(&ComputePass) read_bufferpub fn (pass &ComputePass) read_buffer(slot int, buffer &Buffer) int&ComputePass 上的操作:读取缓冲。失败时抛出错误,调用方需处理或继续传播。
pass &ComputePassComputePass 实例;以只读借用传入,调用方仍持有实例。slot intbuffer &Bufferint — 该类型的值
(&ComputePass) uniformpub fn (pass &ComputePass) uniform(slot int, bytes &[]u8) int在 &ComputePass 上执行 uniform 操作。失败时抛出错误,调用方需处理或继续传播。
pass &ComputePassComputePass 实例;以只读借用传入,调用方仍持有实例。slot intbytes &[]u8int — 该类型的值
(&ComputePass) dispatchpub fn (pass &ComputePass) dispatch(groups_x int, groups_y int, groups_z int) int在 &ComputePass 上执行 dispatch 操作。失败时抛出错误,调用方需处理或继续传播。
pass &ComputePassComputePass 实例;以只读借用传入,调用方仍持有实例。groups_x intgroups_y intgroups_z intint — 该类型的值
($&ComputePass) endpub fn (pass $&ComputePass) end() int在 $&ComputePass 上执行 end 操作。失败时抛出错误,调用方需处理或继续传播。
pass $&ComputePassComputePass 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&ComputePipeline) closepub fn (pipeline $&ComputePipeline) close() int$&ComputePipeline 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
pipeline $&ComputePipelineComputePipeline 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
const VERTEXpub const VERTEX = 0常量 VERTEX,定义了相关的协议或算法配置参数。
const FRAGMENTpub const FRAGMENT = 1常量 FRAGMENT,定义了相关的协议或算法配置参数。
const NEARESTpub const NEAREST = 0常量 NEAREST,定义了相关的协议或算法配置参数。
const LINEARpub const LINEAR = 1常量 LINEAR,定义了相关的协议或算法配置参数。
const REPEATpub const REPEAT = 0常量 REPEAT,定义了相关的协议或算法配置参数。
const MIRRORED_REPEATpub const MIRRORED_REPEAT = 1常量 MIRRORED_REPEAT,定义了相关的协议或算法配置参数。
const CLAMP_TO_EDGEpub const CLAMP_TO_EDGE = 2常量 CLAMP_TO_EDGE,定义了相关的协议或算法配置参数。
const TRIANGLESpub const TRIANGLES = 0常量 TRIANGLES,定义了相关的协议或算法配置参数。
const TRIANGLE_STRIPpub const TRIANGLE_STRIP = 1常量 TRIANGLE_STRIP,定义了相关的协议或算法配置参数。
const LINESpub const LINES = 2常量 LINES,定义了相关的协议或算法配置参数。
const LINE_STRIPpub const LINE_STRIP = 3常量 LINE_STRIP,定义了相关的协议或算法配置参数。
const POINTSpub const POINTS = 4常量 POINTS,定义了相关的协议或算法配置参数。
const CULL_NONEpub const CULL_NONE = 0常量 CULL_NONE,定义了相关的协议或算法配置参数。
const CULL_FRONTpub const CULL_FRONT = 1常量 CULL_FRONT,定义了相关的协议或算法配置参数。
const CULL_BACKpub const CULL_BACK = 2常量 CULL_BACK,定义了相关的协议或算法配置参数。
const COUNTER_CLOCKWISEpub const COUNTER_CLOCKWISE = 0常量 COUNTER_CLOCKWISE,定义了相关的协议或算法配置参数。
const CLOCKWISEpub const CLOCKWISE = 1常量 CLOCKWISE,定义了相关的协议或算法配置参数。
const DEPTH_DISABLEDpub const DEPTH_DISABLED = 0常量 DEPTH_DISABLED,定义了相关的协议或算法配置参数。
const NEVERpub const NEVER = 1常量 NEVER,定义了相关的协议或算法配置参数。
const LESSpub const LESS = 2常量 LESS,定义了相关的协议或算法配置参数。
const EQUALpub const EQUAL = 3常量 EQUAL,定义了相关的协议或算法配置参数。
const LESS_EQUALpub const LESS_EQUAL = 4常量 LESS_EQUAL,定义了相关的协议或算法配置参数。
const GREATERpub const GREATER = 5常量 GREATER,定义了相关的协议或算法配置参数。
const NOT_EQUALpub const NOT_EQUAL = 6常量 NOT_EQUAL,定义了相关的协议或算法配置参数。
const GREATER_EQUALpub const GREATER_EQUAL = 7常量 GREATER_EQUAL,定义了相关的协议或算法配置参数。
const ALWAYSpub const ALWAYS = 8常量 ALWAYS,定义了相关的协议或算法配置参数。
const BLEND_DISABLEDpub const BLEND_DISABLED = 0常量 BLEND_DISABLED,定义了相关的协议或算法配置参数。
const BLEND_ALPHApub const BLEND_ALPHA = 1常量 BLEND_ALPHA,定义了相关的协议或算法配置参数。
const BLEND_PREMULTIPLIEDpub const BLEND_PREMULTIPLIED = 2常量 BLEND_PREMULTIPLIED,定义了相关的协议或算法配置参数。
const PER_VERTEXpub const PER_VERTEX = 0常量 PER_VERTEX,定义了相关的协议或算法配置参数。
const PER_INSTANCEpub const PER_INSTANCE = 1常量 PER_INSTANCE,定义了相关的协议或算法配置参数。
const FLOATpub const FLOAT = 1常量 FLOAT,定义了相关的协议或算法配置参数。
const FLOAT2pub const FLOAT2 = 2常量 FLOAT2,定义了相关的协议或算法配置参数。
const FLOAT3pub const FLOAT3 = 3常量 FLOAT3,定义了相关的协议或算法配置参数。
const FLOAT4pub const FLOAT4 = 4常量 FLOAT4,定义了相关的协议或算法配置参数。
const UNORM8X4pub const UNORM8X4 = 5常量 UNORM8X4,定义了相关的协议或算法配置参数。
const UINTpub const UINT = 6常量 UINT,定义了相关的协议或算法配置参数。
const UINT2pub const UINT2 = 7常量 UINT2,定义了相关的协议或算法配置参数。
const UINT3pub const UINT3 = 8常量 UINT3,定义了相关的协议或算法配置参数。
const UINT4pub const UINT4 = 9常量 UINT4,定义了相关的协议或算法配置参数。
struct SamplerDescpub struct SamplerDesc {
pub min_filter int
pub mag_filter int
pub mip_filter int
pub address_u int
pub address_v int
pub address_w int
pub min_lod f64
pub max_lod f64
}承载 min_filter、mag_filter、mip_filter、address_u、address_v 等属性的结构体。
min_filter intmag_filter intmip_filter intaddress_u intaddress_v intaddress_w intmin_lod f64max_lod f64sampler_defaultspub fn sampler_defaults() SamplerDesc执行 sampler defaults 操作。
无需传入参数。
SamplerDesc — 该类型的值
struct ShaderDescpub struct ShaderDesc {
pub stage int
pub format int
pub entrypoint string
pub samplers int
pub uniform_sizes []int
}承载 stage、format、entrypoint、samplers、uniform_sizes 等属性的结构体。
stage intformat intentrypoint stringsamplers intuniform_sizes []intstruct VertexBufferLayoutpub struct VertexBufferLayout {
pub slot int
pub stride int
pub rate int
}承载 slot、stride、rate 等属性的结构体。
slot intstride intrate intstruct VertexAttributepub struct VertexAttribute {
pub location int
pub slot int
pub format int
pub offset int
}承载 location、slot、format、offset 等属性的结构体。
location intslot intformat intoffset intstruct PipelineDescpub struct PipelineDesc {
pub color_format int
pub depth_format int
pub primitive int
pub cull int
pub front_face int
pub depth_compare int
pub depth_write bool
pub blend int
pub vertex_buffers []VertexBufferLayout
pub attributes []VertexAttribute
}承载 color_format、depth_format、primitive、cull、front_face 等属性的结构体。
color_format intdepth_format intprimitive intcull intfront_face intdepth_compare intdepth_write boolblend intvertex_buffers []VertexBufferLayoutattributes []VertexAttributepipeline_defaultspub fn pipeline_defaults(color_format int) PipelineDesc执行 pipeline defaults 操作。
color_format intPipelineDesc — 该类型的值
struct Samplerpub struct Sampler {
}Sampler 上下文或状态结构体。
此类型没有公开字段。
struct Shaderpub struct Shader {
}Shader 上下文或状态结构体。
此类型没有公开字段。
struct GraphicsPipelinepub struct GraphicsPipeline {
}GraphicsPipeline 上下文或状态结构体。
此类型没有公开字段。
(&Device) samplerpub fn (device &Device) sampler(desc SamplerDesc) Sampler在 &Device 上执行 sampler 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。desc SamplerDescSampler — 该类型的值
(&Device) shaderpub fn (device &Device) shader(desc &ShaderDesc, code &[]u8) Shader在 &Device 上执行 shader 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。desc &ShaderDesccode &[]u8Shader — 该类型的值
(&Device) graphics_pipelinepub fn (device &Device) graphics_pipeline(vertex &Shader, fragment &Shader, desc &PipelineDesc) GraphicsPipeline&Device 上的操作:执行 graphics pipeline 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。vertex &Shaderfragment &Shaderdesc &PipelineDescGraphicsPipeline — 该类型的值
($&Sampler) closepub fn (sampler $&Sampler) close() int$&Sampler 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
sampler $&SamplerSampler 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&Shader) closepub fn (shader $&Shader) close() int$&Shader 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
shader $&ShaderShader 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&GraphicsPipeline) closepub fn (pipeline $&GraphicsPipeline) close() int$&GraphicsPipeline 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
pipeline $&GraphicsPipelineGraphicsPipeline 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
struct DeviceRefpub struct DeviceRef {
}DeviceRef 上下文或状态结构体。
此类型没有公开字段。
struct BufferRefpub struct BufferRef {
}BufferRef 上下文或状态结构体。
此类型没有公开字段。
struct TextureRefpub struct TextureRef {
}TextureRef 上下文或状态结构体。
此类型没有公开字段。
struct SamplerRefpub struct SamplerRef {
}SamplerRef 上下文或状态结构体。
此类型没有公开字段。
(&Device) referencepub fn (device &Device) reference() DeviceRef在 &Device 上执行 reference 操作。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。DeviceRef — 该类型的值
(&Buffer) referencepub fn (buffer &Buffer) reference() BufferRef在 &Buffer 上执行 reference 操作。
buffer &BufferBuffer 实例;以只读借用传入,调用方仍持有实例。BufferRef — 该类型的值
(&Texture) referencepub fn (texture &Texture) reference() TextureRef在 &Texture 上执行 reference 操作。
texture &TextureTexture 实例;以只读借用传入,调用方仍持有实例。TextureRef — 该类型的值
(&Sampler) referencepub fn (sampler &Sampler) reference() SamplerRef在 &Sampler 上执行 reference 操作。
sampler &SamplerSampler 实例;以只读借用传入,调用方仍持有实例。SamplerRef — 该类型的值
(DeviceRef) samepub fn (reference DeviceRef) same(other DeviceRef) bool在 DeviceRef 上执行 same 操作。
reference DeviceRefDeviceRef 实例;按值接收。other DeviceRefbool — 是否成立
(DeviceRef) validatepub fn (reference DeviceRef) validate() int在 DeviceRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。
reference DeviceRefDeviceRef 实例;按值接收。int — 该类型的值
(BufferRef) validatepub fn (reference BufferRef) validate() int在 BufferRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。
reference BufferRefBufferRef 实例;按值接收。int — 该类型的值
(TextureRef) validatepub fn (reference TextureRef) validate() int在 TextureRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。
reference TextureRefTextureRef 实例;按值接收。int — 该类型的值
(SamplerRef) validatepub fn (reference SamplerRef) validate() int在 SamplerRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。
reference SamplerRefSamplerRef 实例;按值接收。int — 该类型的值
(BufferRef) size_bytespub fn (reference BufferRef) size_bytes() intBufferRef 上的操作:尺寸字节。
reference BufferRefBufferRef 实例;按值接收。int — 该类型的值
(DeviceRef) validate_bufferpub fn (reference DeviceRef) validate_buffer(buffer BufferRef) intDeviceRef 上的操作:执行 validate buffer 操作。失败时抛出错误,调用方需处理或继续传播。
reference DeviceRefDeviceRef 实例;按值接收。buffer BufferRefint — 该类型的值
(DeviceRef) validate_texturepub fn (reference DeviceRef) validate_texture(texture TextureRef) intDeviceRef 上的操作:执行 validate texture 操作。失败时抛出错误,调用方需处理或继续传播。
reference DeviceRefDeviceRef 实例;按值接收。texture TextureRefint — 该类型的值
(DeviceRef) validate_samplerpub fn (reference DeviceRef) validate_sampler(sampler SamplerRef) intDeviceRef 上的操作:执行 validate sampler 操作。失败时抛出错误,调用方需处理或继续传播。
reference DeviceRefDeviceRef 实例;按值接收。sampler SamplerRefint — 该类型的值
(&RenderPass) vertex_buffer_refpub fn (pass &RenderPass) vertex_buffer_ref(slot int, buffer BufferRef, offset int) int&RenderPass 上的操作:执行 vertex buffer ref 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。slot intbuffer BufferRefoffset intint — 该类型的值
(&RenderPass) index_buffer_refpub fn (pass &RenderPass) index_buffer_ref(buffer BufferRef, offset int, element_size int) int&RenderPass 上的操作:执行 index buffer ref 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。buffer BufferRefoffset intelement_size intint — 索引值;有效范围和特殊值见用途说明
(&RenderPass) sampler_refpub fn (pass &RenderPass) sampler_ref(stage int, slot int, texture TextureRef, sampler SamplerRef) int&RenderPass 上的操作:执行 sampler ref 操作。失败时抛出错误,调用方需处理或继续传播。
pass &RenderPassRenderPass 实例;以只读借用传入,调用方仍持有实例。stage intslot inttexture TextureRefsampler SamplerRefint — 该类型的值
struct SoftBlobpub struct SoftBlob {
}SoftBlob 上下文或状态结构体。
此类型没有公开字段。
struct SoftBlobRefpub struct SoftBlobRef {
}SoftBlobRef 上下文或状态结构体。
此类型没有公开字段。
soft_owner_newpub fn soft_owner_new() int执行 soft owner new 操作。失败时抛出错误,调用方需处理或继续传播。
无需传入参数。
int — 该类型的值
soft_owner_closepub fn soft_owner_close(owner int) int关闭softowner。失败时抛出错误,调用方需处理或继续传播。
owner intint — 该类型的值
soft_blob_createpub fn soft_blob_create(owner int, bytes &[]u8) SoftBlob创建softblob。失败时抛出错误,调用方需处理或继续传播。
owner intbytes &[]u8SoftBlob — 该类型的值
empty_soft_blob_refpub fn empty_soft_blob_ref() SoftBlobRef执行 empty soft blob ref 操作。
无需传入参数。
SoftBlobRef — 该类型的值
(&SoftBlob) referencepub fn (blob &SoftBlob) reference() SoftBlobRef在 &SoftBlob 上执行 reference 操作。
blob &SoftBlobSoftBlob 实例;以只读借用传入,调用方仍持有实例。SoftBlobRef — 该类型的值
($&SoftBlob) closepub fn (blob $&SoftBlob) close() int$&SoftBlob 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
blob $&SoftBlobSoftBlob 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
(SoftBlobRef) validatepub fn (reference SoftBlobRef) validate(owner int) int在 SoftBlobRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。
reference SoftBlobRefSoftBlobRef 实例;按值接收。owner intint — 该类型的值
(SoftBlobRef) read_u32pub fn (reference SoftBlobRef) read_u32(offset int) intSoftBlobRef 上的操作:读取u32。失败时抛出错误,调用方需处理或继续传播。
reference SoftBlobRefSoftBlobRef 实例;按值接收。offset intint — 该类型的值
(SoftBlobRef) read_f32pub fn (reference SoftBlobRef) read_f32(offset int) f64SoftBlobRef 上的操作:读取f32。失败时抛出错误,调用方需处理或继续传播。
reference SoftBlobRefSoftBlobRef 实例;按值接收。offset intf64 — 该类型的值
(SoftBlobRef) read_rgba8pub fn (reference SoftBlobRef) read_rgba8(index int) intSoftBlobRef 上的操作:读取rgba8。失败时抛出错误,调用方需处理或继续传播。
reference SoftBlobRefSoftBlobRef 实例;按值接收。index intint — 该类型的值
const PRESENT_VSYNCpub const PRESENT_VSYNC = 0常量 PRESENT_VSYNC,定义了相关的协议或算法配置参数。
const PRESENT_IMMEDIATEpub const PRESENT_IMMEDIATE = 1常量 PRESENT_IMMEDIATE,定义了相关的协议或算法配置参数。
const PRESENT_MAILBOXpub const PRESENT_MAILBOX = 2常量 PRESENT_MAILBOX,定义了相关的协议或算法配置参数。
struct SurfaceOptionspub struct SurfaceOptions {
pub present_mode int
}Gpu 配置参数与选项集合。
present_mode intstruct Surfacepub struct Surface {
}Surface 上下文或状态结构体。
此类型没有公开字段。
struct Framepub struct Frame {
}Gpu 协议数据帧结构封装。
此类型没有公开字段。
(&Device) surfacepub fn (device &Device) surface(target &window.Window, options SurfaceOptions) Surface在 &Device 上执行 surface 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。target &window.Windowoptions SurfaceOptionsSurface — 该类型的值
(&Surface) formatpub fn (surface &Surface) format() int&Surface 上的操作:格式化为字符串。失败时抛出错误,调用方需处理或继续传播。
surface &SurfaceSurface 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Surface) supports_present_modepub fn (surface &Surface) supports_present_mode(mode int) bool&Surface 上的操作:执行 supports present mode 操作。失败时抛出错误,调用方需处理或继续传播。
surface &SurfaceSurface 实例;以只读借用传入,调用方仍持有实例。mode intbool — 是否成立
(&Surface) set_present_modepub fn (surface &Surface) set_present_mode(mode int) int&Surface 上的操作:设置 present mode。失败时抛出错误,调用方需处理或继续传播。
surface &SurfaceSurface 实例;以只读借用传入,调用方仍持有实例。mode intint — 该类型的值
(&Surface) acquirepub fn (surface &Surface) acquire() Frame在 &Surface 上执行 acquire 操作。失败时抛出错误,调用方需处理或继续传播。
surface &SurfaceSurface 实例;以只读借用传入,调用方仍持有实例。Frame — 该类型的值
(&Frame) has_imagepub fn (frame &Frame) has_image() bool&Frame 上的操作:判断是否具有 image。
frame &FrameFrame 实例;以只读借用传入,调用方仍持有实例。bool — 是否成立
(&Frame) widthpub fn (frame &Frame) width() int在 &Frame 上执行 width 操作。
frame &FrameFrame 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Frame) heightpub fn (frame &Frame) height() int在 &Frame 上执行 height 操作。
frame &FrameFrame 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Frame) formatpub fn (frame &Frame) format() int&Frame 上的操作:格式化为字符串。
frame &FrameFrame 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Frame) begin_renderpub fn (frame &Frame) begin_render(load int, clear Color, depth DepthAttachment) RenderPass&Frame 上的操作:执行 begin render 操作。失败时抛出错误,调用方需处理或继续传播。
frame &FrameFrame 实例;以只读借用传入,调用方仍持有实例。load intclear Colordepth DepthAttachmentRenderPass — 该类型的值
(&Frame) begin_computepub fn (frame &Frame) begin_compute(writes &[]StorageBufferWrite) ComputePass&Frame 上的操作:执行 begin compute 操作。失败时抛出错误,调用方需处理或继续传播。
frame &FrameFrame 实例;以只读借用传入,调用方仍持有实例。writes &[]StorageBufferWriteComputePass — 该类型的值
($&Frame) presentpub fn (frame $&Frame) present() Fence在 $&Frame 上执行 present 操作。失败时抛出错误,调用方需处理或继续传播。
frame $&FrameFrame 实例;以独占借用传入,方法可修改它,调用方仍持有实例。Fence — 该类型的值
($&Frame) closepub fn (frame $&Frame) close() int$&Frame 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
frame $&FrameFrame 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
($&Surface) closepub fn (surface $&Surface) close() int$&Surface 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
surface $&SurfaceSurface 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值
const TEXTURE_SAMPLEDpub const TEXTURE_SAMPLED = 1常量 TEXTURE_SAMPLED,定义了相关的协议或算法配置参数。
const TEXTURE_COLOR_TARGETpub const TEXTURE_COLOR_TARGET = 2常量 TEXTURE_COLOR_TARGET,定义了相关的协议或算法配置参数。
const TEXTURE_DEPTH_TARGETpub const TEXTURE_DEPTH_TARGET = 4常量 TEXTURE_DEPTH_TARGET,定义了相关的协议或算法配置参数。
const MAX_TEXTURE_SIZE_2Dpub const MAX_TEXTURE_SIZE_2D = 16384常量 MAX_TEXTURE_SIZE_2D,定义了相关的协议或算法配置参数。
struct Texture2DDescpub struct Texture2DDesc {
pub format int
pub width int
pub height int
pub levels int
pub usage int
}承载 format、width、height、levels、usage 等属性的结构体。
format intwidth intheight intlevels intusage intstruct Texturepub struct Texture {
}Texture 上下文或状态结构体。
此类型没有公开字段。
struct TextureSlicepub struct TextureSlice {
}TextureSlice 上下文或状态结构体。
此类型没有公开字段。
(&Device) supports_texture_2dpub fn (device &Device) supports_texture_2d(format int, usage int) bool&Device 上的操作:执行 supports texture 2d 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。format intusage intbool — 是否成立
(&Device) texture_2dpub fn (device &Device) texture_2d(desc Texture2DDesc) Texture&Device 上的操作:执行 texture 2d 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。desc Texture2DDescTexture — 该类型的值
(&Texture) level_countpub fn (texture &Texture) level_count() int&Texture 上的操作:执行 level count 操作。
texture &TextureTexture 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Texture) size_bytespub fn (texture &Texture) size_bytes() int&Texture 上的操作:尺寸字节。
texture &TextureTexture 实例;以只读借用传入,调用方仍持有实例。int — 该类型的值
(&Texture) level_layoutpub fn (texture &Texture) level_layout(mip int) layout.Level2D&Texture 上的操作:执行 level layout 操作。失败时抛出错误,调用方需处理或继续传播。
texture &TextureTexture 实例;以只读借用传入,调用方仍持有实例。mip intlayout.Level2D — 该类型的值
(&Texture) viewpub fn (texture &Texture) view(mip int) TextureSlice&Texture 上的操作:视图。失败时抛出错误,调用方需处理或继续传播。
texture &TextureTexture 实例;以只读借用传入,调用方仍持有实例。mip intTextureSlice — 该类型的值
(&Device) upload_texturepub fn (device &Device) upload_texture(texture &Texture, mip int, bytes &[]u8) Fence&Device 上的操作:执行 upload texture 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。texture &Texturemip intbytes &[]u8Fence — 该类型的值
(&Device) download_texturepub fn (device &Device) download_texture(texture &Texture, mip int) Readback&Device 上的操作:执行 download texture 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。texture &Texturemip intReadback — 该类型的值
(&Device) generate_mipspub fn (device &Device) generate_mips(texture &Texture) Fence&Device 上的操作:执行 generate mips 操作。失败时抛出错误,调用方需处理或继续传播。
device &DeviceDevice 实例;以只读借用传入,调用方仍持有实例。texture &TextureFence — 该类型的值
($&Texture) closepub fn (texture $&Texture) close() int$&Texture 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。
texture $&TextureTexture 实例;以独占借用传入,方法可修改它,调用方仍持有实例。int — 该类型的值