Skip to main content

IndirectCommandBufferDescriptor

Struct IndirectCommandBufferDescriptor 

Source
pub struct IndirectCommandBufferDescriptor(/* private fields */);
Expand description

Descriptor for creating an indirect command buffer.

C++ equivalent: MTL::IndirectCommandBufferDescriptor

Implementations§

Source§

impl IndirectCommandBufferDescriptor

Source

pub fn alloc() -> Option<Self>

Allocate a new indirect command buffer descriptor.

C++ equivalent: static IndirectCommandBufferDescriptor* alloc()

Source

pub fn init(&self) -> Option<Self>

Initialize an allocated descriptor.

C++ equivalent: IndirectCommandBufferDescriptor* init()

Source

pub fn new() -> Option<Self>

Create a new indirect command buffer descriptor.

Source

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

Create from a raw pointer.

§Safety

The pointer must be a valid Metal indirect command buffer descriptor.

Source

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

Get the raw pointer.

Source

pub fn command_types(&self) -> IndirectCommandType

Get the command types that can be encoded.

C++ equivalent: IndirectCommandType commandTypes() const

Source

pub fn set_command_types(&self, types: IndirectCommandType)

Set the command types that can be encoded.

C++ equivalent: void setCommandTypes(IndirectCommandType)

Source

pub fn inherit_buffers(&self) -> bool

Get whether commands inherit buffers from the encoder.

C++ equivalent: bool inheritBuffers() const

Source

pub fn set_inherit_buffers(&self, inherit: bool)

Set whether commands inherit buffers from the encoder.

C++ equivalent: void setInheritBuffers(bool)

Source

pub fn inherit_cull_mode(&self) -> bool

Get whether commands inherit cull mode from the encoder.

C++ equivalent: bool inheritCullMode() const

Source

pub fn set_inherit_cull_mode(&self, inherit: bool)

Set whether commands inherit cull mode from the encoder.

C++ equivalent: void setInheritCullMode(bool)

Source

pub fn inherit_depth_bias(&self) -> bool

Get whether commands inherit depth bias from the encoder.

C++ equivalent: bool inheritDepthBias() const

Source

pub fn set_inherit_depth_bias(&self, inherit: bool)

Set whether commands inherit depth bias from the encoder.

C++ equivalent: void setInheritDepthBias(bool)

Source

pub fn inherit_depth_clip_mode(&self) -> bool

Get whether commands inherit depth clip mode from the encoder.

C++ equivalent: bool inheritDepthClipMode() const

Source

pub fn set_inherit_depth_clip_mode(&self, inherit: bool)

Set whether commands inherit depth clip mode from the encoder.

C++ equivalent: void setInheritDepthClipMode(bool)

Source

pub fn inherit_depth_stencil_state(&self) -> bool

Get whether commands inherit depth stencil state from the encoder.

C++ equivalent: bool inheritDepthStencilState() const

Source

pub fn set_inherit_depth_stencil_state(&self, inherit: bool)

Set whether commands inherit depth stencil state from the encoder.

C++ equivalent: void setInheritDepthStencilState(bool)

Source

pub fn inherit_front_facing_winding(&self) -> bool

Get whether commands inherit front facing winding from the encoder.

C++ equivalent: bool inheritFrontFacingWinding() const

Source

pub fn set_inherit_front_facing_winding(&self, inherit: bool)

Set whether commands inherit front facing winding from the encoder.

C++ equivalent: void setInheritFrontFacingWinding(bool)

Source

pub fn inherit_pipeline_state(&self) -> bool

Get whether commands inherit pipeline state from the encoder.

C++ equivalent: bool inheritPipelineState() const

Source

pub fn set_inherit_pipeline_state(&self, inherit: bool)

Set whether commands inherit pipeline state from the encoder.

C++ equivalent: void setInheritPipelineState(bool)

Source

pub fn inherit_triangle_fill_mode(&self) -> bool

Get whether commands inherit triangle fill mode from the encoder.

C++ equivalent: bool inheritTriangleFillMode() const

Source

pub fn set_inherit_triangle_fill_mode(&self, inherit: bool)

