XU XUv0.13.1
EN

#gpu

导入方式: #gpu

公开 API: 11 函数, 92 方法, 35 类型, 74 常量, 0 方法集

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 AUTO

XuAPI
pub const AUTO = 0

用途

常量 AUTO,定义了相关的协议或算法配置参数。

const METAL

XuAPI
pub const METAL = 1

用途

常量 METAL,定义了相关的协议或算法配置参数。

const VULKAN

XuAPI
pub const VULKAN = 2

用途

常量 VULKAN,定义了相关的协议或算法配置参数。

const D3D12

XuAPI
pub const D3D12 = 3

用途

常量 D3D12,定义了相关的协议或算法配置参数。

const SHADER_SPIRV

XuAPI
pub const SHADER_SPIRV = 1

用途

常量 SHADER_SPIRV,定义了相关的协议或算法配置参数。

const SHADER_DXBC

XuAPI
pub const SHADER_DXBC = 2

用途

常量 SHADER_DXBC,定义了相关的协议或算法配置参数。

const SHADER_DXIL

XuAPI
pub const SHADER_DXIL = 4

用途

常量 SHADER_DXIL,定义了相关的协议或算法配置参数。

const SHADER_MSL

XuAPI
pub const SHADER_MSL = 8

用途

常量 SHADER_MSL,定义了相关的协议或算法配置参数。

const SHADER_METALLIB

XuAPI
pub const SHADER_METALLIB = 16

用途

常量 SHADER_METALLIB,定义了相关的协议或算法配置参数。

const BUFFER_VERTEX

XuAPI
pub const BUFFER_VERTEX = 1

用途

常量 BUFFER_VERTEX,定义了相关的协议或算法配置参数。

const BUFFER_INDEX

XuAPI
pub const BUFFER_INDEX = 2

用途

常量 BUFFER_INDEX,定义了相关的协议或算法配置参数。

const BUFFER_INDIRECT

XuAPI
pub const BUFFER_INDIRECT = 4

用途

常量 BUFFER_INDIRECT,定义了相关的协议或算法配置参数。

const BUFFER_GRAPHICS_STORAGE_READ

XuAPI
pub const BUFFER_GRAPHICS_STORAGE_READ = 8

用途

常量 BUFFER_GRAPHICS_STORAGE_READ,定义了相关的协议或算法配置参数。

const BUFFER_COMPUTE_STORAGE_READ

XuAPI
pub const BUFFER_COMPUTE_STORAGE_READ = 16

用途

常量 BUFFER_COMPUTE_STORAGE_READ,定义了相关的协议或算法配置参数。

const BUFFER_COMPUTE_STORAGE_WRITE

XuAPI
pub const BUFFER_COMPUTE_STORAGE_WRITE = 32

用途

常量 BUFFER_COMPUTE_STORAGE_WRITE,定义了相关的协议或算法配置参数。

const TRANSFER_ALIGNMENT

XuAPI
pub const TRANSFER_ALIGNMENT = 4

用途

常量 TRANSFER_ALIGNMENT,定义了相关的协议或算法配置参数。

struct DeviceOptions

XuAPI
pub struct DeviceOptions {
    pub backend int
    pub debug bool
    pub shader_formats int
}

用途

Gpu 配置参数与选项集合。

公开字段

backend int
字段(int)
debug bool
字段(bool)
shader_formats int
字段(int)

struct Device

XuAPI
pub struct Device {

}

用途

Device 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct Buffer

XuAPI
pub struct Buffer {

}

用途

Buffer 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct Fence

XuAPI
pub struct Fence {

}

用途

Fence 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct Readback

XuAPI
pub struct Readback {

}

用途

Readback 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct Stats

XuAPI
pub 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 int
字段(int)
buffer_bytes int
字段(int)
submission_count int
字段(int)
staging_bytes int
字段(int)
texture_count int
字段(int)
texture_bytes int
字段(int)
sampler_count int
字段(int)
shader_count int
字段(int)
pipeline_count int
字段(int)
encoder_count int
字段(int)
render_pass_count int
字段(int)
compute_pipeline_count int
字段(int)
compute_pass_count int
字段(int)
surface_count int
字段(int)
frame_count int
字段(int)

is_available

XuAPI
pub fn is_available(options DeviceOptions) bool

用途

判断是否 available。

参数

options DeviceOptions
options(DeviceOptions)

返回值

bool — 是否成立

open

XuAPI
pub fn open(options DeviceOptions) Device

用途

打开资源或建立网络连接。失败时抛出错误,调用方需处理或继续传播。

参数

options DeviceOptions
options(DeviceOptions)

返回值

Device — 该类型的值

(&Device) backend

XuAPI
pub fn (device &Device) backend() int

用途

在 &Device 上执行 backend 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Device) shader_formats

XuAPI
pub fn (device &Device) shader_formats() int

用途

&Device 上的操作:执行 shader formats 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Device) stats

XuAPI
pub fn (device &Device) stats() Stats

用途

在 &Device 上执行 stats 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。

返回值

Stats — 该类型的值

(&Device) buffer

XuAPI
pub fn (device &Device) buffer(size_bytes int, usage int) Buffer

用途

&Device 上的操作:缓冲。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
size_bytes int
size_bytes(int)
usage int
用法说明(int)

返回值

Buffer — 该类型的值

(&Buffer) size_bytes

XuAPI
pub fn (buffer &Buffer) size_bytes() int

用途

&Buffer 上的操作:尺寸字节。

参数

buffer &Buffer
本次调用使用的 Buffer 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Device) upload

XuAPI
pub fn (device &Device) upload(buffer &Buffer, offset int, bytes &[]u8) Fence

用途

