Struct gfx_memory::LinearAllocator

pub struct LinearAllocator<B: Backend> { /* fields omitted */ }

The LinearAllocator is best suited for short-lived allocations. The allocation strategy has minimal overhead and the implementation is fast. But holding a single block will completely stop memory recycling.

The linear allocator will internally create multiple lines. Each line is a gfx_hal::Backend::Memory from which multiple LinearBlocks are linearly allocated.

A new line is created if there is insufficient space to create a LinearBlock from the current line. New lines are created from scratch or taken from a pool of previously used lines. When lines have no allocated LinearBlocks remaining they are moved to a pool to be reused. This pool of unused lines is freed only when LinearAllocator::clear is called.

Implementations

impl<B: Backend> LinearAllocator<B>

pub fn new(
    memory_type: MemoryTypeId,
    memory_properties: Properties,
    config: LinearConfig,
    non_coherent_atom_size: Size
) -> Self

Create new LinearAllocator for memory_type with memory_properties specified, with config.

pub fn max_allocation(&self) -> Size

Maximum allocation size.

pub fn clear(&mut self, device: &B::Device) -> Size

Perform full cleanup of the allocated memory.

Trait Implementations

impl<B: Backend> Allocator<B> for LinearAllocator<B>

type Block = LinearBlock<B>

Block type returned by allocator.

const KIND: Kind

Allocator kind.

fn alloc(
    &mut self,
    device: &B::Device,
    size: Size,
    align: Size
) -> Result<(LinearBlock<B>, Size), AllocationError>

Allocate block of memory. On success returns allocated block and amount of memory consumed from device.

fn free(&mut self, device: &B::Device, block: Self::Block) -> Size

Free block of memory. Returns amount of memory returned to the device.

impl<B: Debug + Backend> Debug for LinearAllocator<B>

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

Formats the value using the given formatter.

impl<B: Backend> Drop for LinearAllocator<B>

fn drop(&mut self)

Executes the destructor for this type.