Struct HeapDescriptor 

pub struct HeapDescriptor(/* private fields */);

A configuration for a heap.

C++ equivalent: MTL::HeapDescriptor

Implementations

impl HeapDescriptor

pub fn new() -> Option<Self>

Create a new heap descriptor.

C++ equivalent: static HeapDescriptor* alloc()->init()

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a HeapDescriptor from a raw pointer.

Safety

The pointer must be a valid Metal heap descriptor object.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

pub fn size(&self) -> UInteger

Get the heap size.

C++ equivalent: NS::UInteger size() const

pub fn set_size(&self, size: UInteger)

Set the heap size.

C++ equivalent: void setSize(NS::UInteger)

pub fn storage_mode(&self) -> StorageMode

Get the storage mode.

C++ equivalent: StorageMode storageMode() const

pub fn set_storage_mode(&self, mode: StorageMode)

Set the storage mode.

C++ equivalent: void setStorageMode(StorageMode)

pub fn cpu_cache_mode(&self) -> CPUCacheMode

Get the CPU cache mode.

C++ equivalent: CPUCacheMode cpuCacheMode() const

pub fn set_cpu_cache_mode(&self, mode: CPUCacheMode)

Set the CPU cache mode.

C++ equivalent: void setCpuCacheMode(CPUCacheMode)

pub fn hazard_tracking_mode(&self) -> HazardTrackingMode

Get the hazard tracking mode.

C++ equivalent: HazardTrackingMode hazardTrackingMode() const

pub fn set_hazard_tracking_mode(&self, mode: HazardTrackingMode)

Set the hazard tracking mode.

C++ equivalent: void setHazardTrackingMode(HazardTrackingMode)

pub fn resource_options(&self) -> ResourceOptions

Get the resource options.

C++ equivalent: ResourceOptions resourceOptions() const

pub fn set_resource_options(&self, options: ResourceOptions)

Set the resource options.

C++ equivalent: void setResourceOptions(ResourceOptions)

pub fn heap_type(&self) -> HeapType

Get the heap type.

C++ equivalent: HeapType type() const

pub fn set_heap_type(&self, heap_type: HeapType)

Set the heap type.

C++ equivalent: void setType(HeapType)

pub fn sparse_page_size(&self) -> SparsePageSize

Get the sparse page size.

C++ equivalent: SparsePageSize sparsePageSize() const

pub fn set_sparse_page_size(&self, size: SparsePageSize)

Set the sparse page size.

C++ equivalent: void setSparsePageSize(SparsePageSize)

pub fn max_compatible_placement_sparse_page_size(&self) -> SparsePageSize

Get the maximum compatible placement sparse page size.

C++ equivalent: SparsePageSize maxCompatiblePlacementSparsePageSize() const

pub fn set_max_compatible_placement_sparse_page_size( &self, size: SparsePageSize, )

Set the maximum compatible placement sparse page size.

C++ equivalent: void setMaxCompatiblePlacementSparsePageSize(SparsePageSize)

Trait Implementations

impl Clone for HeapDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeapDescriptor

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

Formats the value using the given formatter.

impl Default for HeapDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for HeapDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for HeapDescriptor

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for HeapDescriptor

impl Sync for HeapDescriptor