在 &Device 上执行 upload 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
buffer &Buffer
buffer(只读借用,调用方仍持有原值;类型 &Buffer)
offset int
偏移(int)
bytes &[]u8
bytes(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

Fence — 该类型的值

(&Device) copy

XuAPI
pub fn (device &Device) copy(source &Buffer, source_offset int, destination &Buffer, destination_offset int, size_bytes int) Fence

用途

&Device 上的操作:拷贝。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
source &Buffer
source(只读借用,调用方仍持有原值;类型 &Buffer)
source_offset int
source_offset(int)
destination &Buffer
destination(只读借用,调用方仍持有原值;类型 &Buffer)
destination_offset int
destination_offset(int)
size_bytes int
size_bytes(int)

返回值

Fence — 该类型的值

(&Device) download

XuAPI
pub fn (device &Device) download(buffer &Buffer, offset int, size_bytes int) Readback

用途

在 &Device 上执行 download 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
buffer &Buffer
buffer(只读借用,调用方仍持有原值;类型 &Buffer)
offset int
偏移(int)
size_bytes int
size_bytes(int)

返回值

Readback — 该类型的值

(&Fence) ready

XuAPI
pub fn (fence &Fence) ready() bool

用途

在 &Fence 上执行 ready 操作。失败时抛出错误,调用方需处理或继续传播。

参数

fence &Fence
本次调用使用的 Fence 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Fence) wait

XuAPI
pub fn (fence &Fence) wait() int

用途

&Fence 上的操作:等待。失败时抛出错误,调用方需处理或继续传播。

参数

fence &Fence
本次调用使用的 Fence 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Readback) ready

XuAPI
pub fn (readback &Readback) ready() bool

用途

在 &Readback 上执行 ready 操作。失败时抛出错误,调用方需处理或继续传播。

参数

readback &Readback
本次调用使用的 Readback 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Readback) wait

XuAPI
pub fn (readback &Readback) wait() int

用途

&Readback 上的操作:等待。失败时抛出错误,调用方需处理或继续传播。

参数

readback &Readback
本次调用使用的 Readback 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Readback) size_bytes

XuAPI
pub fn (readback &Readback) size_bytes() int

用途

&Readback 上的操作:尺寸字节。

参数

readback &Readback
本次调用使用的 Readback 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Readback) read

XuAPI
pub fn (readback &Readback) read(output $&[]u8) int

用途

&Readback 上的操作:读出最多 max 字节。失败时抛出错误,调用方需处理或继续传播。

参数

readback &Readback
本次调用使用的 Readback 实例;以只读借用传入,调用方仍持有实例。
output $&[]u8
output(独占借用,可修改原值;类型 $&[]u8)

返回值

int — 该类型的值

($&Device) close

XuAPI
pub fn (device $&Device) close() int

用途

$&Device 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

device $&Device
本次调用使用的 Device 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Buffer) close

XuAPI
pub fn (buffer $&Buffer) close() int

用途

$&Buffer 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

buffer $&Buffer
本次调用使用的 Buffer 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Fence) close

XuAPI
pub fn (fence $&Fence) close() int

用途

$&Fence 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

fence $&Fence
本次调用使用的 Fence 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Readback) close

XuAPI
pub fn (readback $&Readback) close() int

用途

$&Readback 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

readback $&Readback
本次调用使用的 Readback 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

const LOAD

XuAPI
pub const LOAD = 0

用途

常量 LOAD,定义了相关的协议或算法配置参数。

const CLEAR

XuAPI
pub const CLEAR = 1

用途

常量 CLEAR,定义了相关的协议或算法配置参数。

const DISCARD

XuAPI
pub const DISCARD = 2

用途

常量 DISCARD,定义了相关的协议或算法配置参数。

const STORE

XuAPI
pub const STORE = 0

用途

常量 STORE,定义了相关的协议或算法配置参数。

const DONT_STORE

XuAPI
pub const DONT_STORE = 1

用途

常量 DONT_STORE,定义了相关的协议或算法配置参数。

const INDEX16

XuAPI
pub const INDEX16 = 2

用途

常量 INDEX16,定义了相关的协议或算法配置参数。

const INDEX32

XuAPI
pub const INDEX32 = 4

用途

常量 INDEX32,定义了相关的协议或算法配置参数。

struct Color

XuAPI
pub struct Color {
    pub r f64
    pub g f64
    pub b f64
    pub a f64
}

用途

承载 r、g、b、a 等属性的结构体。

公开字段

r f64
rune(Unicode 码点)
g f64
字段(f64)
b f64
字段(f64)
a f64
字段(f64)

struct ColorAttachment

XuAPI
pub struct ColorAttachment {
    pub view TextureSlice
    pub load int
    pub store int
    pub clear Color
}

用途

承载 view、load、store、clear 等属性的结构体。

公开字段

view TextureSlice
字段(TextureSlice)
load int
字段(int)
store int
字段(int)
clear Color
字段(Color)

struct DepthAttachment

XuAPI
pub struct DepthAttachment {

}

用途

DepthAttachment 上下文或状态结构体。

公开字段

此类型没有公开字段。

no_depth

XuAPI
pub fn no_depth() DepthAttachment

用途

执行 no depth 操作。

参数

无需传入参数。

返回值

DepthAttachment — 该类型的值

depth_attachment

XuAPI
pub fn depth_attachment(texture &Texture, load int, store int, clear f64) DepthAttachment

用途

执行 depth attachment 操作。

参数

texture &Texture
texture(只读借用,调用方仍持有原值;类型 &Texture)
load int
load(int)
store int
store(int)
clear f64
clear(f64)

返回值

DepthAttachment — 该类型的值

struct CommandEncoder

XuAPI
pub struct CommandEncoder {

}

用途

CommandEncoder 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct RenderPass

XuAPI
pub struct RenderPass {

}

用途

RenderPass 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Device) command_encoder

XuAPI
pub fn (device &Device) command_encoder() CommandEncoder

用途

&Device 上的操作:执行 command encoder 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。

返回值

CommandEncoder — 该类型的值

(&CommandEncoder) begin_render

XuAPI
pub fn (encoder &CommandEncoder) begin_render(color ColorAttachment, depth DepthAttachment) RenderPass

用途

&CommandEncoder 上的操作:执行 begin render 操作。失败时抛出错误,调用方需处理或继续传播。

参数

encoder &CommandEncoder
本次调用使用的 CommandEncoder 实例;以只读借用传入,调用方仍持有实例。
color ColorAttachment
color(ColorAttachment)
depth DepthAttachment
depth(DepthAttachment)

返回值

RenderPass — 该类型的值

($&CommandEncoder) submit

XuAPI
pub fn (encoder $&CommandEncoder) submit() Fence

用途

在 $&CommandEncoder 上执行 submit 操作。失败时抛出错误,调用方需处理或继续传播。

