Struct MTLResourceID

#[repr(C)]
pub struct MTLResourceID { /* private fields */ }

Available on crate feature MTLTypes only.

Handle of the GPU resource suitable for storing in an Argument Buffer

A MTLResourceID represents a specific GPU resource, mutating this handle is undefined unless the mutation results in the value equalling an already existing handle of the same resource type.

See also Apple’s documentation

Implementations

impl MTLResourceID

pub const unsafe fn from_raw(id: u64) -> Self

Construct a MTLResourceID from an ID previously gotten via to_raw.

Safety

The documentation for MTLResourceID says:

A MTLResourceID represents a specific GPU resource, mutating this handle is undefined unless the mutation results in the value equalling an already existing handle of the same resource type.

So we’ve tentatively marked this method as unsafe, with the safety requirement that the ID must be valid, i.e. have previously come from to_raw or similar.

If you disagree with this assessment, feel free to open an issue!

pub const fn to_raw(self) -> u64

Get the underlying data of the ID.

May be useful for FFI purposes.

Trait Implementations

impl Clone for MTLResourceID

fn clone(&self) -> MTLResourceID

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MTLResourceID

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

Formats the value using the given formatter.

impl Encode for MTLResourceID

const ENCODING: Encoding

The Objective-C type-encoding for this type.

impl PartialEq for MTLResourceID

fn eq(&self, other: &MTLResourceID) -> 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 MTLResourceID

const ENCODING_REF: Encoding

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

impl Copy for MTLResourceID

impl StructuralPartialEq for MTLResourceID