Struct MTLAccelerationStructureGeometryDescriptor

Source

pub struct MTLAccelerationStructureGeometryDescriptor { /* private fields */ }

Available on crate feature MTLAccelerationStructure only.

Expand description

Base class for all geometry descriptors. Do not use this class directly. Use one of the derived classes instead.

Implementations§

Source §

impl MTLAccelerationStructureGeometryDescriptor

Source

pub fn intersectionFunctionTableOffset(&self) -> NSUInteger

Source

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

Setter for intersectionFunctionTableOffset.

Source

pub fn opaque(&self) -> bool

Whether the geometry is opaque

Source

pub fn setOpaque(&self, opaque: bool)

Setter for opaque.

Source

pub fn allowDuplicateIntersectionFunctionInvocation(&self) -> bool

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

Source

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

Setter for allowDuplicateIntersectionFunctionInvocation.

Source

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

Label

Source

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

Setter for label.

This is copied when set.

Source

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.

Source

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

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for primitiveDataBuffer.

Source

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.

Source

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

Setter for primitiveDataBufferOffset.

§Safety

This might not be bounds-checked.

Source

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.

Source

pub fn setPrimitiveDataStride(&self, primitive_data_stride: NSUInteger)

Setter for primitiveDataStride.

Source

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.

Source

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

Setter for primitiveDataElementSize.

Source §

impl MTLAccelerationStructureGeometryDescriptor

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}