Struct ParallelRenderCommandEncoder 

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

A command encoder that creates multiple render command encoders that render in parallel.

C++ equivalent: MTL::ParallelRenderCommandEncoder

Parallel render encoders allow you to split rendering work across multiple render command encoders that can execute concurrently on the GPU.

Implementations

impl ParallelRenderCommandEncoder

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

Create a ParallelRenderCommandEncoder from a raw pointer.

Safety

The pointer must be a valid Metal parallel render 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 render_command_encoder(&self) -> Option<RenderCommandEncoder>

Create a new render command encoder that renders in parallel.

C++ equivalent: RenderCommandEncoder* renderCommandEncoder()

Each call creates a new render encoder that shares the render pass with other encoders created from this parallel encoder.

pub fn set_color_store_action( &self, store_action: StoreAction, color_attachment_index: UInteger, )

Set the store action for a color attachment.

C++ equivalent: void setColorStoreAction(StoreAction, NS::UInteger)

pub fn set_color_store_action_options( &self, store_action_options: StoreActionOptions, color_attachment_index: UInteger, )

Set the store action options for a color attachment.

C++ equivalent: void setColorStoreActionOptions(StoreActionOptions, NS::UInteger)

pub fn set_depth_store_action(&self, store_action: StoreAction)

Set the store action for the depth attachment.

C++ equivalent: void setDepthStoreAction(StoreAction)

pub fn set_depth_store_action_options( &self, store_action_options: StoreActionOptions, )

Set the store action options for the depth attachment.

C++ equivalent: void setDepthStoreActionOptions(StoreActionOptions)

pub fn set_stencil_store_action(&self, store_action: StoreAction)

Set the store action for the stencil attachment.

C++ equivalent: void setStencilStoreAction(StoreAction)

pub fn set_stencil_store_action_options( &self, store_action_options: StoreActionOptions, )

Set the store action options for the stencil attachment.

C++ equivalent: void setStencilStoreActionOptions(StoreActionOptions)

Trait Implementations

impl Clone for ParallelRenderCommandEncoder

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 ParallelRenderCommandEncoder

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

Formats the value using the given formatter.

impl Drop for ParallelRenderCommandEncoder

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for ParallelRenderCommandEncoder

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 ParallelRenderCommandEncoder

impl Sync for ParallelRenderCommandEncoder