Struct MTL4AccelerationStructureCurveGeometryDescriptor 

pub struct MTL4AccelerationStructureCurveGeometryDescriptor { /* private fields */ }

Available on crate feature MTL4AccelerationStructure only.

Describes curve geometry suitable for ray tracing.

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

See also Apple’s documentation

Implementations

impl MTL4AccelerationStructureCurveGeometryDescriptor

pub fn controlPointBuffer(&self) -> MTL4BufferRange

Available on crate features MTL4BufferRange and MTLGPUAddress only.

References a buffer containing curve control points.

Control points are interpolated according to the basis function you specify in curveBasis.

You are responsible for ensuring each control is in a format matching the control point format controlPointFormat specifies, as well as ensuring that the buffer address of the range is not zero.

pub fn setControlPointBuffer(&self, control_point_buffer: MTL4BufferRange)

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Setter for controlPointBuffer.

pub fn controlPointCount(&self) -> NSUInteger

Declares the number of control points in the control point buffer.

pub unsafe fn setControlPointCount(&self, control_point_count: NSUInteger)

Setter for controlPointCount.

Safety

This might not be bounds-checked.

pub fn controlPointStride(&self) -> NSUInteger

Sets the stride, in bytes, between control points in the control point buffer the control point buffer references.

You are responsible for ensuring this stride is a multiple of the control point format’s element size, and at a minimum exactly the control point format’s size.

This property defaults to 0, indicating that the control points are tightly-packed.

pub unsafe fn setControlPointStride(&self, control_point_stride: NSUInteger)

Setter for controlPointStride.

Safety

This might not be bounds-checked.

pub fn controlPointFormat(&self) -> MTLAttributeFormat

Available on crate feature MTLStageInputOutputDescriptor only.

Declares the format of the control points the control point buffer references.

Defaults to MTLAttributeFormatFloat3, representing 3 floating point values tightly packed.

pub fn setControlPointFormat(&self, control_point_format: MTLAttributeFormat)

Available on crate feature MTLStageInputOutputDescriptor only.

Setter for controlPointFormat.

pub fn radiusBuffer(&self) -> MTL4BufferRange

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Assigns a reference to a buffer containing the curve radius for each control point.

Metal interpolates curve radii according to the basis function you specify via curveBasis.

You are responsible for ensuring the type of each radius matches the type property radiusFormat specifies, that each radius is at least zero, and that the buffer address of the range is not zero.

pub fn setRadiusBuffer(&self, radius_buffer: MTL4BufferRange)

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Setter for radiusBuffer.

pub fn radiusFormat(&self) -> MTLAttributeFormat

Available on crate feature MTLStageInputOutputDescriptor only.

Declares the format of the radii in the radius buffer.

Defaults to MTLAttributeFormatFloat.

pub fn setRadiusFormat(&self, radius_format: MTLAttributeFormat)

Available on crate feature MTLStageInputOutputDescriptor only.

Setter for radiusFormat.

pub fn radiusStride(&self) -> NSUInteger

Configures the stride, in bytes, between radii in the radius buffer.

You are responsible for ensuring this property is set to a multiple of the size corresponding to the radiusFormat.

This property defaults to 0 bytes, indicating that the radii are tightly packed.

pub unsafe fn setRadiusStride(&self, radius_stride: NSUInteger)

Setter for radiusStride.

Safety

This might not be bounds-checked.

pub fn indexBuffer(&self) -> MTL4BufferRange

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Assigns an optional index buffer containing references to control points in the control point buffer.

Each index represents the first control point of a curve segment. You are responsible for ensuring the buffer address of the range is not zero.

pub unsafe fn setIndexBuffer(&self, index_buffer: MTL4BufferRange)

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Setter for indexBuffer.

Safety

This might not be bounds-checked.

pub fn indexType(&self) -> MTLIndexType

Available on crate feature MTLArgument only.

Specifies the size of the indices the indexBuffer contains, which is typically either 16 or 32-bits for each index.

pub fn setIndexType(&self, index_type: MTLIndexType)

Available on crate feature MTLArgument only.

Setter for indexType.

pub fn segmentCount(&self) -> NSUInteger

Declares the number of curve segments.

pub unsafe fn setSegmentCount(&self, segment_count: NSUInteger)

Setter for segmentCount.

Safety

This might not be bounds-checked.

pub fn segmentControlPointCount(&self) -> NSUInteger

Declares the number of control points per curve segment.

Valid values for this property are 2, 3, or 4.

pub unsafe fn setSegmentControlPointCount( &self, segment_control_point_count: NSUInteger, )

Setter for segmentControlPointCount.

Safety

This might not be bounds-checked.

pub fn curveType(&self) -> MTLCurveType

Available on crate feature MTLAccelerationStructure only.

Controls the curve type.

Defaults to MTLCurveTypeRound.

pub fn setCurveType(&self, curve_type: MTLCurveType)

Available on crate feature MTLAccelerationStructure only.

Setter for curveType.

pub fn curveBasis(&self) -> MTLCurveBasis

Available on crate feature MTLAccelerationStructure only.

Controls the curve basis function, determining how Metal interpolates the control points.

Defaults to MTLCurveBasisBSpline.

pub fn setCurveBasis(&self, curve_basis: MTLCurveBasis)

Available on crate feature MTLAccelerationStructure only.

Setter for curveBasis.