参数

encoder $&CommandEncoder
本次调用使用的 CommandEncoder 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

Fence — 该类型的值

(&RenderPass) pipeline

XuAPI
pub fn (pass &RenderPass) pipeline(pipeline &GraphicsPipeline) int

用途

在 &RenderPass 上执行 pipeline 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
pipeline &GraphicsPipeline
pipeline(只读借用,调用方仍持有原值;类型 &GraphicsPipeline)

返回值

int — 该类型的值

(&RenderPass) vertex_buffer

XuAPI
pub fn (pass &RenderPass) vertex_buffer(slot int, buffer &Buffer, offset int) int

用途

&RenderPass 上的操作:执行 vertex buffer 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
slot int
slot(int)
buffer &Buffer
buffer(只读借用,调用方仍持有原值;类型 &Buffer)
offset int
偏移(int)

返回值

int — 该类型的值

(&RenderPass) index_buffer

XuAPI
pub fn (pass &RenderPass) index_buffer(buffer &Buffer, offset int, element_size int) int

用途

&RenderPass 上的操作:下标缓冲。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
buffer &Buffer
buffer(只读借用,调用方仍持有原值;类型 &Buffer)
offset int
偏移(int)
element_size int
element_size(int)

返回值

int — 索引值;有效范围和特殊值见用途说明

(&RenderPass) sampler

XuAPI
pub fn (pass &RenderPass) sampler(stage int, slot int, texture &Texture, sampler &Sampler) int

用途

在 &RenderPass 上执行 sampler 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
stage int
stage(int)
slot int
slot(int)
texture &Texture
texture(只读借用,调用方仍持有原值;类型 &Texture)
sampler &Sampler
sampler(只读借用,调用方仍持有原值;类型 &Sampler)

返回值

int — 该类型的值

(&RenderPass) uniform

XuAPI
pub fn (pass &RenderPass) uniform(stage int, slot int, bytes &[]u8) int

用途

在 &RenderPass 上执行 uniform 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
stage int
stage(int)
slot int
slot(int)
bytes &[]u8
bytes(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

int — 该类型的值

(&RenderPass) viewport

XuAPI
pub fn (pass &RenderPass) viewport(x int, y int, width int, height int) int

用途

在 &RenderPass 上执行 viewport 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
x int
值(int)
y int
值(int)
width int
width(int)
height int
height(int)

返回值

int — 该类型的值

(&RenderPass) scissor

XuAPI
pub fn (pass &RenderPass) scissor(x int, y int, width int, height int) int

用途

在 &RenderPass 上执行 scissor 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
x int
值(int)
y int
值(int)
width int
width(int)
height int
height(int)

返回值

int — 该类型的值

(&RenderPass) draw

XuAPI
pub fn (pass &RenderPass) draw(vertex_count int, first_vertex int, instance_count int, first_instance int) int

用途

在 &RenderPass 上执行 draw 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
vertex_count int
vertex_count(int)
first_vertex int
first_vertex(int)
instance_count int
instance_count(int)
first_instance int
first_instance(int)

返回值

int — 该类型的值

(&RenderPass) draw_indexed

XuAPI
pub 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 &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
index_count int
index_count(int)
first_index int
first_index(int)
vertex_offset int
vertex_offset(int)
instance_count int
instance_count(int)
first_instance int
first_instance(int)

返回值

int — 索引值;有效范围和特殊值见用途说明

($&RenderPass) end

XuAPI
pub fn (pass $&RenderPass) end() int

用途

在 $&RenderPass 上执行 end 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass $&RenderPass
本次调用使用的 RenderPass 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&CommandEncoder) close

XuAPI
pub fn (encoder $&CommandEncoder) close() int

用途

$&CommandEncoder 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

encoder $&CommandEncoder
本次调用使用的 CommandEncoder 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

const MAX_COMPUTE_STORAGE_BUFFERS

XuAPI
pub const MAX_COMPUTE_STORAGE_BUFFERS = 8

用途

常量 MAX_COMPUTE_STORAGE_BUFFERS,定义了相关的协议或算法配置参数。

const MAX_COMPUTE_THREADS

XuAPI
pub const MAX_COMPUTE_THREADS = 1024

用途

常量 MAX_COMPUTE_THREADS,定义了相关的协议或算法配置参数。

const MAX_COMPUTE_THREADS_Z

XuAPI
pub const MAX_COMPUTE_THREADS_Z = 64

用途

常量 MAX_COMPUTE_THREADS_Z,定义了相关的协议或算法配置参数。

const MAX_COMPUTE_GROUPS_PER_DIMENSION

XuAPI
pub const MAX_COMPUTE_GROUPS_PER_DIMENSION = 65535

用途

常量 MAX_COMPUTE_GROUPS_PER_DIMENSION,定义了相关的协议或算法配置参数。

struct ComputePipelineDesc

XuAPI
pub 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 int
字段(int)
entrypoint string
字段(string)
read_buffers int
字段(int)
write_buffers int
字段(int)
uniform_sizes []int
字段([]int)
threads_x int
字段(int)
threads_y int
字段(int)
threads_z int
字段(int)

struct ComputePipeline

XuAPI
pub struct ComputePipeline {

}

用途

ComputePipeline 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct StorageBufferWrite

XuAPI
pub struct StorageBufferWrite {

}

用途

StorageBufferWrite 上下文或状态结构体。

公开字段

此类型没有公开字段。

write_buffer

XuAPI
pub fn write_buffer(buffer &Buffer, cycle bool) StorageBufferWrite

用途

写入缓冲。

参数

buffer &Buffer
buffer(只读借用,调用方仍持有原值;类型 &Buffer)
cycle bool
cycle(bool)

返回值

StorageBufferWrite — 该类型的值

struct ComputePass

XuAPI
pub struct ComputePass {

}

用途

ComputePass 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Device) compute_pipeline

XuAPI
pub fn (device &Device) compute_pipeline(desc &ComputePipelineDesc, code &[]u8) ComputePipeline

用途

