Struct vk_alloc::Allocator

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

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

Implementations

impl<LT: Lifetime> Allocator<LT>

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

Creates a new allocator.

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

Allocates memory for a buffer.

pub 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).

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

Allocates memory on the allocator.

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

Frees the allocation.

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

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

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.