Struct wgpu::RenderBundleEncoder
source · pub struct RenderBundleEncoder<'a> { /* private fields */ }
Expand description
Encodes a series of GPU operations into a reusable “render bundle”.
It only supports a handful of render commands, but it makes them reusable.
It can be created with Device::create_render_bundle_encoder
.
It can be executed onto a CommandEncoder
using RenderPass::execute_bundles
.
Executing a RenderBundle
is often more efficient than issuing the underlying commands
manually.
Corresponds to WebGPU GPURenderBundleEncoder
.
Implementations§
source§impl<'a> RenderBundleEncoder<'a>
impl<'a> RenderBundleEncoder<'a>
sourcepub fn finish(self, desc: &RenderBundleDescriptor<'_>) -> RenderBundle
pub fn finish(self, desc: &RenderBundleDescriptor<'_>) -> RenderBundle
Finishes recording and returns a RenderBundle
that can be executed in other render passes.
sourcepub fn set_bind_group(
&mut self,
index: u32,
bind_group: &'a BindGroup,
offsets: &[DynamicOffset]
)
pub fn set_bind_group( &mut self, index: u32, bind_group: &'a BindGroup, offsets: &[DynamicOffset] )
Sets the active bind group for a given bind group index. The bind group layout
in the active pipeline when any draw()
function is called must match the layout of this bind group.
If the bind group have dynamic offsets, provide them in the binding order.
sourcepub fn set_pipeline(&mut self, pipeline: &'a RenderPipeline)
pub fn set_pipeline(&mut self, pipeline: &'a RenderPipeline)
Sets the active render pipeline.
Subsequent draw calls will exhibit the behavior defined by pipeline
.
sourcepub fn set_index_buffer(
&mut self,
buffer_slice: BufferSlice<'a>,
index_format: IndexFormat
)
pub fn set_index_buffer( &mut self, buffer_slice: BufferSlice<'a>, index_format: IndexFormat )
Sets the active index buffer.
Subsequent calls to draw_indexed
on this RenderBundleEncoder
will
use buffer
as the source index buffer.
sourcepub fn set_vertex_buffer(&mut self, slot: u32, buffer_slice: BufferSlice<'a>)
pub fn set_vertex_buffer(&mut self, slot: u32, buffer_slice: BufferSlice<'a>)
Assign a vertex buffer to a slot.
Subsequent calls to draw
and draw_indexed
on this
RenderBundleEncoder
will use buffer
as one of the source vertex buffers.
The slot
refers to the index of the matching descriptor in
VertexState::buffers
.
sourcepub fn draw(&mut self, vertices: Range<u32>, instances: Range<u32>)
pub fn draw(&mut self, vertices: Range<u32>, instances: Range<u32>)
Draws primitives from the active vertex buffer(s).
The active vertex buffers can be set with RenderBundleEncoder::set_vertex_buffer
.
Does not use an Index Buffer. If you need this see RenderBundleEncoder::draw_indexed
Panics if vertices Range is outside of the range of the vertices range of any set vertex buffer.
vertices: The range of vertices to draw. instances: Range of Instances to draw. Use 0..1 if instance buffers are not used. E.g.of how its used internally
for instance_id in instance_range {
for vertex_id in vertex_range {
let vertex = vertex[vertex_id];
vertex_shader(vertex, vertex_id, instance_id);
}
}
sourcepub fn draw_indexed(
&mut self,
indices: Range<u32>,
base_vertex: i32,
instances: Range<u32>
)
pub fn draw_indexed( &mut self, indices: Range<u32>, base_vertex: i32, instances: Range<u32> )
Draws indexed primitives using the active index buffer and the active vertex buffer(s).
The active index buffer can be set with RenderBundleEncoder::set_index_buffer
.
The active vertex buffer(s) can be set with RenderBundleEncoder::set_vertex_buffer
.
Panics if indices Range is outside of the range of the indices range of any set index buffer.
indices: The range of indices to draw. base_vertex: value added to each index value before indexing into the vertex buffers. instances: Range of Instances to draw. Use 0..1 if instance buffers are not used. E.g.of how its used internally
for instance_id in instance_range {
for index_index in index_range {
let vertex_id = index_buffer[index_index];
let adjusted_vertex_id = vertex_id + base_vertex;
let vertex = vertex[adjusted_vertex_id];
vertex_shader(vertex, adjusted_vertex_id, instance_id);
}
}
sourcepub fn draw_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: BufferAddress
)
pub fn draw_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: BufferAddress )
Draws primitives from the active vertex buffer(s) based on the contents of the indirect_buffer
.
The active vertex buffers can be set with RenderBundleEncoder::set_vertex_buffer
.
The structure expected in indirect_buffer
must conform to DrawIndirectArgs
.
sourcepub fn draw_indexed_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: BufferAddress
)
pub fn draw_indexed_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: BufferAddress )
Draws indexed primitives using the active index buffer and the active vertex buffers,
based on the contents of the indirect_buffer
.
The active index buffer can be set with RenderBundleEncoder::set_index_buffer
, while the active
vertex buffers can be set with RenderBundleEncoder::set_vertex_buffer
.
The structure expected in indirect_buffer
must conform to DrawIndexedIndirectArgs
.
source§impl<'a> RenderBundleEncoder<'a>
impl<'a> RenderBundleEncoder<'a>
Features::PUSH_CONSTANTS
must be enabled on the device in order to call these functions.
sourcepub fn set_push_constants(
&mut self,
stages: ShaderStages,
offset: u32,
data: &[u8]
)
pub fn set_push_constants( &mut self, stages: ShaderStages, offset: u32, data: &[u8] )
Set push constant data.
Offset is measured in bytes, but must be a multiple of PUSH_CONSTANT_ALIGNMENT
.
Data size must be a multiple of 4 and must have an alignment of 4.
For example, with an offset of 4 and an array of [u8; 8]
, that will write to the range
of 4..12.
For each byte in the range of push constant data written, the union of the stages of all push constant
ranges that covers that byte must be exactly stages
. There’s no good way of explaining this simply,
so here are some examples:
For the given ranges:
- 0..4 Vertex
- 4..8 Fragment
You would need to upload this in two set_push_constants calls. First for the Vertex
range, second for the Fragment
range.
For the given ranges:
- 0..8 Vertex
- 4..12 Fragment
You would need to upload this in three set_push_constants calls. First for the Vertex
only range 0..4, second
for the Vertex | Fragment
range 4..8, third for the Fragment
range 8..12.
Trait Implementations§
source§impl<'a> Debug for RenderBundleEncoder<'a>
impl<'a> Debug for RenderBundleEncoder<'a>
source§impl<'a> RenderEncoder<'a> for RenderBundleEncoder<'a>
impl<'a> RenderEncoder<'a> for RenderBundleEncoder<'a>
source§fn set_bind_group(
&mut self,
index: u32,
bind_group: &'a BindGroup,
offsets: &[DynamicOffset]
)
fn set_bind_group( &mut self, index: u32, bind_group: &'a BindGroup, offsets: &[DynamicOffset] )
draw()
function is called must match the layout of this bind group. Read moresource§fn set_pipeline(&mut self, pipeline: &'a RenderPipeline)
fn set_pipeline(&mut self, pipeline: &'a RenderPipeline)
source§fn set_index_buffer(
&mut self,
buffer_slice: BufferSlice<'a>,
index_format: IndexFormat
)
fn set_index_buffer( &mut self, buffer_slice: BufferSlice<'a>, index_format: IndexFormat )
source§fn set_vertex_buffer(&mut self, slot: u32, buffer_slice: BufferSlice<'a>)
fn set_vertex_buffer(&mut self, slot: u32, buffer_slice: BufferSlice<'a>)
source§fn draw(&mut self, vertices: Range<u32>, instances: Range<u32>)
fn draw(&mut self, vertices: Range<u32>, instances: Range<u32>)
source§fn draw_indexed(
&mut self,
indices: Range<u32>,
base_vertex: i32,
instances: Range<u32>
)
fn draw_indexed( &mut self, indices: Range<u32>, base_vertex: i32, instances: Range<u32> )
source§fn draw_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: BufferAddress
)
fn draw_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: BufferAddress )
indirect_buffer
. Read moresource§fn draw_indexed_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: BufferAddress
)
fn draw_indexed_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: BufferAddress )
indirect_buffer
. Read moresource§fn set_push_constants(&mut self, stages: ShaderStages, offset: u32, data: &[u8])
fn set_push_constants(&mut self, stages: ShaderStages, offset: u32, data: &[u8])
wgt::Features::PUSH_CONSTANTS
must be enabled on the device in order to call this function. Read more