&Device 上的操作:执行 compute pipeline 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
desc &ComputePipelineDesc
desc(只读借用,调用方仍持有原值;类型 &ComputePipelineDesc)
code &[]u8
码(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

ComputePipeline — 该类型的值

(&CommandEncoder) begin_compute

XuAPI
pub fn (encoder &CommandEncoder) begin_compute(writes &[]StorageBufferWrite) ComputePass

用途

&CommandEncoder 上的操作:执行 begin compute 操作。失败时抛出错误,调用方需处理或继续传播。

参数

encoder &CommandEncoder
本次调用使用的 CommandEncoder 实例;以只读借用传入,调用方仍持有实例。
writes &[]StorageBufferWrite
writes(只读借用,调用方仍持有原值;类型 &[]StorageBufferWrite)

返回值

ComputePass — 该类型的值

(&ComputePass) pipeline

XuAPI
pub fn (pass &ComputePass) pipeline(pipeline &ComputePipeline) int

用途

在 &ComputePass 上执行 pipeline 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &ComputePass
本次调用使用的 ComputePass 实例;以只读借用传入,调用方仍持有实例。
pipeline &ComputePipeline
pipeline(只读借用,调用方仍持有原值;类型 &ComputePipeline)

返回值

int — 该类型的值

(&ComputePass) read_buffer

XuAPI
pub fn (pass &ComputePass) read_buffer(slot int, buffer &Buffer) int

用途

&ComputePass 上的操作:读取缓冲。失败时抛出错误,调用方需处理或继续传播。

参数

pass &ComputePass
本次调用使用的 ComputePass 实例;以只读借用传入,调用方仍持有实例。
slot int
slot(int)
buffer &Buffer
buffer(只读借用,调用方仍持有原值;类型 &Buffer)

返回值

int — 该类型的值

(&ComputePass) uniform

XuAPI
pub fn (pass &ComputePass) uniform(slot int, bytes &[]u8) int

用途

在 &ComputePass 上执行 uniform 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &ComputePass
本次调用使用的 ComputePass 实例;以只读借用传入,调用方仍持有实例。
slot int
slot(int)
bytes &[]u8
bytes(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

int — 该类型的值

(&ComputePass) dispatch

XuAPI
pub fn (pass &ComputePass) dispatch(groups_x int, groups_y int, groups_z int) int

用途

在 &ComputePass 上执行 dispatch 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &ComputePass
本次调用使用的 ComputePass 实例;以只读借用传入,调用方仍持有实例。
groups_x int
groups_x(int)
groups_y int
groups_y(int)
groups_z int
groups_z(int)

返回值

int — 该类型的值

($&ComputePass) end

XuAPI
pub fn (pass $&ComputePass) end() int

用途

在 $&ComputePass 上执行 end 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass $&ComputePass
本次调用使用的 ComputePass 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&ComputePipeline) close

XuAPI
pub fn (pipeline $&ComputePipeline) close() int

用途

$&ComputePipeline 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

pipeline $&ComputePipeline
本次调用使用的 ComputePipeline 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

const VERTEX

XuAPI
pub const VERTEX = 0

用途

常量 VERTEX,定义了相关的协议或算法配置参数。

const FRAGMENT

XuAPI
pub const FRAGMENT = 1

用途

常量 FRAGMENT,定义了相关的协议或算法配置参数。

const NEAREST

XuAPI
pub const NEAREST = 0

用途

常量 NEAREST,定义了相关的协议或算法配置参数。

const LINEAR

XuAPI
pub const LINEAR = 1

用途

常量 LINEAR,定义了相关的协议或算法配置参数。

const REPEAT

XuAPI
pub const REPEAT = 0

用途

常量 REPEAT,定义了相关的协议或算法配置参数。

const MIRRORED_REPEAT

XuAPI
pub const MIRRORED_REPEAT = 1

用途

常量 MIRRORED_REPEAT,定义了相关的协议或算法配置参数。

const CLAMP_TO_EDGE

XuAPI
pub const CLAMP_TO_EDGE = 2

用途

常量 CLAMP_TO_EDGE,定义了相关的协议或算法配置参数。

const TRIANGLES

XuAPI
pub const TRIANGLES = 0

用途

常量 TRIANGLES,定义了相关的协议或算法配置参数。

const TRIANGLE_STRIP

XuAPI
pub const TRIANGLE_STRIP = 1

用途

常量 TRIANGLE_STRIP,定义了相关的协议或算法配置参数。

const LINES

XuAPI
pub const LINES = 2

用途

常量 LINES,定义了相关的协议或算法配置参数。

const LINE_STRIP

XuAPI
pub const LINE_STRIP = 3

用途

常量 LINE_STRIP,定义了相关的协议或算法配置参数。

const POINTS

XuAPI
pub const POINTS = 4

用途

常量 POINTS,定义了相关的协议或算法配置参数。

const CULL_NONE

XuAPI
pub const CULL_NONE = 0

用途

常量 CULL_NONE,定义了相关的协议或算法配置参数。

const CULL_FRONT

XuAPI
pub const CULL_FRONT = 1

用途

常量 CULL_FRONT,定义了相关的协议或算法配置参数。

const CULL_BACK

XuAPI
pub const CULL_BACK = 2

用途

常量 CULL_BACK,定义了相关的协议或算法配置参数。

const COUNTER_CLOCKWISE

XuAPI
pub const COUNTER_CLOCKWISE = 0

用途

常量 COUNTER_CLOCKWISE,定义了相关的协议或算法配置参数。

const CLOCKWISE

XuAPI
pub const CLOCKWISE = 1

用途

常量 CLOCKWISE,定义了相关的协议或算法配置参数。

const DEPTH_DISABLED

XuAPI
pub const DEPTH_DISABLED = 0

用途

常量 DEPTH_DISABLED,定义了相关的协议或算法配置参数。

const NEVER

XuAPI
pub const NEVER = 1

用途

常量 NEVER,定义了相关的协议或算法配置参数。

const LESS

XuAPI
pub const LESS = 2

用途

常量 LESS,定义了相关的协议或算法配置参数。

const EQUAL

XuAPI
pub const EQUAL = 3

用途

常量 EQUAL,定义了相关的协议或算法配置参数。

const LESS_EQUAL

XuAPI
pub const LESS_EQUAL = 4

用途

常量 LESS_EQUAL,定义了相关的协议或算法配置参数。

const GREATER

XuAPI
pub const GREATER = 5

用途

常量 GREATER,定义了相关的协议或算法配置参数。

const NOT_EQUAL

XuAPI
pub const NOT_EQUAL = 6

用途

常量 NOT_EQUAL,定义了相关的协议或算法配置参数。

const GREATER_EQUAL

XuAPI
pub const GREATER_EQUAL = 7

用途

常量 GREATER_EQUAL,定义了相关的协议或算法配置参数。

const ALWAYS

XuAPI
pub const ALWAYS = 8

用途

常量 ALWAYS,定义了相关的协议或算法配置参数。

const BLEND_DISABLED

XuAPI
pub const BLEND_DISABLED = 0

用途

常量 BLEND_DISABLED,定义了相关的协议或算法配置参数。

const BLEND_ALPHA

XuAPI
pub const BLEND_ALPHA = 1

用途

常量 BLEND_ALPHA,定义了相关的协议或算法配置参数。

const BLEND_PREMULTIPLIED

XuAPI
pub const BLEND_PREMULTIPLIED = 2

用途

常量 BLEND_PREMULTIPLIED,定义了相关的协议或算法配置参数。

const PER_VERTEX

XuAPI
pub const PER_VERTEX = 0

用途

常量 PER_VERTEX,定义了相关的协议或算法配置参数。

const PER_INSTANCE

XuAPI
pub const PER_INSTANCE = 1

用途

常量 PER_INSTANCE,定义了相关的协议或算法配置参数。

const FLOAT

XuAPI
pub const FLOAT = 1

用途

常量 FLOAT,定义了相关的协议或算法配置参数。

const FLOAT2

XuAPI
pub const FLOAT2 = 2

用途

常量 FLOAT2,定义了相关的协议或算法配置参数。

const FLOAT3

XuAPI
pub const FLOAT3 = 3

用途

常量 FLOAT3,定义了相关的协议或算法配置参数。

const FLOAT4

XuAPI
pub const FLOAT4 = 4

用途

常量 FLOAT4,定义了相关的协议或算法配置参数。

const UNORM8X4

XuAPI
pub const UNORM8X4 = 5

用途

常量 UNORM8X4,定义了相关的协议或算法配置参数。

const UINT

XuAPI
pub const UINT = 6

用途

常量 UINT,定义了相关的协议或算法配置参数。

const UINT2

XuAPI
pub const UINT2 = 7

用途

常量 UINT2,定义了相关的协议或算法配置参数。

const UINT3

XuAPI
pub const UINT3 = 8

用途

常量 UINT3,定义了相关的协议或算法配置参数。

const UINT4

XuAPI
pub const UINT4 = 9

用途

常量 UINT4,定义了相关的协议或算法配置参数。

struct SamplerDesc

XuAPI
pub 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 int
字段(int)
mag_filter int
字段(int)
mip_filter int
字段(int)
address_u int
字段(int)
address_v int
字段(int)
address_w int
字段(int)
min_lod f64
字段(f64)
max_lod f64
字段(f64)

sampler_defaults

XuAPI
pub fn sampler_defaults() SamplerDesc

用途

执行 sampler defaults 操作。

参数

无需传入参数。

返回值

SamplerDesc — 该类型的值

struct ShaderDesc

XuAPI
pub 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 int
字段(int)
format int
字段(int)
entrypoint string
字段(string)
samplers int
字段(int)
uniform_sizes []int
字段([]int)

struct VertexBufferLayout

XuAPI
pub struct VertexBufferLayout {
    pub slot int
    pub stride int
    pub rate int
}

用途

承载 slot、stride、rate 等属性的结构体。

公开字段

slot int
字段(int)
stride int
字段(int)
rate int
字段(int)

struct VertexAttribute

XuAPI
pub struct VertexAttribute {
    pub location int
    pub slot int
    pub format int
    pub offset int
}

用途

承载 location、slot、format、offset 等属性的结构体。

公开字段

location int
字段(int)
slot int
字段(int)
format int
字段(int)
offset int
偏移

struct PipelineDesc

XuAPI
pub 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 int
字段(int)
depth_format int
字段(int)
primitive int
字段(int)
cull int
字段(int)
front_face int
字段(int)
depth_compare int
字段(int)
depth_write bool
字段(bool)
blend int
字段(int)
vertex_buffers []VertexBufferLayout
字段([]VertexBufferLayout)
attributes []VertexAttribute
字段([]VertexAttribute)

pipeline_defaults

XuAPI
pub fn pipeline_defaults(color_format int) PipelineDesc

用途

执行 pipeline defaults 操作。

参数

color_format int
color_format(int)

返回值

PipelineDesc — 该类型的值

struct Sampler

XuAPI
pub struct Sampler {

}

用途

Sampler 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct Shader

XuAPI
pub struct Shader {

}

用途

Shader 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct GraphicsPipeline

XuAPI
pub struct GraphicsPipeline {

}

用途

GraphicsPipeline 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Device) sampler

