Struct gpu_alloc::GpuAllocator

pub struct GpuAllocator<M> { /* fields omitted */ }

Memory allocator for Vulkan-like APIs.

Implementations

impl<M> GpuAllocator<M> where
    M: MemoryBounds + 'static, 

pub fn new(config: Config, props: DeviceProperties<'_>) -> Self

Creates new instance of GpuAllocator. Provided DeviceProperties should match propertices of MemoryDevice that will be used with created GpuAllocator instance.

pub unsafe fn alloc(
    &mut self,
    device: &impl MemoryDevice<M>,
    request: Request
) -> Result<MemoryBlock<M>, AllocationError> where
    M: Clone, 

Allocates memory block from specified device according to the request.

Safety

• device must be one with DeviceProperties that were provided to create this GpuAllocator instance.
• Same device instance must be used for all interactions with one GpuAllocator instance and memory blocks allocated from it.

pub unsafe fn alloc_with_dedicated(
    &mut self,
    device: &impl MemoryDevice<M>,
    request: Request,
    dedicated: Dedicated
) -> Result<MemoryBlock<M>, AllocationError> where
    M: Clone, 

Allocates memory block from specified device according to the request. This function allows user to force specific allocation strategy. Improper use can lead to suboptimal performance or too large overhead. Prefer GpuAllocator::alloc if doubt.

Safety

• device must be one with DeviceProperties that were provided to create this GpuAllocator instance.
• Same device instance must be used for all interactions with one GpuAllocator instance and memory blocks allocated from it.

pub unsafe fn dealloc(
    &mut self,
    device: &impl MemoryDevice<M>,
    block: MemoryBlock<M>
)

Deallocates memory block previously allocated from this GpuAllocator instance.

Safety

• Memory block must have been allocated by this GpuAllocator instance
• device must be one with DeviceProperties that were provided to create this GpuAllocator instance
• Same device instance must be used for all interactions with one GpuAllocator instance and memory blocks allocated from it

pub unsafe fn cleanup(&mut self, device: &impl MemoryDevice<M>)

Deallocates leftover memory objects. Should be used before dropping.

Safety

• device must be one with DeviceProperties that were provided to create this GpuAllocator instance
• Same device instance must be used for all interactions with one GpuAllocator instance and memory blocks allocated from it

Trait Implementations

impl<M: Debug> Debug for GpuAllocator<M>

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

Formats the value using the given formatter.