Struct vk_alloc::Allocator

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

The general purpose memory allocator. Implemented as a segregated list allocator.

Implementations

impl<LT: Lifetime> Allocator<LT>

pub unsafe fn new(
    instance: &InstanceLoader,
    physical_device: PhysicalDevice,
    descriptor: &AllocatorDescriptor
) -> Result<Self, AllocatorError>

Creates a new allocator.

Safety

Caller needs to make sure that the provided instance and device are in a valid state.

pub unsafe fn allocate_memory_for_buffer(
    &self,
    device: &DeviceLoader,
    buffer: Buffer,
    location: MemoryLocation,
    lifetime: LT
) -> Result<Allocation<LT>, AllocatorError>

Allocates memory for a buffer.

Safety

Caller needs to make sure that the provided device and buffer are in a valid state.

pub unsafe fn allocate_memory_for_image(
    &self,
    device: &DeviceLoader,
    image: Image,
    location: MemoryLocation,
    lifetime: LT,
    is_optimal: bool
) -> Result<Allocation<LT>, AllocatorError>

Allocates memory for an image. is_optimal must be set true if the image is a optimal image (a regular texture).

Safety

Caller needs to make sure that the provided device and image are in a valid state.

pub unsafe fn allocate(
    &self,
    device: &DeviceLoader,
    descriptor: &AllocationDescriptor<LT>
) -> Result<Allocation<LT>, AllocatorError>

Allocates memory on the allocator.

Safety

Caller needs to make sure that the provided device is in a valid state.

pub unsafe fn deallocate(
    &self,
    device: &DeviceLoader,
    allocation: &Allocation<LT>
) -> Result<(), AllocatorError>

Frees the allocation.

Safety

Caller needs to make sure that the allocation is not in use anymore and will not be used after being deallocated.

pub unsafe fn cleanup(&self, device: &DeviceLoader)

Releases all memory blocks back to the system. Should be called before drop.

Safety

Caller needs to make sure that no allocations are used anymore and will not being used after calling this function.

pub fn allocation_count(&self) -> usize

Number of allocations.

pub fn unused_range_count(&self) -> usize

Number of unused ranges between allocations.

pub fn used_bytes(&self) -> DeviceSize

Number of bytes used by the allocations.

pub fn unused_bytes(&self) -> DeviceSize

Number of bytes used by the unused ranges between allocations.

pub fn block_count(&self) -> usize

Number of allocated Vulkan memory blocks.

Trait Implementations

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

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

Formats the value using the given formatter.