XuAPI
pub fn (device &Device) sampler(desc SamplerDesc) Sampler

用途

在 &Device 上执行 sampler 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
desc SamplerDesc
desc(SamplerDesc)

返回值

Sampler — 该类型的值

(&Device) shader

XuAPI
pub fn (device &Device) shader(desc &ShaderDesc, code &[]u8) Shader

用途

在 &Device 上执行 shader 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
desc &ShaderDesc
desc(只读借用,调用方仍持有原值;类型 &ShaderDesc)
code &[]u8
码(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

Shader — 该类型的值

(&Device) graphics_pipeline

XuAPI
pub fn (device &Device) graphics_pipeline(vertex &Shader, fragment &Shader, desc &PipelineDesc) GraphicsPipeline

用途

&Device 上的操作:执行 graphics pipeline 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
vertex &Shader
vertex(只读借用,调用方仍持有原值;类型 &Shader)
fragment &Shader
fragment(只读借用,调用方仍持有原值;类型 &Shader)
desc &PipelineDesc
desc(只读借用,调用方仍持有原值;类型 &PipelineDesc)

返回值

GraphicsPipeline — 该类型的值

($&Sampler) close

XuAPI
pub fn (sampler $&Sampler) close() int

用途

$&Sampler 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

sampler $&Sampler
本次调用使用的 Sampler 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Shader) close

XuAPI
pub fn (shader $&Shader) close() int

