Struct MetalRenderCommandEncoder 

pub struct MetalRenderCommandEncoder { /* private fields */ }

A render command encoder

Dropping the final retained handle ends encoding automatically so the parent command buffer cannot be left permanently uncommittable.

Implementations

impl MetalRenderCommandEncoder

pub fn set_render_pipeline_state( &self, pipeline: &MetalRenderPipelineState, ) -> Result<(), MetalError>

Set the render pipeline state

Errors

Returns an error after encoding has ended.

pub fn set_vertex_buffer( &self, buffer: &MetalBuffer, offset: usize, index: usize, ) -> Result<(), MetalError>

Set a vertex buffer

Errors

Returns an error after encoding has ended or for an invalid offset or buffer binding index.

pub fn set_fragment_buffer( &self, buffer: &MetalBuffer, offset: usize, index: usize, ) -> Result<(), MetalError>

Set a fragment buffer

Errors

Returns an error after encoding has ended or for an invalid offset or buffer binding index.

pub fn set_fragment_texture( &self, texture: &MetalTexture, index: usize, ) -> Result<(), MetalError>

Set a fragment texture

Errors

Returns an error after encoding has ended or for an invalid texture binding index.

pub fn draw_primitives( &self, primitive_type: MTLPrimitiveType, vertex_start: usize, vertex_count: usize, ) -> Result<(), MetalError>

Draw primitives

Errors

Returns an error after encoding has ended or when the vertex range cannot be represented by Swift’s Int.

pub fn end_encoding(&self) -> Result<(), MetalError>

End encoding

Errors

Returns an error if encoding already ended through this handle or one of its retained clones.

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

Get the raw pointer

Trait Implementations

impl Clone for MetalRenderCommandEncoder

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 MetalRenderCommandEncoder

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

Formats the value using the given formatter.

impl Drop for MetalRenderCommandEncoder

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.