Struct Heap 

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

A memory pool from which resources can be allocated.

C++ equivalent: MTL::Heap

Implementations

impl Heap

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

Create a Heap from a raw pointer.

Safety

The pointer must be a valid Metal heap object.

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

Get the raw pointer to the heap.

pub fn label(&self) -> Option<String>

Get the label for this heap.

C++ equivalent: NS::String* label() const

pub fn set_label(&self, label: &str)

Set the label for this heap.

C++ equivalent: void setLabel(const NS::String*)

pub fn device(&self) -> Device

Get the device that created this heap.

C++ equivalent: Device* device() const

pub fn storage_mode(&self) -> StorageMode

Get the storage mode.

C++ equivalent: StorageMode storageMode() const

pub fn cpu_cache_mode(&self) -> CPUCacheMode

Get the CPU cache mode.

C++ equivalent: CPUCacheMode cpuCacheMode() const

pub fn hazard_tracking_mode(&self) -> HazardTrackingMode

Get the hazard tracking mode.

C++ equivalent: HazardTrackingMode hazardTrackingMode() const

pub fn resource_options(&self) -> ResourceOptions

Get the resource options.

C++ equivalent: ResourceOptions resourceOptions() const

pub fn size(&self) -> UInteger

Get the heap size in bytes.

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

pub fn used_size(&self) -> UInteger

Get the currently used size in bytes.

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

pub fn current_allocated_size(&self) -> UInteger

Get the current size available for new allocations.

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

pub fn max_available_size(&self, alignment: UInteger) -> UInteger

Get the maximum size available for new allocations.

C++ equivalent: NS::UInteger maxAvailableSize(NS::UInteger alignment)

pub fn heap_type(&self) -> HeapType

Get the heap type.

C++ equivalent: HeapType type() const

pub fn set_purgeable_state(&self, state: PurgeableState) -> PurgeableState

Set the purgeable state.

C++ equivalent: PurgeableState setPurgeableState(PurgeableState state)

pub fn new_buffer( &self, length: UInteger, options: ResourceOptions, ) -> Option<Buffer>

Create a buffer from the heap.

C++ equivalent: Buffer* newBuffer(NS::UInteger length, MTL::ResourceOptions options)

pub fn new_buffer_with_offset( &self, length: UInteger, options: ResourceOptions, offset: UInteger, ) -> Option<Buffer>

Create a buffer from the heap with offset.

C++ equivalent: Buffer* newBuffer(NS::UInteger length, MTL::ResourceOptions options, NS::UInteger offset)

pub unsafe fn new_texture(&self, descriptor: *const c_void) -> Option<Texture>

Create a texture from the heap.

C++ equivalent: Texture* newTexture(const TextureDescriptor*)

Safety

The descriptor pointer must be valid.

pub unsafe fn new_texture_with_offset( &self, descriptor: *const c_void, offset: UInteger, ) -> Option<Texture>

Create a texture from the heap with offset.

C++ equivalent: Texture* newTexture(const TextureDescriptor*, NS::UInteger offset)

Safety

The descriptor pointer must be valid.

pub fn new_acceleration_structure_with_size( &self, size: UInteger, ) -> Option<AccelerationStructure>

Create an acceleration structure from the heap with a given size.

C++ equivalent: AccelerationStructure* newAccelerationStructure(NS::UInteger size)

pub fn new_acceleration_structure( &self, descriptor: &AccelerationStructureDescriptor, ) -> Option<AccelerationStructure>

Create an acceleration structure from the heap with a descriptor.

C++ equivalent: AccelerationStructure* newAccelerationStructure(const AccelerationStructureDescriptor*)

pub fn new_acceleration_structure_with_size_and_offset( &self, size: UInteger, offset: UInteger, ) -> Option<AccelerationStructure>

Create an acceleration structure from the heap with size and offset.

C++ equivalent: AccelerationStructure* newAccelerationStructure(NS::UInteger size, NS::UInteger offset)

pub fn new_acceleration_structure_with_offset( &self, descriptor: &AccelerationStructureDescriptor, offset: UInteger, ) -> Option<AccelerationStructure>

Create an acceleration structure from the heap with descriptor and offset.

C++ equivalent: AccelerationStructure* newAccelerationStructure(const AccelerationStructureDescriptor*, NS::UInteger offset)

Trait Implementations

impl Clone for Heap

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 Heap

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

Formats the value using the given formatter.

impl Drop for Heap

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for Heap

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 Heap

impl Sync for Heap