用途

$&Shader 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

shader $&Shader
本次调用使用的 Shader 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&GraphicsPipeline) close

XuAPI
pub fn (pipeline $&GraphicsPipeline) close() int

用途

$&GraphicsPipeline 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

pipeline $&GraphicsPipeline
本次调用使用的 GraphicsPipeline 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

struct DeviceRef

XuAPI
pub struct DeviceRef {

}

用途

DeviceRef 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct BufferRef

XuAPI
pub struct BufferRef {

}

用途

BufferRef 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct TextureRef

XuAPI
pub struct TextureRef {

}

用途

TextureRef 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct SamplerRef

XuAPI
pub struct SamplerRef {

}

用途

SamplerRef 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Device) reference

XuAPI
pub fn (device &Device) reference() DeviceRef

用途

在 &Device 上执行 reference 操作。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。

返回值

DeviceRef — 该类型的值

(&Buffer) reference

XuAPI
pub fn (buffer &Buffer) reference() BufferRef

用途

在 &Buffer 上执行 reference 操作。

参数

buffer &Buffer
本次调用使用的 Buffer 实例;以只读借用传入,调用方仍持有实例。

返回值

BufferRef — 该类型的值

(&Texture) reference

XuAPI
pub fn (texture &Texture) reference() TextureRef

用途

在 &Texture 上执行 reference 操作。

参数

texture &Texture
本次调用使用的 Texture 实例;以只读借用传入,调用方仍持有实例。

返回值

TextureRef — 该类型的值

(&Sampler) reference

XuAPI
pub fn (sampler &Sampler) reference() SamplerRef

用途

在 &Sampler 上执行 reference 操作。

参数

sampler &Sampler
本次调用使用的 Sampler 实例;以只读借用传入,调用方仍持有实例。

返回值

SamplerRef — 该类型的值

(DeviceRef) same

XuAPI
pub fn (reference DeviceRef) same(other DeviceRef) bool

用途

在 DeviceRef 上执行 same 操作。

参数

reference DeviceRef
本次调用使用的 DeviceRef 实例;按值接收。
other DeviceRef
另一侧同类型值(DeviceRef)

返回值

bool — 是否成立

(DeviceRef) validate

XuAPI
pub fn (reference DeviceRef) validate() int

用途

在 DeviceRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference DeviceRef
本次调用使用的 DeviceRef 实例;按值接收。

返回值

int — 该类型的值

(BufferRef) validate

XuAPI
pub fn (reference BufferRef) validate() int

用途

在 BufferRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference BufferRef
本次调用使用的 BufferRef 实例;按值接收。

返回值

int — 该类型的值

(TextureRef) validate

XuAPI
pub fn (reference TextureRef) validate() int

用途

在 TextureRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference TextureRef
本次调用使用的 TextureRef 实例;按值接收。

返回值

int — 该类型的值

(SamplerRef) validate

XuAPI
pub fn (reference SamplerRef) validate() int

用途

在 SamplerRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference SamplerRef
本次调用使用的 SamplerRef 实例;按值接收。

返回值

int — 该类型的值

(BufferRef) size_bytes

XuAPI
pub fn (reference BufferRef) size_bytes() int

用途

BufferRef 上的操作:尺寸字节。

参数

reference BufferRef
本次调用使用的 BufferRef 实例;按值接收。

返回值

int — 该类型的值

(DeviceRef) validate_buffer

XuAPI
pub fn (reference DeviceRef) validate_buffer(buffer BufferRef) int

用途

DeviceRef 上的操作:执行 validate buffer 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference DeviceRef
本次调用使用的 DeviceRef 实例;按值接收。
buffer BufferRef
buffer(BufferRef)

返回值

int — 该类型的值

(DeviceRef) validate_texture

XuAPI
pub fn (reference DeviceRef) validate_texture(texture TextureRef) int

用途

DeviceRef 上的操作:执行 validate texture 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference DeviceRef
本次调用使用的 DeviceRef 实例;按值接收。
texture TextureRef
texture(TextureRef)

返回值

int — 该类型的值

(DeviceRef) validate_sampler

XuAPI
pub fn (reference DeviceRef) validate_sampler(sampler SamplerRef) int

用途

DeviceRef 上的操作:执行 validate sampler 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference DeviceRef
本次调用使用的 DeviceRef 实例;按值接收。
sampler SamplerRef
sampler(SamplerRef)

返回值

int — 该类型的值

(&RenderPass) vertex_buffer_ref

XuAPI
pub fn (pass &RenderPass) vertex_buffer_ref(slot int, buffer BufferRef, offset int) int

用途

&RenderPass 上的操作:执行 vertex buffer ref 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
slot int
slot(int)
buffer BufferRef
buffer(BufferRef)
offset int
偏移(int)

返回值

int — 该类型的值

(&RenderPass) index_buffer_ref

XuAPI
pub fn (pass &RenderPass) index_buffer_ref(buffer BufferRef, offset int, element_size int) int

用途

&RenderPass 上的操作:执行 index buffer ref 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
buffer BufferRef
buffer(BufferRef)
offset int
偏移(int)
element_size int
element_size(int)

返回值

int — 索引值;有效范围和特殊值见用途说明

(&RenderPass) sampler_ref

XuAPI
pub fn (pass &RenderPass) sampler_ref(stage int, slot int, texture TextureRef, sampler SamplerRef) int

用途

&RenderPass 上的操作:执行 sampler ref 操作。失败时抛出错误,调用方需处理或继续传播。

参数

pass &RenderPass
本次调用使用的 RenderPass 实例;以只读借用传入,调用方仍持有实例。
stage int
stage(int)
slot int
slot(int)
texture TextureRef
texture(TextureRef)
sampler SamplerRef
sampler(SamplerRef)

返回值

int — 该类型的值

struct SoftBlob

XuAPI
pub struct SoftBlob {

}

用途

SoftBlob 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct SoftBlobRef

XuAPI
pub struct SoftBlobRef {

}

用途

SoftBlobRef 上下文或状态结构体。

公开字段

此类型没有公开字段。

soft_owner_new

XuAPI
pub fn soft_owner_new() int

用途

执行 soft owner new 操作。失败时抛出错误,调用方需处理或继续传播。

