Struct MTLAccelerationStructureMotionTriangleGeometryDescriptor 

pub struct MTLAccelerationStructureMotionTriangleGeometryDescriptor { /* private fields */ }

Available on crate feature MTLAccelerationStructure only.

Descriptor for motion triangle geometry

See also Apple’s documentation

Implementations

impl MTLAccelerationStructureMotionTriangleGeometryDescriptor

pub fn vertexBuffers(&self) -> Retained<NSArray<MTLMotionKeyframeData>>

Vertex buffer containing triangle vertices similar to what MTLAccelerationStructureTriangleGeometryDescriptor has but array of the values.

pub fn setVertexBuffers(&self, vertex_buffers: &NSArray<MTLMotionKeyframeData>)

Setter for vertexBuffers.

This is copied when set.

pub fn vertexFormat(&self) -> MTLAttributeFormat

Available on crate feature MTLStageInputOutputDescriptor only.

Format type of the vertex buffers across all keyframes. Defaults to MTLAttributeFormatFloat3 (packed).

pub fn setVertexFormat(&self, vertex_format: MTLAttributeFormat)

Available on crate feature MTLStageInputOutputDescriptor only.

Setter for vertexFormat.

pub fn vertexStride(&self) -> NSUInteger

Stride, in bytes, between vertices in each keyframe’s vertex buffer. Must be a multiple of the vertex format data type size and must be aligned to the vertex format data type’s alignment. Defaults to 0, which will result in a stride of the vertex format data size.

pub unsafe fn setVertexStride(&self, vertex_stride: NSUInteger)

Setter for vertexStride.

Safety

This might not be bounds-checked.

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

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Optional index buffer containing references to vertices in the vertex buffer. May be nil.

