Struct ResidencySet 

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

A residency set for managing GPU memory residency.

C++ equivalent: MTL::ResidencySet

Implementations

impl ResidencySet

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

Create from a raw pointer.

Safety

The pointer must be a valid Metal ResidencySet.

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

Get the raw pointer.

pub fn device(&self) -> Device

Get the device that created this residency set.

C++ equivalent: Device* device() const

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

Get the label.

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

pub fn allocated_size(&self) -> u64

Get the allocated size in bytes.

C++ equivalent: uint64_t allocatedSize() const

pub fn allocation_count(&self) -> UInteger

Get the allocation count.

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

pub fn all_allocations_ptr(&self) -> *const c_void

Get all allocations as a raw NS::Array pointer.

C++ equivalent: NS::Array* allAllocations() const

pub fn add_allocation_ptr(&self, allocation: *const c_void)

Add an allocation using a raw pointer.

C++ equivalent: void addAllocation(const MTL::Allocation*)

pub fn add_allocations_ptr( &self, allocations: *const *const c_void, count: UInteger, )

Add multiple allocations.

C++ equivalent: void addAllocations(const MTL::Allocation* const[], NS::UInteger)

pub fn remove_allocation_ptr(&self, allocation: *const c_void)

Remove an allocation using a raw pointer.

C++ equivalent: void removeAllocation(const MTL::Allocation*)

pub fn remove_allocations_ptr( &self, allocations: *const *const c_void, count: UInteger, )

Remove multiple allocations.

C++ equivalent: void removeAllocations(const MTL::Allocation* const[], NS::UInteger)

pub fn remove_all_allocations(&self)

Remove all allocations.

C++ equivalent: void removeAllAllocations()

pub fn contains_allocation_ptr(&self, allocation: *const c_void) -> bool

Check if the set contains an allocation.

C++ equivalent: bool containsAllocation(const MTL::Allocation*)

pub fn request_residency(&self)

Request residency for all allocations in the set.

C++ equivalent: void requestResidency()

pub fn end_residency(&self)

End residency for all allocations in the set.

C++ equivalent: void endResidency()

pub fn commit(&self)

Commit changes to the residency set.

C++ equivalent: void commit()

Trait Implementations

impl Clone for ResidencySet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for ResidencySet

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for ResidencySet

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 ResidencySet

impl Sync for ResidencySet