Struct CommandBuffer 

pub struct CommandBuffer {
    pub label: String,
    /* private fields */
}

Record commands for the GPU, spawn render/compute passes, and submit once finished. Guard rails ensure pipelines/buffers are set before draws/dispatches.

Examples

Clear a surface:

use wde_wgpu::{
    command_buffer::{Color, CommandBuffer, LoadOp, RenderPassColorAttachment, StoreOp},
    instance::RenderInstanceData,
    texture::TextureView,
};

let mut cmd = CommandBuffer::new(instance, "frame");
{
    cmd.create_render_pass("clear", |pass| {
        pass.add_color_attachment(RenderPassColorAttachment {
            texture: Some(view),
            load: LoadOp::Clear(Color::BLACK),
            store: StoreOp::Store,
        });
    });
}
cmd.submit(instance);

Dispatch compute work:

use wde_wgpu::{command_buffer::CommandBuffer, compute_pass::WComputePass, compute_pipeline::ComputePipeline};

let mut cmd = CommandBuffer::new(instance, "compute");
{
    let mut pass: WComputePass = cmd.create_compute_pass("cull");
    pass.set_pipeline(pipeline).unwrap().set_bind_group(0, bind).dispatch(4, 1, 1).unwrap();
}
cmd.submit(instance);

Fields

label: String

Implementations

impl CommandBuffer

pub fn new(instance: &RenderInstanceData<'_>, label: &str) -> CommandBuffer

Create a new command buffer.

Arguments

• instance - The render instance.
• label - The label of the command buffer.

pub fn create_render_pass<'pass>( &'pass mut self, label: &str, builder_func: impl FnOnce(&mut RenderPassBuilder<'pass>) -> Result<(), String>, ) -> Result<RenderPassInstance<'pass>, String>

Create a new render pass.

Arguments

• label - The label of the render pass.
• builder_func - The function to build the render pass. This function should return Ok(()) if the render pass was built successfully, and Err(String) otherwise. If the function returns Err, the render pass will not be created.

pub fn create_compute_pass<'pass>( &'pass mut self, label: &str, ) -> WComputePass<'pass>

Create a new compute pass.

Arguments

• label - The label of the compute pass.

pub fn submit(self, instance: &RenderInstanceData<'_>)

Finish and submit a command buffer.

Arguments

• instance - The render instance.

pub fn copy_buffer_to_buffer(&mut self, source: &Buffer, destination: &Buffer)

Copy a buffer to another buffer. Please use the copy_from_buffer method of the buffer to copy data.

Arguments

• source - The source buffer.
• destination - The destination buffer.

pub fn copy_buffer_to_buffer_offset( &mut self, source: &Buffer, destination: &Buffer, source_offset: u64, destination_offset: u64, size: u64, )

Copy a buffer to another buffer with offsets. Please use the copy_from_buffer method of the buffer to copy data.

Arguments

• source - The source buffer.
• destination - The destination buffer.
• source_offset - The offset in the source buffer.
• destination_offset - The offset in the destination buffer.
• size - The size to copy.

pub fn copy_texture_to_buffer( &mut self, source: &Texture, destination: &Buffer, size: Extent3d, )

Copy a texture to a buffer. Please use the copy_from_texture method of the buffer to copy data.

Arguments

• source - The source texture.
• destination - The destination buffer.
• size - The size of the texture.

pub fn encoder(&mut self) -> &mut CommandEncoder

Get the encoder of the command buffer.

Returns

The encoder of the command buffer.

Trait Implementations

impl Debug for CommandBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.