Struct MTLIndirectInstanceAccelerationStructureDescriptor 

pub struct MTLIndirectInstanceAccelerationStructureDescriptor { /* private fields */ }

Available on crate feature MTLAccelerationStructure only.

Descriptor for an instance acceleration structure built with an indirected buffer of instances.

See also Apple’s documentation

Implementations

impl MTLIndirectInstanceAccelerationStructureDescriptor

pub fn instanceDescriptorBuffer( &self, ) -> Option<Retained<ProtocolObject<dyn MTLBuffer>>>

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Buffer containing instance descriptors of the type specified by the instanceDescriptorType property

pub unsafe fn setInstanceDescriptorBuffer( &self, instance_descriptor_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for instanceDescriptorBuffer.

Safety

• instance_descriptor_buffer may need to be synchronized.
• instance_descriptor_buffer may be unretained, you must ensure it is kept alive while in use.
• instance_descriptor_buffer contents should be of the correct type.

pub fn instanceDescriptorBufferOffset(&self) -> NSUInteger

Offset into the instance descriptor buffer. Must be a multiple of 64 bytes and must be aligned to the platform’s buffer offset alignment.

pub unsafe fn setInstanceDescriptorBufferOffset( &self, instance_descriptor_buffer_offset: NSUInteger, )

Setter for instanceDescriptorBufferOffset.

Safety

This might not be bounds-checked.

pub fn instanceDescriptorStride(&self) -> NSUInteger

Stride, in bytes, between instance descriptors in the instance descriptor buffer. Must be at least the size of the instance descriptor type and must be a multiple of 4 bytes. Defaults to the size of the instance descriptor type.

pub unsafe fn setInstanceDescriptorStride( &self, instance_descriptor_stride: NSUInteger, )

Setter for instanceDescriptorStride.

Safety

This might not be bounds-checked.

pub fn maxInstanceCount(&self) -> NSUInteger

Maximum number of instance descriptors

pub unsafe fn setMaxInstanceCount(&self, max_instance_count: NSUInteger)

Setter for maxInstanceCount.

Safety

This might not be bounds-checked.

pub fn instanceCountBuffer( &self, ) -> Option<Retained<ProtocolObject<dyn MTLBuffer>>>

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Buffer containing the instance count as a uint32_t value. Value at build time must be less than or equal to maxInstanceCount.

pub unsafe fn setInstanceCountBuffer( &self, instance_count_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for instanceCountBuffer.

Safety

• instance_count_buffer may need to be synchronized.
• instance_count_buffer may be unretained, you must ensure it is kept alive while in use.
• instance_count_buffer contents should be of the correct type.

pub fn instanceCountBufferOffset(&self) -> NSUInteger

Offset into the instance count buffer. Must be a multiple of 4 bytes and must be aligned to the platform’s buffer offset alignment.

pub unsafe fn setInstanceCountBufferOffset( &self, instance_count_buffer_offset: NSUInteger, )

Setter for instanceCountBufferOffset.

Safety

This might not be bounds-checked.

pub fn instanceDescriptorType( &self, ) -> MTLAccelerationStructureInstanceDescriptorType

Type of instance descriptor in the instance descriptor buffer. Defaults to MTLAccelerationStructureInstanceDescriptorTypeIndirect. Must be MTLAccelerationStructureInstanceDescriptorTypeIndirect or MTLAccelerationStructureInstanceDescriptorTypeIndirectMotion.

pub fn setInstanceDescriptorType( &self, instance_descriptor_type: MTLAccelerationStructureInstanceDescriptorType, )

Setter for instanceDescriptorType.

pub fn motionTransformBuffer( &self, ) -> Option<Retained<ProtocolObject<dyn MTLBuffer>>>

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Buffer containing transformation information for motion

pub unsafe fn setMotionTransformBuffer( &self, motion_transform_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for motionTransformBuffer.

Safety

• motion_transform_buffer may need to be synchronized.
• motion_transform_buffer may be unretained, you must ensure it is kept alive while in use.
• motion_transform_buffer contents should be of the correct type.

pub fn motionTransformBufferOffset(&self) -> NSUInteger

Offset into the instance motion descriptor buffer. Must be a multiple of 64 bytes and must be aligned to the platform’s buffer offset alignment.

pub unsafe fn setMotionTransformBufferOffset( &self, motion_transform_buffer_offset: NSUInteger, )

Setter for motionTransformBufferOffset.

Safety

This might not be bounds-checked.

pub fn maxMotionTransformCount(&self) -> NSUInteger

Maximum number of motion transforms

pub unsafe fn setMaxMotionTransformCount( &self, max_motion_transform_count: NSUInteger, )

Setter for maxMotionTransformCount.

Safety

This might not be bounds-checked.

pub fn motionTransformCountBuffer( &self, ) -> Option<Retained<ProtocolObject<dyn MTLBuffer>>>

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Buffer containing the motion transform count as a uint32_t value. Value at build time must be less than or equal to maxMotionTransformCount.

pub unsafe fn setMotionTransformCountBuffer( &self, motion_transform_count_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for motionTransformCountBuffer.

Safety

• motion_transform_count_buffer may need to be synchronized.
• motion_transform_count_buffer may be unretained, you must ensure it is kept alive while in use.
• motion_transform_count_buffer contents should be of the correct type.

pub fn motionTransformCountBufferOffset(&self) -> NSUInteger

Offset into the motion transform count buffer. Must be a multiple of 4 bytes and must be aligned to the platform’s buffer offset alignment.

pub unsafe fn setMotionTransformCountBufferOffset( &self, motion_transform_count_buffer_offset: NSUInteger, )

Setter for motionTransformCountBufferOffset.

Safety

This might not be bounds-checked.

pub fn instanceTransformationMatrixLayout(&self) -> MTLMatrixLayout

Matrix layout of the transformation matrices in the instance descriptors in the instance descriptor buffer and the transformation matrices in the transformation matrix buffer. Defaults to MTLMatrixLayoutColumnMajor.

pub fn setInstanceTransformationMatrixLayout( &self, instance_transformation_matrix_layout: MTLMatrixLayout, )

Setter for instanceTransformationMatrixLayout.

pub fn motionTransformType(&self) -> MTLTransformType

Type of motion transforms. Defaults to MTLTransformTypePackedFloat4x3.

pub fn setMotionTransformType(&self, motion_transform_type: MTLTransformType)

Setter for motionTransformType.

pub fn motionTransformStride(&self) -> NSUInteger

Motion transform stride. Defaults to 0, indicating that transforms are tightly packed according to the motion transform type.

pub unsafe fn setMotionTransformStride( &self, motion_transform_stride: NSUInteger, )

Setter for motionTransformStride.

Safety

This might not be bounds-checked.

pub fn descriptor() -> Retained<Self>

impl MTLIndirectInstanceAccelerationStructureDescriptor

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

Methods from Deref<Target = MTLAccelerationStructureDescriptor>

pub fn usage(&self) -> MTLAccelerationStructureUsage

pub fn setUsage(&self, usage: MTLAccelerationStructureUsage)

Setter for usage.

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 MTLIndirectInstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLAccelerationStructureDescriptor> for MTLIndirectInstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &MTLAccelerationStructureDescriptor

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

impl AsRef<MTLIndirectInstanceAccelerationStructureDescriptor> for MTLIndirectInstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLIndirectInstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLIndirectInstanceAccelerationStructureDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MTLAccelerationStructureDescriptor> for MTLIndirectInstanceAccelerationStructureDescriptor

fn borrow(&self) -> &MTLAccelerationStructureDescriptor

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLIndirectInstanceAccelerationStructureDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLIndirectInstanceAccelerationStructureDescriptor

const NAME: &'static str = "MTLIndirectInstanceAccelerationStructureDescriptor"

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

type Super = MTLAccelerationStructureDescriptor

The superclass of this class.

type ThreadKind = <<MTLIndirectInstanceAccelerationStructureDescriptor 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 MTLIndirectInstanceAccelerationStructureDescriptor

type Result = MTLIndirectInstanceAccelerationStructureDescriptor

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

impl Debug for MTLIndirectInstanceAccelerationStructureDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLIndirectInstanceAccelerationStructureDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLIndirectInstanceAccelerationStructureDescriptor

type Target = MTLAccelerationStructureDescriptor

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLIndirectInstanceAccelerationStructureDescriptor

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 MTLIndirectInstanceAccelerationStructureDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLIndirectInstanceAccelerationStructureDescriptor

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 MTLIndirectInstanceAccelerationStructureDescriptor

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 MTLIndirectInstanceAccelerationStructureDescriptor

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 MTLIndirectInstanceAccelerationStructureDescriptor

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

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

impl DowncastTarget for MTLIndirectInstanceAccelerationStructureDescriptor

impl Eq for MTLIndirectInstanceAccelerationStructureDescriptor