Struct vk_alloc::Allocation

pub struct Allocation<LT: Lifetime> { /* private fields */ }

An allocation of the Allocator.

Implementations

impl<LT: Lifetime> Allocation<LT>

pub fn device_memory(&self) -> DeviceMemory

The DeviceMemory of the allocation. Managed by the allocator.

pub fn offset(&self) -> DeviceSize

The offset inside the DeviceMemory.

pub fn size(&self) -> DeviceSize

The size of the allocation.

pub unsafe fn mapped_slice(&self) -> Result<Option<&[u8]>, AllocatorError>

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 sub allocation, so no offset needs to be applied.

Safety

Caller needs to make sure that the allocation is still valid and coherent.

pub unsafe fn mapped_slice_mut(
    &mut self
) -> Result<Option<&mut [u8]>, AllocatorError>

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 sub allocation, so no offset needs to be applied.

Safety

Caller needs to make sure that the allocation is still valid and coherent.

Trait Implementations

impl<LT: Clone + Lifetime> Clone for Allocation<LT>

fn clone(&self) -> Allocation<LT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<LT: Debug + Lifetime> Debug for Allocation<LT>

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

Formats the value using the given formatter.

impl<LT: Lifetime> Send for Allocation<LT>

impl<LT: Lifetime> Sync for Allocation<LT>