参数

无需传入参数。

返回值

int — 该类型的值

soft_owner_close

XuAPI
pub fn soft_owner_close(owner int) int

用途

关闭softowner。失败时抛出错误,调用方需处理或继续传播。

参数

owner int
owner(int)

返回值

int — 该类型的值

soft_blob_create

XuAPI
pub fn soft_blob_create(owner int, bytes &[]u8) SoftBlob

用途

创建softblob。失败时抛出错误,调用方需处理或继续传播。

参数

owner int
owner(int)
bytes &[]u8
bytes(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

SoftBlob — 该类型的值

empty_soft_blob_ref

XuAPI
pub fn empty_soft_blob_ref() SoftBlobRef

用途

执行 empty soft blob ref 操作。

参数

无需传入参数。

返回值

SoftBlobRef — 该类型的值

(&SoftBlob) reference

XuAPI
pub fn (blob &SoftBlob) reference() SoftBlobRef

用途

在 &SoftBlob 上执行 reference 操作。

参数

blob &SoftBlob
本次调用使用的 SoftBlob 实例;以只读借用传入,调用方仍持有实例。

返回值

SoftBlobRef — 该类型的值

($&SoftBlob) close

XuAPI
pub fn (blob $&SoftBlob) close() int

用途

$&SoftBlob 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

blob $&SoftBlob
本次调用使用的 SoftBlob 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

(SoftBlobRef) validate

XuAPI
pub fn (reference SoftBlobRef) validate(owner int) int

用途

在 SoftBlobRef 上执行 validate 操作。失败时抛出错误,调用方需处理或继续传播。

参数

reference SoftBlobRef
本次调用使用的 SoftBlobRef 实例;按值接收。
owner int
owner(int)

返回值

int — 该类型的值

(SoftBlobRef) read_u32

XuAPI
pub fn (reference SoftBlobRef) read_u32(offset int) int

用途

SoftBlobRef 上的操作:读取u32。失败时抛出错误,调用方需处理或继续传播。

参数

reference SoftBlobRef
本次调用使用的 SoftBlobRef 实例;按值接收。
offset int
偏移(int)

返回值

int — 该类型的值

(SoftBlobRef) read_f32

XuAPI
pub fn (reference SoftBlobRef) read_f32(offset int) f64

用途

SoftBlobRef 上的操作:读取f32。失败时抛出错误,调用方需处理或继续传播。

参数

reference SoftBlobRef
本次调用使用的 SoftBlobRef 实例;按值接收。
offset int
偏移(int)

返回值

f64 — 该类型的值

(SoftBlobRef) read_rgba8

XuAPI
pub fn (reference SoftBlobRef) read_rgba8(index int) int

用途

SoftBlobRef 上的操作:读取rgba8。失败时抛出错误,调用方需处理或继续传播。

参数

reference SoftBlobRef
本次调用使用的 SoftBlobRef 实例;按值接收。
index int
index(int)

返回值

int — 该类型的值

const PRESENT_VSYNC

XuAPI
pub const PRESENT_VSYNC = 0

用途

常量 PRESENT_VSYNC,定义了相关的协议或算法配置参数。

const PRESENT_IMMEDIATE

XuAPI
pub const PRESENT_IMMEDIATE = 1

用途

常量 PRESENT_IMMEDIATE,定义了相关的协议或算法配置参数。

const PRESENT_MAILBOX

XuAPI
pub const PRESENT_MAILBOX = 2

用途

常量 PRESENT_MAILBOX,定义了相关的协议或算法配置参数。

struct SurfaceOptions

XuAPI
pub struct SurfaceOptions {
    pub present_mode int
}

用途

Gpu 配置参数与选项集合。

公开字段

present_mode int
字段(int)

struct Surface

XuAPI
pub struct Surface {

}

用途

Surface 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct Frame

XuAPI
pub struct Frame {

}

用途

Gpu 协议数据帧结构封装。

公开字段

此类型没有公开字段。

(&Device) surface

XuAPI
pub fn (device &Device) surface(target &window.Window, options SurfaceOptions) Surface

用途

在 &Device 上执行 surface 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
target &window.Window
target(只读借用,调用方仍持有原值;类型 &window.Window)
options SurfaceOptions
options(SurfaceOptions)

返回值

Surface — 该类型的值

(&Surface) format

XuAPI
pub fn (surface &Surface) format() int

用途

&Surface 上的操作:格式化为字符串。失败时抛出错误,调用方需处理或继续传播。

参数

surface &Surface
本次调用使用的 Surface 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Surface) supports_present_mode

XuAPI
pub fn (surface &Surface) supports_present_mode(mode int) bool

用途

&Surface 上的操作:执行 supports present mode 操作。失败时抛出错误,调用方需处理或继续传播。

参数

surface &Surface
本次调用使用的 Surface 实例;以只读借用传入,调用方仍持有实例。
mode int
模式(int)

返回值

bool — 是否成立

(&Surface) set_present_mode

XuAPI
pub fn (surface &Surface) set_present_mode(mode int) int

用途

&Surface 上的操作:设置 present mode。失败时抛出错误,调用方需处理或继续传播。

参数

surface &Surface
本次调用使用的 Surface 实例;以只读借用传入,调用方仍持有实例。
mode int
模式(int)

返回值

int — 该类型的值

(&Surface) acquire

XuAPI
pub fn (surface &Surface) acquire() Frame

用途

在 &Surface 上执行 acquire 操作。失败时抛出错误,调用方需处理或继续传播。

参数

surface &Surface
本次调用使用的 Surface 实例;以只读借用传入,调用方仍持有实例。

返回值

Frame — 该类型的值

(&Frame) has_image

XuAPI
pub fn (frame &Frame) has_image() bool

用途

&Frame 上的操作:判断是否具有 image。

参数

frame &Frame
本次调用使用的 Frame 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Frame) width

XuAPI
pub fn (frame &Frame) width() int

用途

在 &Frame 上执行 width 操作。

参数

frame &Frame
本次调用使用的 Frame 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Frame) height

XuAPI
pub fn (frame &Frame) height() int

用途

在 &Frame 上执行 height 操作。

参数

frame &Frame
本次调用使用的 Frame 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Frame) format

XuAPI
pub fn (frame &Frame) format() int

