Struct MTL4InstanceAccelerationStructureDescriptor 

pub struct MTL4InstanceAccelerationStructureDescriptor { /* private fields */ }

Available on crate features MTL4AccelerationStructure and MTLAccelerationStructure only.

Descriptor for an instance acceleration structure.

An instance acceleration structure references other acceleration structures, and provides the ability to “instantiate” them multiple times, each one with potentially a different transformation matrix.

You specify the properties of the instances in the acceleration structure this descriptor builds by providing a buffer of structs via its instanceDescriptorBuffer property.

Use a MTLResidencySet to mark residency of all buffers and acceleration structures this descriptor references when you build this acceleration structure.

See also Apple’s documentation

Implementations

impl MTL4InstanceAccelerationStructureDescriptor

pub fn instanceDescriptorBuffer(&self) -> MTL4BufferRange

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Assigns a reference to a buffer containing instance descriptors for acceleration structures to reference.

This buffer conceptually represents an array of instance data. The specific format for the structs that comprise each entry depends on the value of the instanceDescriptorType property.

You are responsible for ensuring the buffer address the range contains is not zero.

pub unsafe fn setInstanceDescriptorBuffer( &self, instance_descriptor_buffer: MTL4BufferRange, )

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Setter for instanceDescriptorBuffer.

pub fn instanceDescriptorStride(&self) -> NSUInteger

Sets the stride, in bytes, between instance descriptors the instance descriptor buffer references.

You are responsible for ensuring this stride is at least the size of the structure type corresponding to the instance descriptor type and a multiple of 4 bytes.

Defaults to 0, indicating the instance descriptors are tightly packed.

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

Setter for instanceDescriptorStride.

Safety

This might not be bounds-checked.

pub fn instanceCount(&self) -> NSUInteger

Controls the number of instance descriptors in the instance descriptor buffer references.

pub unsafe fn setInstanceCount(&self, instance_count: NSUInteger)

Setter for instanceCount.

Safety

This might not be bounds-checked.

pub fn instanceDescriptorType( &self, ) -> MTLAccelerationStructureInstanceDescriptorType

Sets the type of instance descriptor that the instance descriptor buffer references.

This value determines the layout Metal expects for the structs the instance descriptor buffer contains.

Defaults to MTLAccelerationStructureInstanceDescriptorTypeIndirect. Valid values for this property are MTLAccelerationStructureInstanceDescriptorTypeIndirect or MTLAccelerationStructureInstanceDescriptorTypeIndirectMotion.

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

Setter for instanceDescriptorType.

pub fn motionTransformBuffer(&self) -> MTL4BufferRange

Available on crate features MTL4BufferRange and MTLGPUAddress only.

A buffer containing transformation information for instance motion keyframes, formatted according to the motion transform type.

Each instance can have a different number of keyframes that you configure via individual instance descriptors.

You are responsible for ensuring the buffer address the range references is not zero when using motion instance descriptors.

pub fn setMotionTransformBuffer(&self, motion_transform_buffer: MTL4BufferRange)

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Setter for motionTransformBuffer.

pub fn motionTransformCount(&self) -> NSUInteger

Controls the total number of motion transforms in the motion transform buffer.

pub unsafe fn setMotionTransformCount(&self, motion_transform_count: NSUInteger)

Setter for motionTransformCount.

Safety

This might not be bounds-checked.

pub fn instanceTransformationMatrixLayout(&self) -> MTLMatrixLayout

Specifies the layout for the transformation matrices in the instance descriptor buffer and the motion transformation matrix buffer.

Metal interprets the value of this property as the layout for the buffers that both instanceDescriptorBuffer and motionTransformBuffer reference.

Defaults to MTLMatrixLayoutColumnMajor.

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

Setter for instanceTransformationMatrixLayout.

pub fn motionTransformType(&self) -> MTLTransformType

Controls the type of motion transforms, either as a matrix or individual components.

Defaults to MTLTransformTypePackedFloat4x3. Using a MTLTransformTypeComponent allows you to represent the rotation by a quaternion (instead as of part of the matrix), allowing for correct motion interpolation.

pub fn setMotionTransformType(&self, motion_transform_type: MTLTransformType)

Setter for motionTransformType.

pub fn motionTransformStride(&self) -> NSUInteger

Specify the stride for motion transform.

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.

impl MTL4InstanceAccelerationStructureDescriptor

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 MTL4InstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTL4AccelerationStructureDescriptor> for MTL4InstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &MTL4AccelerationStructureDescriptor

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

impl AsRef<MTL4InstanceAccelerationStructureDescriptor> for MTL4InstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<MTLAccelerationStructureDescriptor> for MTL4InstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &MTLAccelerationStructureDescriptor

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

impl AsRef<NSObject> for MTL4InstanceAccelerationStructureDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTL4InstanceAccelerationStructureDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MTL4AccelerationStructureDescriptor> for MTL4InstanceAccelerationStructureDescriptor

fn borrow(&self) -> &MTL4AccelerationStructureDescriptor

Immutably borrows from an owned value.

impl Borrow<MTLAccelerationStructureDescriptor> for MTL4InstanceAccelerationStructureDescriptor

fn borrow(&self) -> &MTLAccelerationStructureDescriptor

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTL4InstanceAccelerationStructureDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTL4InstanceAccelerationStructureDescriptor

const NAME: &'static str = "MTL4InstanceAccelerationStructureDescriptor"

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

type Super = MTL4AccelerationStructureDescriptor

The superclass of this class.

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

type Result = MTL4InstanceAccelerationStructureDescriptor

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

impl Debug for MTL4InstanceAccelerationStructureDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTL4InstanceAccelerationStructureDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTL4InstanceAccelerationStructureDescriptor

type Target = MTL4AccelerationStructureDescriptor

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTL4InstanceAccelerationStructureDescriptor

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 MTL4InstanceAccelerationStructureDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTL4InstanceAccelerationStructureDescriptor

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 MTL4InstanceAccelerationStructureDescriptor

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 MTL4InstanceAccelerationStructureDescriptor

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 MTL4InstanceAccelerationStructureDescriptor

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

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

impl DowncastTarget for MTL4InstanceAccelerationStructureDescriptor

impl Eq for MTL4InstanceAccelerationStructureDescriptor