Set whether commands inherit triangle fill mode from the encoder.

C++ equivalent: void setInheritTriangleFillMode(bool)

Source

pub fn max_vertex_buffer_bind_count(&self) -> UInteger

Get the maximum number of vertex buffer bindings.

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

Source

pub fn set_max_vertex_buffer_bind_count(&self, count: UInteger)

Set the maximum number of vertex buffer bindings.

C++ equivalent: void setMaxVertexBufferBindCount(NS::UInteger)

Source

pub fn max_fragment_buffer_bind_count(&self) -> UInteger

Get the maximum number of fragment buffer bindings.

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

Source

pub fn set_max_fragment_buffer_bind_count(&self, count: UInteger)

Set the maximum number of fragment buffer bindings.

C++ equivalent: void setMaxFragmentBufferBindCount(NS::UInteger)

Source

pub fn max_kernel_buffer_bind_count(&self) -> UInteger

Get the maximum number of kernel buffer bindings.

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

Source

pub fn set_max_kernel_buffer_bind_count(&self, count: UInteger)

Set the maximum number of kernel buffer bindings.

C++ equivalent: void setMaxKernelBufferBindCount(NS::UInteger)

Source

pub fn max_kernel_threadgroup_memory_bind_count(&self) -> UInteger

Get the maximum number of kernel threadgroup memory bindings.

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

Source

pub fn set_max_kernel_threadgroup_memory_bind_count(&self, count: UInteger)

Set the maximum number of kernel threadgroup memory bindings.

C++ equivalent: void setMaxKernelThreadgroupMemoryBindCount(NS::UInteger)

Source

pub fn max_mesh_buffer_bind_count(&self) -> UInteger

Get the maximum number of mesh buffer bindings.

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

Source

pub fn set_max_mesh_buffer_bind_count(&self, count: UInteger)

Set the maximum number of mesh buffer bindings.

C++ equivalent: void setMaxMeshBufferBindCount(NS::UInteger)

Source

pub fn max_object_buffer_bind_count(&self) -> UInteger

Get the maximum number of object buffer bindings.

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

Source

pub fn set_max_object_buffer_bind_count(&self, count: UInteger)

Set the maximum number of object buffer bindings.

C++ equivalent: void setMaxObjectBufferBindCount(NS::UInteger)

Source

pub fn max_object_threadgroup_memory_bind_count(&self) -> UInteger

Get the maximum number of object threadgroup memory bindings.

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

Source

pub fn set_max_object_threadgroup_memory_bind_count(&self, count: UInteger)

Set the maximum number of object threadgroup memory bindings.

C++ equivalent: void setMaxObjectThreadgroupMemoryBindCount(NS::UInteger)

Source

pub fn support_color_attachment_mapping(&self) -> bool

Get whether color attachment mapping is supported.

C++ equivalent: bool supportColorAttachmentMapping() const

Source

pub fn set_support_color_attachment_mapping(&self, support: bool)

Set whether color attachment mapping is supported.

C++ equivalent: void setSupportColorAttachmentMapping(bool)

Source

pub fn support_dynamic_attribute_stride(&self) -> bool

Get whether dynamic attribute stride is supported.

C++ equivalent: bool supportDynamicAttributeStride() const

Source

pub fn set_support_dynamic_attribute_stride(&self, support: bool)

Set whether dynamic attribute stride is supported.

C++ equivalent: void setSupportDynamicAttributeStride(bool)

Source

pub fn support_ray_tracing(&self) -> bool

Get whether ray tracing is supported.

C++ equivalent: bool supportRayTracing() const

Source

pub fn set_support_ray_tracing(&self, support: bool)

Set whether ray tracing is supported.

C++ equivalent: void setSupportRayTracing(bool)

Trait Implementations§

Source§

impl Clone for IndirectCommandBufferDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IndirectCommandBufferDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IndirectCommandBufferDescriptor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for IndirectCommandBufferDescriptor

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for IndirectCommandBufferDescriptor

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

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

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for IndirectCommandBufferDescriptor

Source§

impl Sync for IndirectCommandBufferDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.