Allocator¶

1

import "std/os/allocator";

StorageReport struct¶

Summary of the allocator's free storage at a glance

StorageReportFull struct¶

Detailed report of the allocator's free storage, broken down per leaf bin

Allocator struct¶

An offset allocator that hands out regions from a fixed-size storage area using binned free lists. It manages offsets into an external storage block rather than memory itself, which makes it useful for sub-allocating GPU buffers or other contiguous resources.

Constructors¶

ctor¶

1

public p Allocator.ctor(UInt32 size, UInt32 maxAllocas = 128 * 1024)

Construct an allocator managing a storage area of the given size

Parameters

dtor¶

1

public p Allocator.dtor()

Destruct the allocator, releasing its internal bookkeeping storage

Methods¶

allocate¶

1

public f<Allocation> Allocator.allocate(UInt32 size)

Allocate a region of the given size from the storage area

Parameters

Returns: Allocation — Allocation describing the reserved region

free¶

1

public p Allocator.free(Allocation allocation)

Return a previously allocated region to the allocator

Parameters

Functions¶

getStorageReport¶

1

public const f<StorageReport> getStorageReport()

Produce a summary report of the allocator's free storage

Returns: StorageReport — Storage report with total free space and largest free region

getStorageReportFull¶

1

public const f<StorageReportFull> getStorageReportFull()

Produce a detailed report of the allocator's free storage, broken down per leaf bin

Returns: StorageReportFull — Full storage report