Struct bevy_render::render_phase::TrackedRenderPass
source · pub struct TrackedRenderPass<'a> { /* private fields */ }
Expand description
A RenderPass
, which tracks the current pipeline state to skip redundant operations.
It is used to set the current RenderPipeline
, BindGroup
s and Buffer
s.
After all requirements are specified, draw calls can be issued.
Implementations§
source§impl<'a> TrackedRenderPass<'a>
impl<'a> TrackedRenderPass<'a>
sourcepub fn new(device: &RenderDevice, pass: RenderPass<'a>) -> Self
pub fn new(device: &RenderDevice, pass: RenderPass<'a>) -> Self
Tracks the supplied render pass.
sourcepub fn wgpu_pass(&mut self) -> &mut RenderPass<'a>
pub fn wgpu_pass(&mut self) -> &mut RenderPass<'a>
Returns the wgpu RenderPass
.
sourcepub fn set_render_pipeline(&mut self, pipeline: &'a RenderPipeline)
pub fn set_render_pipeline(&mut self, pipeline: &'a RenderPipeline)
Sets the active RenderPipeline
.
Subsequent draw calls will exhibit the behavior defined by the pipeline
.
sourcepub fn set_bind_group(
&mut self,
index: usize,
bind_group: &'a BindGroup,
dynamic_uniform_indices: &[u32]
)
pub fn set_bind_group( &mut self, index: usize, bind_group: &'a BindGroup, dynamic_uniform_indices: &[u32] )
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 binding order.
These offsets have to be aligned to WgpuLimits::min_uniform_buffer_offset_alignment
or WgpuLimits::min_storage_buffer_offset_alignment
appropriately.
sourcepub fn set_vertex_buffer(
&mut self,
slot_index: usize,
buffer_slice: BufferSlice<'a>
)
pub fn set_vertex_buffer( &mut self, slot_index: usize, buffer_slice: BufferSlice<'a> )
Assign a vertex buffer to a slot.
Subsequent calls to draw
and draw_indexed
on this
TrackedRenderPass
will use buffer
as one of the source vertex buffers.
The slot_index
refers to the index of the matching descriptor in
VertexState::buffers
.
sourcepub fn set_index_buffer(
&mut self,
buffer_slice: BufferSlice<'a>,
offset: u64,
index_format: IndexFormat
)
pub fn set_index_buffer( &mut self, buffer_slice: BufferSlice<'a>, offset: u64, index_format: IndexFormat )
Sets the active index buffer.
Subsequent calls to TrackedRenderPass::draw_indexed
will use the buffer referenced by
buffer_slice
as the source index buffer.
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 buffer(s) can be set with TrackedRenderPass::set_vertex_buffer
.
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 TrackedRenderPass::set_index_buffer
, while the
active vertex buffer(s) can be set with TrackedRenderPass::set_vertex_buffer
.
sourcepub fn draw_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: u64
)
pub fn draw_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: u64 )
Draws primitives from the active vertex buffer(s) based on the contents of the
indirect_buffer
.
The active vertex buffers can be set with TrackedRenderPass::set_vertex_buffer
.
The structure expected in indirect_buffer
is the following:
#[repr(C)]
struct DrawIndirect {
vertex_count: u32, // The number of vertices to draw.
instance_count: u32, // The number of instances to draw.
first_vertex: u32, // The Index of the first vertex to draw.
first_instance: u32, // The instance ID of the first instance to draw.
// has to be 0, unless [`Features::INDIRECT_FIRST_INSTANCE`] is enabled.
}
sourcepub fn draw_indexed_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: u64
)
pub fn draw_indexed_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: u64 )
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 TrackedRenderPass::set_index_buffer
, while the
active vertex buffers can be set with TrackedRenderPass::set_vertex_buffer
.
The structure expected in indirect_buffer
is the following:
#[repr(C)]
struct DrawIndexedIndirect {
vertex_count: u32, // The number of vertices to draw.
instance_count: u32, // The number of instances to draw.
first_index: u32, // The base index within the index buffer.
vertex_offset: i32, // The value added to the vertex index before indexing into the vertex buffer.
first_instance: u32, // The instance ID of the first instance to draw.
// has to be 0, unless [`Features::INDIRECT_FIRST_INSTANCE`] is enabled.
}
sourcepub fn multi_draw_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: u64,
count: u32
)
pub fn multi_draw_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: u64, count: u32 )
Dispatches multiple draw calls from the active vertex buffer(s) based on the contents of the
indirect_buffer
.count
draw calls are issued.
The active vertex buffers can be set with TrackedRenderPass::set_vertex_buffer
.
indirect_buffer
should contain count
tightly packed elements of the following structure:
#[repr(C)]
struct DrawIndirect {
vertex_count: u32, // The number of vertices to draw.
instance_count: u32, // The number of instances to draw.
first_vertex: u32, // The Index of the first vertex to draw.
first_instance: u32, // The instance ID of the first instance to draw.
// has to be 0, unless [`Features::INDIRECT_FIRST_INSTANCE`] is enabled.
}
sourcepub fn multi_draw_indirect_count(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: u64,
count_buffer: &'a Buffer,
count_offset: u64,
max_count: u32
)
pub fn multi_draw_indirect_count( &mut self, indirect_buffer: &'a Buffer, indirect_offset: u64, count_buffer: &'a Buffer, count_offset: u64, max_count: u32 )
Dispatches multiple draw calls from the active vertex buffer(s) based on the contents of
the indirect_buffer
.
The count buffer is read to determine how many draws to issue.
The indirect buffer must be long enough to account for max_count
draws, however only
count
elements will be read, where count
is the value read from count_buffer
capped
at max_count
.
The active vertex buffers can be set with TrackedRenderPass::set_vertex_buffer
.
indirect_buffer
should contain count
tightly packed elements of the following structure:
#[repr(C)]
struct DrawIndirect {
vertex_count: u32, // The number of vertices to draw.
instance_count: u32, // The number of instances to draw.
first_vertex: u32, // The Index of the first vertex to draw.
first_instance: u32, // The instance ID of the first instance to draw.
// has to be 0, unless [`Features::INDIRECT_FIRST_INSTANCE`] is enabled.
}
sourcepub fn multi_draw_indexed_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: u64,
count: u32
)
pub fn multi_draw_indexed_indirect( &mut self, indirect_buffer: &'a Buffer, indirect_offset: u64, count: u32 )
Dispatches multiple draw calls from the active index buffer and the active vertex buffers,
based on the contents of the indirect_buffer
. count
draw calls are issued.
The active index buffer can be set with TrackedRenderPass::set_index_buffer
, while the
active vertex buffers can be set with TrackedRenderPass::set_vertex_buffer
.
indirect_buffer
should contain count
tightly packed elements of the following structure:
#[repr(C)]
struct DrawIndexedIndirect {
vertex_count: u32, // The number of vertices to draw.
instance_count: u32, // The number of instances to draw.
first_index: u32, // The base index within the index buffer.
vertex_offset: i32, // The value added to the vertex index before indexing into the vertex buffer.
first_instance: u32, // The instance ID of the first instance to draw.
// has to be 0, unless [`Features::INDIRECT_FIRST_INSTANCE`] is enabled.
}
sourcepub fn multi_draw_indexed_indirect_count(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: u64,
count_buffer: &'a Buffer,
count_offset: u64,
max_count: u32
)
pub fn multi_draw_indexed_indirect_count( &mut self, indirect_buffer: &'a Buffer, indirect_offset: u64, count_buffer: &'a Buffer, count_offset: u64, max_count: u32 )
Dispatches multiple draw calls from the active index buffer and the active vertex buffers,
based on the contents of the indirect_buffer
.
The count buffer is read to determine how many draws to issue.
The indirect buffer must be long enough to account for max_count
draws, however only
count
elements will be read, where count
is the value read from count_buffer
capped
at max_count
.
The active index buffer can be set with TrackedRenderPass::set_index_buffer
, while the
active vertex buffers can be set with TrackedRenderPass::set_vertex_buffer
.
indirect_buffer
should contain count
tightly packed elements of the following structure:
#[repr(C)]
struct DrawIndexedIndirect {
vertex_count: u32, // The number of vertices to draw.
instance_count: u32, // The number of instances to draw.
first_index: u32, // The base index within the index buffer.
vertex_offset: i32, // The value added to the vertex index before indexing into the vertex buffer.
first_instance: u32, // The instance ID of the first instance to draw.
// has to be 0, unless [`Features::INDIRECT_FIRST_INSTANCE`] is enabled.
}
sourcepub fn set_stencil_reference(&mut self, reference: u32)
pub fn set_stencil_reference(&mut self, reference: u32)
Sets the stencil reference.
Subsequent stencil tests will test against this value.
sourcepub fn set_scissor_rect(&mut self, x: u32, y: u32, width: u32, height: u32)
pub fn set_scissor_rect(&mut self, x: u32, y: u32, width: u32, height: u32)
Sets the scissor region.
Subsequent draw calls will discard any fragments that fall outside this region.
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.
Features::PUSH_CONSTANTS
must be enabled on the device in order to call these functions.
sourcepub fn set_viewport(
&mut self,
x: f32,
y: f32,
width: f32,
height: f32,
min_depth: f32,
max_depth: f32
)
pub fn set_viewport( &mut self, x: f32, y: f32, width: f32, height: f32, min_depth: f32, max_depth: f32 )
Set the rendering viewport.
Subsequent draw calls will be projected into that viewport.
sourcepub fn set_camera_viewport(&mut self, viewport: &Viewport)
pub fn set_camera_viewport(&mut self, viewport: &Viewport)
Set the rendering viewport to the given camera Viewport
.
Subsequent draw calls will be projected into that viewport.
sourcepub fn insert_debug_marker(&mut self, label: &str)
pub fn insert_debug_marker(&mut self, label: &str)
Insert a single debug marker.
This is a GPU debugging feature. This has no effect on the rendering itself.
sourcepub fn push_debug_group(&mut self, label: &str)
pub fn push_debug_group(&mut self, label: &str)
Start a new debug group.
Push a new debug group over the internal stack. Subsequent render commands and debug
markers are grouped into this new group, until pop_debug_group
is called.
pass.push_debug_group("Render the car");
// [setup pipeline etc...]
pass.draw(0..64, 0..1);
pass.pop_debug_group();
Note that push_debug_group
and pop_debug_group
must always be called in pairs.
This is a GPU debugging feature. This has no effect on the rendering itself.
sourcepub fn pop_debug_group(&mut self)
pub fn pop_debug_group(&mut self)
End the current debug group.
Subsequent render commands and debug markers are not grouped anymore in this group, but in the previous one (if any) or the default top-level one if the debug group was the last one on the stack.
Note that push_debug_group
and pop_debug_group
must always be called in pairs.
This is a GPU debugging feature. This has no effect on the rendering itself.
sourcepub fn set_blend_constant(&mut self, color: LinearRgba)
pub fn set_blend_constant(&mut self, color: LinearRgba)
Sets the blend color as used by some of the blending modes.
Subsequent blending tests will test against this value.
Auto Trait Implementations§
impl<'a> Freeze for TrackedRenderPass<'a>
impl<'a> !RefUnwindSafe for TrackedRenderPass<'a>
impl<'a> Send for TrackedRenderPass<'a>
impl<'a> Sync for TrackedRenderPass<'a>
impl<'a> Unpin for TrackedRenderPass<'a>
impl<'a> !UnwindSafe for TrackedRenderPass<'a>
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.