Struct gpu_allocator::SubAllocation

pub struct SubAllocation { /* fields omitted */ }

Implementations

impl SubAllocation

pub unsafe fn memory(&self) -> DeviceMemory

Returns the vk::DeviceMemory object that is backing this allocation. This memory object can be shared with multiple other allocations and shouldn’t be free’d (or allocated from) without this library, because that will lead to undefined behavior.

Safety

The result of this function can safely be used to pass into bind_buffer_memory (vkBindBufferMemory), bind_texture_memory (vkBindTextureMemory) etc. It’s exposed for this reason. Keep in mind to also pass Self::offset() along to those.

pub fn offset(&self) -> u64

Returns the offset of the allocation on the vk::DeviceMemory. When binding the memory to a buffer or image, this offset needs to be supplied as well.

pub fn size(&self) -> u64

Returns the size of the allocation

pub unsafe fn mapped_ptr(&self) -> Option<NonNull<c_void>>

Returns a valid mapped pointer if the memory is host visible, otherwise it will return None. The pointer already points to the exact memory region of the suballocation, so no offset needs to be applied.

Safety

Be careful not to mutably alias with this pointer; safety cannot be guaranteed, particularly over multiple threads.

pub fn mapped_slice(&self) -> Option<&[u8]>

Returns a valid mapped slice if the memory is host visible, otherwise it will return None. The slice already references the exact memory region of the suballocation, so no offset needs to be applied.

pub fn mapped_slice_mut(&mut self) -> Option<&mut [u8]>

Returns a valid mapped mutable slice if the memory is host visible, otherwise it will return None. The slice already references the exact memory region of the suballocation, so no offset needs to be applied.

pub fn is_null(&self) -> bool

Trait Implementations

impl Clone for SubAllocation

fn clone(&self) -> SubAllocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubAllocation

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

Formats the value using the given formatter.

impl Default for SubAllocation

fn default() -> Self

Returns the “default value” for a type.

impl Send for SubAllocation

impl Sync for SubAllocation