pub fn curveEndCaps(&self) -> MTLCurveEndCaps

Available on crate feature MTLAccelerationStructure only.

Sets the type of curve end caps.

Defaults to MTLCurveEndCapsNone.

pub fn setCurveEndCaps(&self, curve_end_caps: MTLCurveEndCaps)

Available on crate feature MTLAccelerationStructure only.

Setter for curveEndCaps.

impl MTL4AccelerationStructureCurveGeometryDescriptor

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

Methods from Deref<Target = MTL4AccelerationStructureGeometryDescriptor>

pub fn intersectionFunctionTableOffset(&self) -> NSUInteger

Sets the offset that this geometry contributes to determining the intersection function to invoke when a ray intersects it.

When you perform a ray tracing operation in the Metal Shading Language, and provide the ray intersector object with an instance of MTLIntersectionFunctionTable, Metal adds this offset to the instance offset from structs such as:

• MTLAccelerationStructureInstanceDescriptor
• MTLAccelerationStructureUserIDInstanceDescriptor
• MTLAccelerationStructureMotionInstanceDescriptor
• MTLIndirectAccelerationStructureInstanceDescriptor
• MTLIndirectAccelerationStructureMotionInstanceDescriptor

The sum of these offsets provides an index into the intersection function table that the ray tracing system uses to retrieve and invoke the function at this index, allowing you to customize the intersection evaluation process.

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

Setter for intersectionFunctionTableOffset.

Safety

This might not be bounds-checked.

pub fn opaque(&self) -> bool

Provides a hint to Metal that this geometry is opaque, potentially accelerating the ray/primitive intersection process.

pub fn setOpaque(&self, opaque: bool)

Setter for opaque.

pub fn allowDuplicateIntersectionFunctionInvocation(&self) -> bool

A boolean value that indicates whether the ray-tracing system in Metal allows the invocation of intersection functions more than once per ray-primitive intersection.

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

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

Setter for allowDuplicateIntersectionFunctionInvocation.

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

Assigns an optional label you can assign to this geometry for debugging purposes.

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

Setter for label.

This is copied when set.

pub fn primitiveDataBuffer(&self) -> MTL4BufferRange

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Assigns optional buffer containing data to associate with each primitive in this geometry.

You can use zero as the buffer address in this buffer range.

pub unsafe fn setPrimitiveDataBuffer( &self, primitive_data_buffer: MTL4BufferRange, )

Available on crate features MTL4BufferRange and MTLGPUAddress only.

Setter for primitiveDataBuffer.

pub fn primitiveDataStride(&self) -> NSUInteger

Defines the stride, in bytes, between each primitive’s data in the primitive data buffer primitiveDataBuffer references.

You are responsible for ensuring the stride is at least primitiveDataElementSize in size and a multiple of 4 bytes.

This property defaults to 0 bytes, which indicates the stride is equal to primitiveDataElementSize.

pub unsafe fn setPrimitiveDataStride(&self, primitive_data_stride: NSUInteger)

Setter for primitiveDataStride.

Safety

This might not be bounds-checked.

pub fn primitiveDataElementSize(&self) -> NSUInteger

Sets the size, in bytes, of the data for each primitive in the primitive data buffer primitiveDataBuffer references.

This size needs to be at most primitiveDataStride in size and a multiple of 4 bytes.

This property defaults to 0 bytes.

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

Setter for primitiveDataElementSize.

Safety

This might not be bounds-checked.

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 MTL4AccelerationStructureCurveGeometryDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTL4AccelerationStructureCurveGeometryDescriptor> for MTL4AccelerationStructureCurveGeometryDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<MTL4AccelerationStructureGeometryDescriptor> for MTL4AccelerationStructureCurveGeometryDescriptor

fn as_ref(&self) -> &MTL4AccelerationStructureGeometryDescriptor

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

impl AsRef<NSObject> for MTL4AccelerationStructureCurveGeometryDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTL4AccelerationStructureCurveGeometryDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MTL4AccelerationStructureGeometryDescriptor> for MTL4AccelerationStructureCurveGeometryDescriptor

fn borrow(&self) -> &MTL4AccelerationStructureGeometryDescriptor

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTL4AccelerationStructureCurveGeometryDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTL4AccelerationStructureCurveGeometryDescriptor

const NAME: &'static str = "MTL4AccelerationStructureCurveGeometryDescriptor"

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

type Super = MTL4AccelerationStructureGeometryDescriptor

The superclass of this class.

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

type Result = MTL4AccelerationStructureCurveGeometryDescriptor

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

impl Debug for MTL4AccelerationStructureCurveGeometryDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTL4AccelerationStructureCurveGeometryDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTL4AccelerationStructureCurveGeometryDescriptor

type Target = MTL4AccelerationStructureGeometryDescriptor

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTL4AccelerationStructureCurveGeometryDescriptor

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 MTL4AccelerationStructureCurveGeometryDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTL4AccelerationStructureCurveGeometryDescriptor

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 MTL4AccelerationStructureCurveGeometryDescriptor

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 MTL4AccelerationStructureCurveGeometryDescriptor

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 MTL4AccelerationStructureCurveGeometryDescriptor

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

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

impl DowncastTarget for MTL4AccelerationStructureCurveGeometryDescriptor

impl Eq for MTL4AccelerationStructureCurveGeometryDescriptor