Struct wgpu::CommandEncoder

source ·
pub struct CommandEncoder { /* private fields */ }
Expand description

Encodes a series of GPU operations.

A command encoder can record RenderPasses, ComputePasses, and transfer operations between driver-managed resources like Buffers and Textures.

When finished recording, call CommandEncoder::finish to obtain a CommandBuffer which may be submitted for execution.

Corresponds to WebGPU GPUCommandEncoder.

Implementations§

source§

impl CommandEncoder

source

pub fn finish(self) -> CommandBuffer

Finishes recording and returns a CommandBuffer that can be submitted for execution.

source

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.

source

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.

source

pub fn copy_buffer_to_buffer( &mut self, source: &Buffer, source_offset: BufferAddress, destination: &Buffer, destination_offset: BufferAddress, copy_size: BufferAddress )

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.
source

pub fn copy_buffer_to_texture( &mut self, source: ImageCopyBuffer<'_>, destination: ImageCopyTexture<'_>, copy_size: Extent3d )

Copy data from a buffer to a texture.

source

pub fn copy_texture_to_buffer( &mut self, source: ImageCopyTexture<'_>, destination: ImageCopyBuffer<'_>, copy_size: Extent3d )

Copy data from a texture to a buffer.

source

pub fn copy_texture_to_texture( &mut self, source: ImageCopyTexture<'_>, destination: ImageCopyTexture<'_>, 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
source

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
source

pub fn clear_buffer( &mut self, buffer: &Buffer, offset: BufferAddress, size: Option<BufferAddress> )

Clears buffer to zero.

Panics
  • Buffer does not have COPY_DST usage.
  • Range it out of bounds
source

pub fn insert_debug_marker(&mut self, label: &str)

Inserts debug marker.

source

pub fn push_debug_group(&mut self, label: &str)

Start record commands and group it into debug marker group.

source

pub fn pop_debug_group(&mut self)

Stops command recording and creates debug group.

source

pub fn resolve_query_set( &mut self, query_set: &QuerySet, query_range: Range<u32>, destination: &Buffer, destination_offset: BufferAddress )

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.

source§

impl CommandEncoder

Features::TIMESTAMP_QUERY must be enabled on the device in order to call these functions.

source

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.

Trait Implementations§

source§

impl Debug for CommandEncoder

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for CommandEncoder

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,