Struct bevy_render::render_resource::CommandEncoder
source · pub struct CommandEncoder { /* private fields */ }
Expand description
Encodes a series of GPU operations.
A command encoder can record RenderPass
es, ComputePass
es,
and transfer operations between driver-managed resources like Buffer
s and Texture
s.
When finished recording, call CommandEncoder::finish
to obtain a CommandBuffer
which may
be submitted for execution.
Corresponds to WebGPU GPUCommandEncoder
.
Implementations§
source§impl CommandEncoder
impl CommandEncoder
sourcepub fn finish(self) -> CommandBuffer
pub fn finish(self) -> CommandBuffer
Finishes recording and returns a CommandBuffer
that can be submitted for execution.
sourcepub fn begin_render_pass<'pass>(
&'pass mut self,
desc: &RenderPassDescriptor<'pass, '_>
) -> RenderPass<'pass>
pub fn begin_render_pass<'pass>( &'pass mut self, desc: &RenderPassDescriptor<'pass, '_> ) -> RenderPass<'pass>
Begins recording of a render pass.
This function returns a RenderPass
object which records a single render pass.
sourcepub fn begin_compute_pass(
&mut self,
desc: &ComputePassDescriptor<'_>
) -> ComputePass<'_>
pub fn begin_compute_pass( &mut self, desc: &ComputePassDescriptor<'_> ) -> ComputePass<'_>
Begins recording of a compute pass.
This function returns a ComputePass
object which records a single compute pass.
sourcepub fn copy_buffer_to_buffer(
&mut self,
source: &Buffer,
source_offset: u64,
destination: &Buffer,
destination_offset: u64,
copy_size: u64
)
pub fn copy_buffer_to_buffer( &mut self, source: &Buffer, source_offset: u64, destination: &Buffer, destination_offset: u64, copy_size: u64 )
Copy data from one buffer to another.
§Panics
- Buffer offsets or copy size not a multiple of
COPY_BUFFER_ALIGNMENT
. - Copy would overrun buffer.
- Copy within the same buffer.
sourcepub fn copy_buffer_to_texture(
&mut self,
source: ImageCopyBuffer<&Buffer>,
destination: ImageCopyTexture<&Texture>,
copy_size: Extent3d
)
pub fn copy_buffer_to_texture( &mut self, source: ImageCopyBuffer<&Buffer>, destination: ImageCopyTexture<&Texture>, copy_size: Extent3d )
Copy data from a buffer to a texture.
sourcepub fn copy_texture_to_buffer(
&mut self,
source: ImageCopyTexture<&Texture>,
destination: ImageCopyBuffer<&Buffer>,
copy_size: Extent3d
)
pub fn copy_texture_to_buffer( &mut self, source: ImageCopyTexture<&Texture>, destination: ImageCopyBuffer<&Buffer>, copy_size: Extent3d )
Copy data from a texture to a buffer.
sourcepub fn copy_texture_to_texture(
&mut self,
source: ImageCopyTexture<&Texture>,
destination: ImageCopyTexture<&Texture>,
copy_size: Extent3d
)
pub fn copy_texture_to_texture( &mut self, source: ImageCopyTexture<&Texture>, destination: ImageCopyTexture<&Texture>, copy_size: Extent3d )
Copy data from one texture to another.
§Panics
- Textures are not the same type
- If a depth texture, or a multisampled texture, the entire texture must be copied
- Copy would overrun either texture
sourcepub fn clear_texture(
&mut self,
texture: &Texture,
subresource_range: &ImageSubresourceRange
)
pub fn clear_texture( &mut self, texture: &Texture, subresource_range: &ImageSubresourceRange )
Clears texture to zero.
Note that unlike with clear_buffer, COPY_DST
usage is not required.
§Implementation notes
- implemented either via buffer copies and render/depth target clear, path depends on texture usages
- behaves like texture zero init, but is performed immediately (clearing is not delayed via marking it as uninitialized)
§Panics
CLEAR_TEXTURE
extension not enabled- Range is out of bounds
sourcepub fn insert_debug_marker(&mut self, label: &str)
pub fn insert_debug_marker(&mut self, label: &str)
Inserts debug marker.
sourcepub fn push_debug_group(&mut self, label: &str)
pub fn push_debug_group(&mut self, label: &str)
Start record commands and group it into debug marker group.
sourcepub fn pop_debug_group(&mut self)
pub fn pop_debug_group(&mut self)
Stops command recording and creates debug group.
sourcepub fn resolve_query_set(
&mut self,
query_set: &QuerySet,
query_range: Range<u32>,
destination: &Buffer,
destination_offset: u64
)
pub fn resolve_query_set( &mut self, query_set: &QuerySet, query_range: Range<u32>, destination: &Buffer, destination_offset: u64 )
Resolves a query set, writing the results into the supplied destination buffer.
Occlusion and timestamp queries are 8 bytes each (see crate::QUERY_SIZE
). For pipeline statistics queries,
see PipelineStatisticsTypes
for more information.
sourcepub unsafe fn as_hal_mut<A, F, R>(
&mut self,
hal_command_encoder_callback: F
) -> Option<R>
pub unsafe fn as_hal_mut<A, F, R>( &mut self, hal_command_encoder_callback: F ) -> Option<R>
Returns the inner hal CommandEncoder using a callback. The hal command encoder will be None
if the
backend type argument does not match with this wgpu CommandEncoder
This method will start the wgpu_core level command recording.
§Safety
- The raw handle obtained from the hal CommandEncoder must not be manually destroyed
source§impl CommandEncoder
impl CommandEncoder
Features::TIMESTAMP_QUERY_INSIDE_ENCODERS
must be enabled on the device in order to call these functions.
sourcepub fn write_timestamp(&mut self, query_set: &QuerySet, query_index: u32)
pub fn write_timestamp(&mut self, query_set: &QuerySet, query_index: u32)
Issue a timestamp command at this point in the queue. The timestamp will be written to the specified query set, at the specified index.
Must be multiplied by Queue::get_timestamp_period
to get
the value in nanoseconds. Absolute values have no meaning,
but timestamps can be subtracted to get the time it takes
for a string of operations to complete.
Attention: Since commands within a command recorder may be reordered, there is no strict guarantee that timestamps are taken after all commands recorded so far and all before all commands recorded after. This may depend both on the backend and the driver.
Trait Implementations§
source§impl Debug for CommandEncoder
impl Debug for CommandEncoder
Auto Trait Implementations§
impl Freeze for CommandEncoder
impl !RefUnwindSafe for CommandEncoder
impl Send for CommandEncoder
impl Sync for CommandEncoder
impl Unpin for CommandEncoder
impl !UnwindSafe for CommandEncoder
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.