Struct bevy::render::render_resource::CommandEncoder
[−]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.
Implementations
impl CommandEncoder
impl CommandEncoder
pub fn finish(self) -> CommandBuffer
pub fn finish(self) -> CommandBuffer
Finishes recording and returns a [CommandBuffer
] that can be submitted for execution.
pub fn begin_render_pass(
&'a mut self,
desc: &RenderPassDescriptor<'a, '_>
) -> RenderPass<'a>
pub fn begin_render_pass(
&'a mut self,
desc: &RenderPassDescriptor<'a, '_>
) -> RenderPass<'a>
Begins recording of a render pass.
This function returns a [RenderPass
] object which records a single render pass.
pub 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.
pub 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.
pub 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.
Panics
- Copy would overrun buffer.
- Copy would overrun texture.
source.layout.bytes_per_row
isn’t divisible by [COPY_BYTES_PER_ROW_ALIGNMENT
].
pub 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.
Panics
- Copy would overrun buffer.
- Copy would overrun texture.
source.layout.bytes_per_row
isn’t divisible by [COPY_BYTES_PER_ROW_ALIGNMENT
].
pub 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
pub 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.
Where possible it may be significantly more efficient to perform clears via render passes!
Panics
CLEAR_COMMANDS
extension not enabled- Texture does not have
COPY_DST
usage. - Range is out of bounds
pub fn clear_buffer(
&mut self,
buffer: &Buffer,
offset: u64,
size: Option<NonZeroU64>
)
pub fn clear_buffer(
&mut self,
buffer: &Buffer,
offset: u64,
size: Option<NonZeroU64>
)
pub fn insert_debug_marker(&mut self, label: &str)
pub fn insert_debug_marker(&mut self, label: &str)
Inserts debug marker.
pub 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.
pub fn pop_debug_group(&mut self)
pub fn pop_debug_group(&mut self)
Stops command recording and creates debug group.
impl CommandEncoder
impl CommandEncoder
Features::TIMESTAMP_QUERY
must be enabled on the device in order to call these functions.
pub 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.
impl CommandEncoder
impl CommandEncoder
Features::TIMESTAMP_QUERY
or Features::PIPELINE_STATISTICS_QUERY
must be enabled on the device in order to call these functions.
pub 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
)
Resolve a query set, writing the results into the supplied destination buffer.
Queries may be between 8 and 40 bytes each. See [PipelineStatisticsTypes
] for more information.
Trait Implementations
impl Debug for CommandEncoder
impl Debug for CommandEncoder
impl Drop for CommandEncoder
impl Drop for CommandEncoder
Auto Trait Implementations
impl !RefUnwindSafe for CommandEncoder
impl Send for CommandEncoder
impl Sync for CommandEncoder
impl Unpin for CommandEncoder
impl !UnwindSafe for CommandEncoder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<I, A>impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<I, A>impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
Convert 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
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more