Struct MTLStorageMode 

#[repr(transparent)]
pub struct MTLStorageMode(pub NSUInteger);

Available on crate feature MTLResource only.

Describes location and CPU mapping of MTLTexture.

In this mode, CPU and device will nominally both use the same underlying memory when accessing the contents of the texture resource. However, coherency is only guaranteed at command buffer boundaries to minimize the required flushing of CPU and GPU caches. This is the default storage mode for iOS Textures.

This mode relaxes the coherency requirements and requires that the developer make explicit requests to maintain coherency between a CPU and GPU version of the texture resource. In order for CPU to access up to date GPU results, first, a blit synchronizations must be completed (see synchronize methods of MTLBlitCommandEncoder). Blit overhead is only incurred if GPU has modified the resource. This is the default storage mode for OS X Textures.

This mode allows the texture resource data to be kept entirely to GPU (or driver) private memory that will never be accessed by the CPU directly, so no conherency of any kind must be maintained.

This mode allows creation of resources that do not have a GPU or CPU memory backing, but do have on-chip storage for TBDR devices. The contents of the on-chip storage is undefined and does not persist, but its configuration is controlled by the MTLTexture descriptor. Textures created with MTLStorageModeMemoryless dont have an IOAccelResource at any point in their lifetime. The only way to populate such resource is to perform rendering operations on it. Blit operations are disallowed.

See also Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl MTLStorageMode

pub const Shared: Self

pub const Managed: Self

pub const Private: Self

pub const Memoryless: Self

Trait Implementations

impl Clone for MTLStorageMode

fn clone(&self) -> MTLStorageMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MTLStorageMode

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

Formats the value using the given formatter.

impl Encode for MTLStorageMode

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for MTLStorageMode

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 Ord for MTLStorageMode

fn cmp(&self, other: &MTLStorageMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MTLStorageMode

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

fn partial_cmp(&self, other: &MTLStorageMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for MTLStorageMode

const ENCODING_REF: Encoding

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

impl Copy for MTLStorageMode

impl Eq for MTLStorageMode

impl StructuralPartialEq for MTLStorageMode