用途

&Frame 上的操作:格式化为字符串。

参数

frame &Frame
本次调用使用的 Frame 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Frame) begin_render

XuAPI
pub fn (frame &Frame) begin_render(load int, clear Color, depth DepthAttachment) RenderPass

用途

&Frame 上的操作:执行 begin render 操作。失败时抛出错误,调用方需处理或继续传播。

参数

frame &Frame
本次调用使用的 Frame 实例;以只读借用传入,调用方仍持有实例。
load int
load(int)
clear Color
clear(Color)
depth DepthAttachment
depth(DepthAttachment)

返回值

RenderPass — 该类型的值

(&Frame) begin_compute

XuAPI
pub fn (frame &Frame) begin_compute(writes &[]StorageBufferWrite) ComputePass

用途

&Frame 上的操作:执行 begin compute 操作。失败时抛出错误,调用方需处理或继续传播。

参数

frame &Frame
本次调用使用的 Frame 实例;以只读借用传入,调用方仍持有实例。
writes &[]StorageBufferWrite
writes(只读借用,调用方仍持有原值;类型 &[]StorageBufferWrite)

返回值

ComputePass — 该类型的值

($&Frame) present

XuAPI
pub fn (frame $&Frame) present() Fence

用途

在 $&Frame 上执行 present 操作。失败时抛出错误,调用方需处理或继续传播。

参数

frame $&Frame
本次调用使用的 Frame 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

Fence — 该类型的值

($&Frame) close

XuAPI
pub fn (frame $&Frame) close() int

用途

$&Frame 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

frame $&Frame
本次调用使用的 Frame 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

($&Surface) close

XuAPI
pub fn (surface $&Surface) close() int

用途

$&Surface 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

surface $&Surface
本次调用使用的 Surface 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

const TEXTURE_SAMPLED

XuAPI
pub const TEXTURE_SAMPLED = 1

用途

常量 TEXTURE_SAMPLED,定义了相关的协议或算法配置参数。

const TEXTURE_COLOR_TARGET

XuAPI
pub const TEXTURE_COLOR_TARGET = 2

用途

常量 TEXTURE_COLOR_TARGET,定义了相关的协议或算法配置参数。

const TEXTURE_DEPTH_TARGET

XuAPI
pub const TEXTURE_DEPTH_TARGET = 4

用途

常量 TEXTURE_DEPTH_TARGET,定义了相关的协议或算法配置参数。

const MAX_TEXTURE_SIZE_2D

XuAPI
pub const MAX_TEXTURE_SIZE_2D = 16384

用途

常量 MAX_TEXTURE_SIZE_2D,定义了相关的协议或算法配置参数。

struct Texture2DDesc

XuAPI
pub struct Texture2DDesc {
    pub format int
    pub width int
    pub height int
    pub levels int
    pub usage int
}

用途

承载 format、width、height、levels、usage 等属性的结构体。

公开字段

format int
字段(int)
width int
字段(int)
height int
字段(int)
levels int
字段(int)
usage int
用法说明

struct Texture

XuAPI
pub struct Texture {

}

用途

Texture 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct TextureSlice

XuAPI
pub struct TextureSlice {

}

用途

TextureSlice 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Device) supports_texture_2d

XuAPI
pub fn (device &Device) supports_texture_2d(format int, usage int) bool

用途

&Device 上的操作:执行 supports texture 2d 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
format int
format(int)
usage int
用法说明(int)

返回值

bool — 是否成立

(&Device) texture_2d

XuAPI
pub fn (device &Device) texture_2d(desc Texture2DDesc) Texture

用途

&Device 上的操作:执行 texture 2d 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
desc Texture2DDesc
desc(Texture2DDesc)

返回值

Texture — 该类型的值

(&Texture) level_count

XuAPI
pub fn (texture &Texture) level_count() int

用途

&Texture 上的操作:执行 level count 操作。

参数

texture &Texture
本次调用使用的 Texture 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Texture) size_bytes

XuAPI
pub fn (texture &Texture) size_bytes() int

用途

&Texture 上的操作:尺寸字节。

参数

texture &Texture
本次调用使用的 Texture 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Texture) level_layout

XuAPI
pub fn (texture &Texture) level_layout(mip int) layout.Level2D

用途

&Texture 上的操作:执行 level layout 操作。失败时抛出错误,调用方需处理或继续传播。

参数

texture &Texture
本次调用使用的 Texture 实例;以只读借用传入,调用方仍持有实例。
mip int
mip(int)

返回值

layout.Level2D — 该类型的值

(&Texture) view

XuAPI
pub fn (texture &Texture) view(mip int) TextureSlice

用途

&Texture 上的操作:视图。失败时抛出错误,调用方需处理或继续传播。

参数

texture &Texture
本次调用使用的 Texture 实例;以只读借用传入,调用方仍持有实例。
mip int
mip(int)

返回值

TextureSlice — 该类型的值

(&Device) upload_texture

XuAPI
pub fn (device &Device) upload_texture(texture &Texture, mip int, bytes &[]u8) Fence

用途

&Device 上的操作:执行 upload texture 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
texture &Texture
texture(只读借用,调用方仍持有原值;类型 &Texture)
mip int
mip(int)
bytes &[]u8
bytes(只读借用,调用方仍持有原值;类型 &[]u8)

返回值

Fence — 该类型的值

(&Device) download_texture

XuAPI
pub fn (device &Device) download_texture(texture &Texture, mip int) Readback

用途

&Device 上的操作:执行 download texture 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
texture &Texture
texture(只读借用,调用方仍持有原值;类型 &Texture)
mip int
mip(int)

返回值

Readback — 该类型的值

(&Device) generate_mips

XuAPI
pub fn (device &Device) generate_mips(texture &Texture) Fence

用途

&Device 上的操作:执行 generate mips 操作。失败时抛出错误,调用方需处理或继续传播。

参数

device &Device
本次调用使用的 Device 实例;以只读借用传入,调用方仍持有实例。
texture &Texture
texture(只读借用,调用方仍持有原值;类型 &Texture)

返回值

Fence — 该类型的值

($&Texture) close

XuAPI
pub fn (texture $&Texture) close() int

用途

$&Texture 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

texture $&Texture
本次调用使用的 Texture 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值