Struct ResourceStateCommandEncoder 

pub struct ResourceStateCommandEncoder(/* private fields */);

A command encoder for resource state operations.

C++ equivalent: MTL::ResourceStateCommandEncoder

Resource state encoders are used to update sparse texture mappings and manage resource state for sparse resources.

Implementations

impl ResourceStateCommandEncoder

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a ResourceStateCommandEncoder from a raw pointer.

Safety

The pointer must be a valid Metal resource state command encoder object.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer to the encoder.

pub fn device(&self) -> Device

Get the device that created this encoder.

C++ equivalent: Device* device() const

pub fn command_buffer(&self) -> CommandBuffer

Get the command buffer that this encoder is encoding into.

C++ equivalent: CommandBuffer* commandBuffer() const

pub fn label(&self) -> Option<String>

Get the label for this encoder.

C++ equivalent: NS::String* label() const

pub fn set_label(&self, label: &str)

Set the label for this encoder.

C++ equivalent: void setLabel(const NS::String*)

pub fn end_encoding(&self)

End encoding commands with this encoder.

C++ equivalent: void endEncoding()

pub fn insert_debug_signpost(&self, string: &str)

Insert a debug signpost.

C++ equivalent: void insertDebugSignpost(const NS::String*)

pub fn push_debug_group(&self, string: &str)

Push a debug group.

C++ equivalent: void pushDebugGroup(const NS::String*)

pub fn pop_debug_group(&self)

Pop the current debug group.

C++ equivalent: void popDebugGroup()

pub fn barrier_after_queue_stages( &self, after_stages: Stages, before_stages: Stages, )

Insert a barrier to synchronize queue stages.

C++ equivalent: void barrierAfterQueueStages(Stages, Stages)

pub fn update_texture_mapping( &self, texture: &Texture, mode: SparseTextureMappingMode, region: Region, mip_level: UInteger, slice: UInteger, )

Update sparse texture mapping for a region.

C++ equivalent: void updateTextureMapping(const Texture*, SparseTextureMappingMode, Region, NS::UInteger, NS::UInteger)

pub fn update_texture_mapping_indirect( &self, texture: &Texture, mode: SparseTextureMappingMode, indirect_buffer: &Buffer, indirect_buffer_offset: UInteger, )

Update sparse texture mapping using indirect arguments from a buffer.

C++ equivalent: void updateTextureMapping(const Texture*, SparseTextureMappingMode, const Buffer*, NS::UInteger)

pub unsafe fn update_texture_mappings( &self, texture: &Texture, mode: SparseTextureMappingMode, regions: *const Region, mip_levels: *const UInteger, slices: *const UInteger, num_regions: UInteger, )

Update sparse texture mappings for multiple regions.

C++ equivalent: void updateTextureMappings(const Texture*, SparseTextureMappingMode, const Region*, const NS::UInteger*, const NS::UInteger*, NS::UInteger)

Safety

The regions, mip_levels, and slices arrays must have at least num_regions elements.

pub fn move_texture_mappings_from_texture( &self, source_texture: &Texture, source_slice: UInteger, source_level: UInteger, source_origin: Origin, source_size: Size, destination_texture: &Texture, destination_slice: UInteger, destination_level: UInteger, destination_origin: Origin, )

Move texture mappings from one texture to another.

C++ equivalent: void moveTextureMappingsFromTexture(...)

pub fn update_fence(&self, fence: &Fence)

Update a fence.

C++ equivalent: void updateFence(const Fence*)

pub fn wait_for_fence(&self, fence: &Fence)

Wait for a fence.

C++ equivalent: void waitForFence(const Fence*)

Trait Implementations

impl Clone for ResourceStateCommandEncoder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResourceStateCommandEncoder

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

Formats the value using the given formatter.

impl Drop for ResourceStateCommandEncoder

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for ResourceStateCommandEncoder

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for ResourceStateCommandEncoder

impl Sync for ResourceStateCommandEncoder