Struct MTLIndirectCommandBufferDescriptor 

pub struct MTLIndirectCommandBufferDescriptor { /* private fields */ }

Available on crate feature MTLIndirectCommandBuffer only.

Describes the limits and features that can be used in an indirect command

See also Apple’s documentation

Implementations

impl MTLIndirectCommandBufferDescriptor

pub fn commandTypes(&self) -> MTLIndirectCommandType

A bitfield of the command types that be encoded.

MTLCommandTypeDispatch cannot be mixed with any other command type.

pub fn setCommandTypes(&self, command_types: MTLIndirectCommandType)

Setter for commandTypes.

pub fn inheritPipelineState(&self) -> bool

Whether the render or compute pipeline are inherited from the encoder

pub fn setInheritPipelineState(&self, inherit_pipeline_state: bool)

Setter for inheritPipelineState.

pub fn inheritBuffers(&self) -> bool

Whether the render or compute pipeline can set arguments.

pub fn setInheritBuffers(&self, inherit_buffers: bool)

Setter for inheritBuffers.

pub fn inheritDepthStencilState(&self) -> bool

Configures whether the indirect command buffer inherits the depth stencil state from the encoder.

The property’s default value is <doc ://com.apple.documentation/documentation/swift/true>.

pub fn setInheritDepthStencilState(&self, inherit_depth_stencil_state: bool)

Setter for inheritDepthStencilState.

pub fn inheritDepthBias(&self) -> bool

Configures whether the indirect command buffer inherits the depth bias from the encoder.

The property’s default value is <doc ://com.apple.documentation/documentation/swift/true>.

pub fn setInheritDepthBias(&self, inherit_depth_bias: bool)

Setter for inheritDepthBias.

pub fn inheritDepthClipMode(&self) -> bool

Configures whether the indirect command buffer inherits the depth clip mode from the encoder.

The property’s default value is <doc ://com.apple.documentation/documentation/swift/true>.

pub fn setInheritDepthClipMode(&self, inherit_depth_clip_mode: bool)

Setter for inheritDepthClipMode.

pub fn inheritCullMode(&self) -> bool

Configures whether the indirect command buffer inherits the cull mode from the encoder.

The property’s default value is <doc ://com.apple.documentation/documentation/swift/true>.

pub fn setInheritCullMode(&self, inherit_cull_mode: bool)

Setter for inheritCullMode.

pub fn inheritFrontFacingWinding(&self) -> bool

Configures whether the indirect command buffer inherits the front facing winding from the encoder.

The property’s default value is <doc ://com.apple.documentation/documentation/swift/true>.

pub fn setInheritFrontFacingWinding(&self, inherit_front_facing_winding: bool)

Setter for inheritFrontFacingWinding.

pub fn inheritTriangleFillMode(&self) -> bool

Configures whether the indirect command buffer inherits the triangle fill mode from the encoder.

The property’s default value is <doc ://com.apple.documentation/documentation/swift/true>.

pub fn setInheritTriangleFillMode(&self, inherit_triangle_fill_mode: bool)

Setter for inheritTriangleFillMode.

pub fn maxVertexBufferBindCount(&self) -> NSUInteger

The maximum bind index of vertex argument buffers that can be set per command.

pub fn setMaxVertexBufferBindCount( &self, max_vertex_buffer_bind_count: NSUInteger, )

Setter for maxVertexBufferBindCount.

pub fn maxFragmentBufferBindCount(&self) -> NSUInteger

The maximum bind index of fragment argument buffers that can be set per command.

pub fn setMaxFragmentBufferBindCount( &self, max_fragment_buffer_bind_count: NSUInteger, )

Setter for maxFragmentBufferBindCount.

pub fn maxKernelBufferBindCount(&self) -> NSUInteger

The maximum bind index of kernel (or tile) argument buffers that can be set per command.

pub fn setMaxKernelBufferBindCount( &self, max_kernel_buffer_bind_count: NSUInteger, )

Setter for maxKernelBufferBindCount.

pub fn maxKernelThreadgroupMemoryBindCount(&self) -> NSUInteger

The maximum bind index of kernel (or tile) threadgroup memory that can be set per command. The default value is 31.

pub unsafe fn setMaxKernelThreadgroupMemoryBindCount( &self, max_kernel_threadgroup_memory_bind_count: NSUInteger, )

Setter for maxKernelThreadgroupMemoryBindCount.

Safety

This might not be bounds-checked.

pub fn maxObjectBufferBindCount(&self) -> NSUInteger

The maximum bind index of object stage buffers that can be set per render command.

pub unsafe fn setMaxObjectBufferBindCount( &self, max_object_buffer_bind_count: NSUInteger, )

Setter for maxObjectBufferBindCount.

Safety

This might not be bounds-checked.

pub fn maxMeshBufferBindCount(&self) -> NSUInteger

The maximum bind index of mesh stage buffers that can be set per render command.

pub unsafe fn setMaxMeshBufferBindCount( &self, max_mesh_buffer_bind_count: NSUInteger, )

Setter for maxMeshBufferBindCount.

Safety

This might not be bounds-checked.

pub fn maxObjectThreadgroupMemoryBindCount(&self) -> NSUInteger

The maximum bind index of object threadgroup memory that can be set per render command. The default value is 0.

pub unsafe fn setMaxObjectThreadgroupMemoryBindCount( &self, max_object_threadgroup_memory_bind_count: NSUInteger, )

Setter for maxObjectThreadgroupMemoryBindCount.

Safety

This might not be bounds-checked.

pub fn supportRayTracing(&self) -> bool

Whether the render or compute commands can use ray tracing. Default value is NO.

pub fn setSupportRayTracing(&self, support_ray_tracing: bool)

Setter for supportRayTracing.

pub fn supportDynamicAttributeStride(&self) -> bool

allows binding pipelines that have at least one MTLBufferLayout with a stride of MTLBufferLayoutStrideDynamic

will allow setting attributeStride in setVertexBuffer / setKernelBuffer calls

pub fn setSupportDynamicAttributeStride( &self, support_dynamic_attribute_stride: bool, )

Setter for supportDynamicAttributeStride.

pub fn supportColorAttachmentMapping(&self) -> bool

Specifies if the indirect command buffer should support color attachment mapping.

pub fn setSupportColorAttachmentMapping( &self, support_color_attachment_mapping: bool, )

Setter for supportColorAttachmentMapping.

impl MTLIndirectCommandBufferDescriptor

Methods declared on superclass NSObject.

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for MTLIndirectCommandBufferDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLIndirectCommandBufferDescriptor> for MTLIndirectCommandBufferDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLIndirectCommandBufferDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLIndirectCommandBufferDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLIndirectCommandBufferDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLIndirectCommandBufferDescriptor

const NAME: &'static str = "MTLIndirectCommandBufferDescriptor"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<MTLIndirectCommandBufferDescriptor as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for MTLIndirectCommandBufferDescriptor

type Result = MTLIndirectCommandBufferDescriptor

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for MTLIndirectCommandBufferDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLIndirectCommandBufferDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLIndirectCommandBufferDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLIndirectCommandBufferDescriptor

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for MTLIndirectCommandBufferDescriptor

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLIndirectCommandBufferDescriptor

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for MTLIndirectCommandBufferDescriptor

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for MTLIndirectCommandBufferDescriptor

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for MTLIndirectCommandBufferDescriptor

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for MTLIndirectCommandBufferDescriptor

impl Eq for MTLIndirectCommandBufferDescriptor