Struct CommandEncoder 

pub struct CommandEncoder<'a> { /* private fields */ }

records commands; finish() makes a CommandBuffer for Queue::submit

Implementations

impl<'a> CommandEncoder<'a>

pub fn copy_buffer( &mut self, src: &'a Buffer, src_off: u64, dst: &'a Buffer, dst_off: u64, size: u64, )

pub fn fill_buffer( &mut self, buf: &'a Buffer, offset: u64, size: u64, value: u32, )

fill size bytes at offset with a 32-bit value (both multiples of 4)

pub fn copy_buffer_to_texture( &mut self, src: &'a Buffer, layout: DataLayout, dst: TextureRegion<'a>, )

buffer data -> a texture region (the region in Layout::CopyDst)

pub fn copy_texture_to_buffer( &mut self, src: TextureRegion<'a>, dst: &'a Buffer, layout: DataLayout, )

a texture region -> buffer data (the region in Layout::CopySrc)

pub fn barrier(&mut self, before: Access, after: Access)

the accesses before finish (and their writes become visible) before the after ones

pub fn texture_barrier( &mut self, tex: &'a Texture, before: Layout, after: Layout, )

every mip and layer of tex from before to after

pub fn texture_barrier_range( &mut self, tex: &'a Texture, base_mip: u32, mips: u32, base_layer: u32, layers: u32, before: Layout, after: Layout, )

mips base_mip .. +mips and layers base_layer .. +layers of tex from before to after

pub fn set_compute_pipeline(&mut self, p: &'a ComputePipeline)

pub fn set_bind_group(&mut self, index: u32, group: &'a BindGroup)

bind group g (= @group(g)) of the current pipeline’s layout

pub fn push_constants<T: Pod>(&mut self, offset: u32, data: &[T])

push constants at offset (bytes) for the current pipeline

pub fn dispatch(&mut self, x: u32, y: u32, z: u32)

pub fn dispatch_indirect(&mut self, buf: &'a Buffer, offset: u64)

workgroup counts (3 x u32) from buf at offset

pub fn begin_render(&mut self, desc: &RenderPassDesc<'_, 'a>)

pub fn end_render(&mut self)

pub fn set_render_pipeline(&mut self, p: &'a RenderPipeline)

pub fn set_viewport( &mut self, x: f32, y: f32, w: f32, h: f32, min_depth: f32, max_depth: f32, )

the viewport in pixels from the top left (depth range min ..= max)

pub fn set_scissor(&mut self, x: u32, y: u32, w: u32, h: u32)

pub fn set_vertex_buffer(&mut self, slot: u32, buf: &'a Buffer, offset: u64)

pub fn set_index_buffer( &mut self, buf: &'a Buffer, offset: u64, format: IndexFormat, )

pub fn draw( &mut self, vertices: u32, instances: u32, first_vertex: u32, first_instance: u32, )

pub fn draw_indexed( &mut self, indices: u32, instances: u32, first_index: u32, base_vertex: i32, first_instance: u32, )

pub fn draw_indirect(&mut self, buf: &'a Buffer, offset: u64)

one draw: vertex count, instance count, first vertex, first instance (4 x u32)

pub fn draw_indexed_indirect(&mut self, buf: &'a Buffer, offset: u64)

one indexed draw: index count, instance count, first index, base vertex (i32), first instance (5 x 32 bits)

pub fn draw_indexed_indirect_multi( &mut self, buf: &'a Buffer, offset: u64, count: u32, stride: u32, )

count indexed draws, stride bytes apart (Features::multi_draw_indirect)

pub fn draw_indexed_indirect_count( &mut self, buf: &'a Buffer, offset: u64, count_buf: &'a Buffer, count_offset: u64, max_count: u32, stride: u32, )

up to max_count indexed draws, their number (u32) read from count_buf at count_offset (level Voll: Features::draw_indirect_count)

pub fn reset_timestamps(&mut self, ts: &'a Timestamps, first: u32, n: u32)

timestamps first .. first + n may be written again (outside render passes)

pub fn timestamp(&mut self, ts: &'a Timestamps, i: u32)

write timestamp i once every earlier command has finished (reset it first)

pub fn finish(self) -> Result<CommandBuffer<'a>>

the recorded commands, or the first misuse

Trait Implementations

impl Drop for CommandEncoder<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.