pub unsafe fn setIndexBuffer( &self, index_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for indexBuffer.

Safety

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

pub fn indexBufferOffset(&self) -> NSUInteger

Index buffer offset. Must be a multiple of the index data type size and must be aligned to both the index data type’s alignment and the platform’s buffer offset alignment.

pub unsafe fn setIndexBufferOffset(&self, index_buffer_offset: NSUInteger)

Setter for indexBufferOffset.

Safety

This might not be bounds-checked.

pub fn indexType(&self) -> MTLIndexType

Available on crate feature MTLArgument only.

Index type

pub fn setIndexType(&self, index_type: MTLIndexType)

Available on crate feature MTLArgument only.

Setter for indexType.

pub fn triangleCount(&self) -> NSUInteger

Number of triangles

pub unsafe fn setTriangleCount(&self, triangle_count: NSUInteger)

Setter for triangleCount.

Safety

This might not be bounds-checked.

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

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Buffer containing packed float4x3 transformation matrix. Transform is applied to the vertex data when building the acceleration structure. Input vertex buffers are not modified. The transformation matrix is applied to all keyframes’ vertex data. When set to nil, transformation matrix is not applied to vertex data.

pub unsafe fn setTransformationMatrixBuffer( &self, transformation_matrix_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for transformationMatrixBuffer.

Safety

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

pub fn transformationMatrixBufferOffset(&self) -> NSUInteger

Transformation matrix buffer offset. Must be a multiple of 4 bytes. Defaults to 0.

pub unsafe fn setTransformationMatrixBufferOffset( &self, transformation_matrix_buffer_offset: NSUInteger, )

Setter for transformationMatrixBufferOffset.

Safety

This might not be bounds-checked.

pub fn transformationMatrixLayout(&self) -> MTLMatrixLayout

Matrix layout for the transformation matrix in the transformation matrix buffer. Defaults to MTLMatrixLayoutColumnMajor.

pub fn setTransformationMatrixLayout( &self, transformation_matrix_layout: MTLMatrixLayout, )

Setter for transformationMatrixLayout.

pub fn descriptor() -> Retained<Self>

impl MTLAccelerationStructureMotionTriangleGeometryDescriptor

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

Methods from Deref<Target = MTLAccelerationStructureGeometryDescriptor>

pub fn intersectionFunctionTableOffset(&self) -> NSUInteger

pub fn setIntersectionFunctionTableOffset( &self, intersection_function_table_offset: NSUInteger, )

Setter for intersectionFunctionTableOffset.

pub fn opaque(&self) -> bool

Whether the geometry is opaque

pub fn setOpaque(&self, opaque: bool)

Setter for opaque.

pub fn allowDuplicateIntersectionFunctionInvocation(&self) -> bool

Whether intersection functions may be invoked more than once per ray/primitive intersection. Defaults to YES.

pub fn setAllowDuplicateIntersectionFunctionInvocation( &self, allow_duplicate_intersection_function_invocation: bool, )

Setter for allowDuplicateIntersectionFunctionInvocation.

pub fn label(&self) -> Option<Retained<NSString>>

Label

pub fn setLabel(&self, label: Option<&NSString>)

Setter for label.

This is copied when set.

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

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Data buffer containing per-primitive data. May be nil.

pub fn setPrimitiveDataBuffer( &self, primitive_data_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for primitiveDataBuffer.

pub fn primitiveDataBufferOffset(&self) -> NSUInteger

Primitive data buffer offset in bytes. Must be aligned to the platform’s buffer offset alignment. Defaults to 0 bytes.

pub unsafe fn setPrimitiveDataBufferOffset( &self, primitive_data_buffer_offset: NSUInteger, )

Setter for primitiveDataBufferOffset.

Safety

This might not be bounds-checked.

pub fn primitiveDataStride(&self) -> NSUInteger

Stride, in bytes, between per-primitive data in the primitive data buffer. Must be at least primitiveDataElementSize and must be a multiple of 4 bytes. Defaults to 0 bytes. Assumed to be equal to primitiveDataElementSize if zero.

pub fn setPrimitiveDataStride(&self, primitive_data_stride: NSUInteger)

Setter for primitiveDataStride.

pub fn primitiveDataElementSize(&self) -> NSUInteger

Size, in bytes, of the data for each primitive in the primitive data buffer. Must be at most primitiveDataStride and must be a multiple of 4 bytes. Defaults to 0 bytes.

pub fn setPrimitiveDataElementSize( &self, primitive_data_element_size: NSUInteger, )

Setter for primitiveDataElementSize.

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 MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLAccelerationStructureGeometryDescriptor> for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn as_ref(&self) -> &MTLAccelerationStructureGeometryDescriptor

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

impl AsRef<MTLAccelerationStructureMotionTriangleGeometryDescriptor> for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MTLAccelerationStructureGeometryDescriptor> for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn borrow(&self) -> &MTLAccelerationStructureGeometryDescriptor

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLAccelerationStructureMotionTriangleGeometryDescriptor

const NAME: &'static str = "MTLAccelerationStructureMotionTriangleGeometryDescriptor"

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

type Super = MTLAccelerationStructureGeometryDescriptor

The superclass of this class.

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

type Result = MTLAccelerationStructureMotionTriangleGeometryDescriptor

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

impl Debug for MTLAccelerationStructureMotionTriangleGeometryDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLAccelerationStructureMotionTriangleGeometryDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLAccelerationStructureMotionTriangleGeometryDescriptor

type Target = MTLAccelerationStructureGeometryDescriptor

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLAccelerationStructureMotionTriangleGeometryDescriptor

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 MTLAccelerationStructureMotionTriangleGeometryDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLAccelerationStructureMotionTriangleGeometryDescriptor

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 MTLAccelerationStructureMotionTriangleGeometryDescriptor

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 MTLAccelerationStructureMotionTriangleGeometryDescriptor

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 MTLAccelerationStructureMotionTriangleGeometryDescriptor

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

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

impl DowncastTarget for MTLAccelerationStructureMotionTriangleGeometryDescriptor

impl Eq for MTLAccelerationStructureMotionTriangleGeometryDescriptor