Struct ccthw_ash_allocator::Allocation

pub struct Allocation { /* private fields */ }

A GPU memory allocation.

Implementations

impl Allocation

pub unsafe fn memory(&self) -> DeviceMemory

The underlying Vulkan memory handle.

Safety

Unsafe because the allocation logically owns the device memory. It is incorrect to free the memory by any means other than to return the full allocation instance to the memory allocator.

pub fn offset_in_bytes(&self) -> DeviceSize

The offset where this allocation begins in device memory.

This is needed because some memory allocator implementations will subdivide big regions of GPU memory into smaller allocations. Therefore the actual device memory handle can be shared by many allocations.

pub fn size_in_bytes(&self) -> DeviceSize

The size of the allocation in bytes.

pub fn allocation_requirements(&self) -> &AllocationRequirements

The allocation requirements used when acquiring the device memory.

pub unsafe fn map(&self, device: &Device) -> Result<*mut c_void, AllocatorError>

Map the allocation into application address space.

Safety

Unsafe because:

• The application must synchronize access to the underlying device memory. All previously submitted GPU commands which write to the memory owned by this alloctaion must be finished before the host reads or writes from the mapped pointer.
• Synchronization requirements vary depending on the HOST_COHERENT memory property. See the Vulkan spec for details.

For details, see the specification at: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkMapMemory.html

pub unsafe fn unmap(&self, device: &Device) -> Result<(), AllocatorError>

Unmap the allocation.

Safety

Unsafe because:

• The pointer returned by map() must not be used after the call to unmap()
• The application must synchronize all host access to the allocation.

Trait Implementations

impl Clone for Allocation

fn clone(&self) -> Allocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Allocation

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

Formats the value using the given formatter.

impl Display for Allocation

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

Formats the value using the given formatter.