Struct ArgumentEncoder 

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

An encoder for encoding resources into argument buffers.

C++ equivalent: MTL::ArgumentEncoder

Implementations

impl ArgumentEncoder

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

Create from a raw pointer.

Safety

The pointer must be a valid Metal ArgumentEncoder.

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

Get the raw pointer.

pub fn alignment(&self) -> UInteger

Get the alignment of the encoded data.

C++ equivalent: NS::UInteger alignment() const

pub fn constant_data(&self, index: UInteger) -> *mut c_void

Get a pointer to the constant data at the given index.

C++ equivalent: void* constantData(NS::UInteger index)

pub fn device(&self) -> Device

Get the device that created this encoder.

C++ equivalent: Device* device() const

pub fn encoded_length(&self) -> UInteger

Get the encoded length in bytes.

C++ equivalent: NS::UInteger encodedLength() const

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

Get the label.

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

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

Set the label.

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

pub fn new_argument_encoder(&self, index: UInteger) -> Option<ArgumentEncoder>

Create a new argument encoder for a nested buffer at the given index.

C++ equivalent: ArgumentEncoder* newArgumentEncoder(NS::UInteger index)

pub fn set_argument_buffer(&self, buffer: &Buffer, offset: UInteger)

Set the argument buffer to encode into.

C++ equivalent: void setArgumentBuffer(const MTL::Buffer* argumentBuffer, NS::UInteger offset)

pub fn set_argument_buffer_with_array_element( &self, buffer: &Buffer, start_offset: UInteger, array_element: UInteger, )

Set the argument buffer with array element.

C++ equivalent: void setArgumentBuffer(const MTL::Buffer*, NS::UInteger, NS::UInteger)

pub fn set_buffer(&self, buffer: &Buffer, offset: UInteger, index: UInteger)

Set a buffer at the given index.

C++ equivalent: void setBuffer(const MTL::Buffer*, NS::UInteger, NS::UInteger)

pub fn set_texture(&self, texture: &Texture, index: UInteger)

Set a texture at the given index.

C++ equivalent: void setTexture(const MTL::Texture*, NS::UInteger)

pub fn set_sampler_state(&self, sampler: &SamplerState, index: UInteger)

Set a sampler state at the given index.

C++ equivalent: void setSamplerState(const MTL::SamplerState*, NS::UInteger)

pub fn set_render_pipeline_state( &self, pipeline: &RenderPipelineState, index: UInteger, )

Set a render pipeline state at the given index.

C++ equivalent: void setRenderPipelineState(const MTL::RenderPipelineState*, NS::UInteger)

pub fn set_compute_pipeline_state( &self, pipeline: &ComputePipelineState, index: UInteger, )

Set a compute pipeline state at the given index.

C++ equivalent: void setComputePipelineState(const MTL::ComputePipelineState*, NS::UInteger)

pub fn set_depth_stencil_state( &self, state: &DepthStencilState, index: UInteger, )

Set a depth stencil state at the given index.

C++ equivalent: void setDepthStencilState(const MTL::DepthStencilState*, NS::UInteger)

pub fn set_acceleration_structure( &self, acceleration_structure: &AccelerationStructure, index: UInteger, )

Set an acceleration structure at the given index.

C++ equivalent: void setAccelerationStructure(const MTL::AccelerationStructure*, NS::UInteger)

pub fn set_indirect_command_buffer_ptr( &self, buffer: *const c_void, index: UInteger, )

Set an indirect command buffer at the given index.

C++ equivalent: void setIndirectCommandBuffer(const MTL::IndirectCommandBuffer*, NS::UInteger)

pub fn set_visible_function_table_ptr( &self, table: *const c_void, index: UInteger, )

Set a visible function table at the given index.

C++ equivalent: void setVisibleFunctionTable(const MTL::VisibleFunctionTable*, NS::UInteger)

pub fn set_intersection_function_table_ptr( &self, table: *const c_void, index: UInteger, )

Set an intersection function table at the given index.

C++ equivalent: void setIntersectionFunctionTable(const MTL::IntersectionFunctionTable*, NS::UInteger)

Trait Implementations

impl Clone for ArgumentEncoder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for ArgumentEncoder

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for ArgumentEncoder

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 ArgumentEncoder

impl Sync for ArgumentEncoder