Struct ComputeCommandEncoderRef 

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

A borrowed reference to a ComputeCommandEncoder.

Implementations

impl ComputeCommandEncoderRef

pub fn set_compute_pipeline_state(&self, state: &ComputePipelineStateRef)

pub fn set_buffer( &self, index: NSUInteger, buffer: Option<&BufferRef>, offset: NSUInteger, )

pub fn set_buffers( &self, start_index: NSUInteger, data: &[Option<&BufferRef>], offsets: &[NSUInteger], )

pub fn set_texture(&self, index: NSUInteger, texture: Option<&TextureRef>)

pub fn set_textures( &self, start_index: NSUInteger, data: &[Option<&TextureRef>], )

pub fn set_sampler_state( &self, index: NSUInteger, sampler: Option<&SamplerStateRef>, )

pub fn set_sampler_states( &self, start_index: NSUInteger, data: &[Option<&SamplerStateRef>], )

pub fn set_sampler_state_with_lod( &self, index: NSUInteger, sampler: Option<&SamplerStateRef>, lod_clamp: Range<f32>, )

pub fn set_bytes( &self, index: NSUInteger, length: NSUInteger, bytes: *const c_void, )

pub fn set_visible_function_table( &self, buffer_index: NSUInteger, visible_function_table: Option<&VisibleFunctionTableRef>, )

pub fn set_visible_function_tables( &self, buffer_start_index: NSUInteger, visible_function_tables: &[&VisibleFunctionTableRef], )

pub fn dispatch_thread_groups( &self, thread_groups_count: MTLSize, threads_per_threadgroup: MTLSize, )

pub fn dispatch_threads( &self, threads_per_grid: MTLSize, threads_per_thread_group: MTLSize, )

pub fn dispatch_thread_groups_indirect( &self, buffer: &BufferRef, offset: NSUInteger, threads_per_threadgroup: MTLSize, )

pub fn set_threadgroup_memory_length( &self, at_index: NSUInteger, size: NSUInteger, )

pub fn memory_barrier_with_resources(&self, resources: &[&ResourceRef])

Encodes a barrier so that changes to a set of resources made by commands encoded before the barrier are completed before further commands are executed.

Availability: iOS 12.0+, macOS 10.14+

Arguments

• resources: A slice of resources.

pub fn use_resource(&self, resource: &ResourceRef, usage: MTLResourceUsage)

Specifies that a resource in an argument buffer can be safely used by a compute pass.

Availability: iOS 11.0+, macOS 10.13+

Arguments

• resource: A specific resource within an argument buffer.
• usage: The options that describe how the resource will be used by a compute function.

pub fn use_resources(&self, resources: &[&ResourceRef], usage: MTLResourceUsage)

Specifies that an array of resources in an argument buffer can be safely used by a compute pass.

Availability: iOS 11.0+, macOS 10.13+

See https://developer.apple.com/documentation/metal/mtlcomputecommandencoder/2866561-useresources

Arguments

• resources: A slice of resources within an argument buffer.
• usage: The options that describe how the array of resources will be used by a compute function.

pub fn use_heap(&self, heap: &HeapRef)

Specifies that a heap containing resources in an argument buffer can be safely used by a compute pass.

Availability: iOS 11.0+, macOS 10.13+

See https://developer.apple.com/documentation/metal/mtlcomputecommandencoder/2866530-useheap

Arguments

• heap: A heap that contains resources within an argument buffer.

pub fn use_heaps(&self, heaps: &[&HeapRef])

Specifies that an array of heaps containing resources in an argument buffer can be safely used by a compute pass.

Availability: iOS 11.0+, macOS 10.13+

Arguments

• heaps: A slice of heaps that contains resources within an argument buffer.

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

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

pub fn set_acceleration_structure( &self, index: NSUInteger, accel: Option<&AccelerationStructureRef>, )

Only available in (macos(11.0), ios(14.0))

pub fn set_intersection_function_table( &self, index: NSUInteger, table: Option<&IntersectionFunctionTableRef>, )

Only available in (macos(11.0), ios(14.0))

pub fn sample_counters_in_buffer( &self, sample_buffer: &CounterSampleBufferRef, sample_index: NSUInteger, with_barrier: bool, )

See: https://developer.apple.com/documentation/metal/mtlcomputecommandencoder/3194349-samplecountersinbuffer

Methods from Deref<Target = CommandEncoderRef>

pub fn label(&self) -> &str

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

pub fn end_encoding(&self)

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

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

pub fn pop_debug_group(&self)

Trait Implementations

impl AsMut<ComputeCommandEncoderRef> for ComputeCommandEncoder

fn as_mut(&mut self) -> &mut ComputeCommandEncoderRef

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<ComputeCommandEncoderRef> for ComputeCommandEncoder

fn as_ref(&self) -> &ComputeCommandEncoderRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<ComputeCommandEncoderRef> for ComputeCommandEncoder

fn borrow(&self) -> &ComputeCommandEncoderRef

Immutably borrows from an owned value.

impl BorrowMut<ComputeCommandEncoderRef> for ComputeCommandEncoder

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

Mutably borrows from an owned value.

impl Debug for ComputeCommandEncoderRef

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

Formats the value using the given formatter.

impl Deref for ComputeCommandEncoderRef

type Target = CommandEncoderRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl ForeignTypeRef for ComputeCommandEncoderRef

type CType = MTLComputeCommandEncoder

The raw C type.

unsafe fn from_ptr<'a>(ptr: *mut Self::CType) -> &'a Self

Constructs a shared instance of this type from its raw type.

unsafe fn from_ptr_mut<'a>(ptr: *mut Self::CType) -> &'a mut Self

Constructs a mutable reference of this type from its raw type.

fn as_ptr(&self) -> *mut Self::CType

Returns a raw pointer to the wrapped value.

impl Message for ComputeCommandEncoderRef

unsafe fn send_message<A, R>( &self, sel: Sel, args: A, ) -> Result<R, MessageError>

where Self: Sized, A: MessageArguments, R: Any,

Sends a message to self with the given selector and arguments.

fn verify_message<A, R>(&self, sel: Sel) -> Result<(), MessageError>

where Self: Sized, A: EncodeArguments, R: Encode,

Verifies that the argument and return types match the encoding of the method for the given selector.

impl Send for ComputeCommandEncoderRef

impl Sync for ComputeCommandEncoderRef

impl ToOwned for ComputeCommandEncoderRef

type Owned = ComputeCommandEncoder

The resulting type after obtaining ownership.

fn to_owned(&self) -> ComputeCommandEncoder

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.