Struct vk_mem::AllocationInfo

pub struct AllocationInfo { /* fields omitted */ }

Parameters of Allocation objects, that can be retrieved using Allocator::get_allocation_info.

Methods

impl AllocationInfo

pub fn get_memory_type(&self) -> u32

pub fn get_device_memory(&self) -> DeviceMemory

Handle to Vulkan memory object.

Same memory object can be shared by multiple allocations.

It can change after call to Allocator::defragment if this allocation is passed to the function, or if allocation is lost.

If the allocation is lost, it is equal to ash::vk::DeviceMemory::null().

pub fn get_offset(&self) -> usize

Offset into device memory object to the beginning of this allocation, in bytes. (self.get_device_memory(), self.get_offset()) pair is unique to this allocation.

It can change after call to Allocator::defragment if this allocation is passed to the function, or if allocation is lost.

pub fn get_size(&self) -> usize

Size of this allocation, in bytes.

It never changes, unless allocation is lost.

pub fn get_mapped_data(&self) -> *mut u8

Pointer to the beginning of this allocation as mapped data.

If the allocation hasn't been mapped using Allocator::map_memory and hasn't been created with AllocationCreateFlags::MAPPED flag, this value is null.

It can change after call to Allocator::map_memory, Allocator::unmap_memory. It can also change after call to Allocator::defragment if this allocation is passed to the function.

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

Custom general-purpose pointer that was passed as AllocationCreateInfo::user_data or set using Allocator::set_allocation_user_data.

It can change after a call to Allocator::set_allocation_user_data for this allocation.

Trait Implementations

impl Clone for AllocationInfo

fn clone(&self) -> AllocationInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Sync for AllocationInfo

impl Send for AllocationInfo

impl Debug for AllocationInfo

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

Formats the value using the given formatter.