Offset Allocator¶

1

import "std/os/offset-allocator";

Allocation struct¶

Fields¶

Region struct¶

One size class of the allocator's free storage, used by getStorageReportFull()

Fields¶

StorageReport struct¶

Summary of the allocator's free storage at a glance

Fields¶

StorageReportFull struct¶

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

Fields¶

Constructors¶

ctor¶

1

public p StorageReportFull.ctor()

Default-construct an empty full storage report; every entry is filled in by getStorageReportFull()

OffsetAllocator 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.

The allocator owns its bookkeeping storage (the node pool and free list), so it must not be shallow-copied; copying (via the copy ctor or operator=) allocates and deep-copies fresh bookkeeping storage.

Constructors¶

ctor¶

1

public p OffsetAllocator.ctor(unsigned int size, unsigned int maxAllocas = 128 * 1024)

Construct an allocator managing a storage area of the given size

Parameters

ctor¶

1

public p OffsetAllocator.ctor(const OffsetAllocator& original)

Construct an allocator as a deep copy of another allocator, so the two do not share bookkeeping storage

Parameters

dtor¶

1

public p OffsetAllocator.dtor()

Destruct the allocator, releasing its internal bookkeeping storage

Methods¶

allocate¶

1

public f<Allocation> OffsetAllocator.allocate(unsigned int size)

Allocate a region of the given size from the storage area

Parameters

Returns: Allocation — Allocation describing the reserved region

free¶

1

public p OffsetAllocator.free(Allocation allocation)

Return a previously allocated region to the allocator

Parameters

getStorageReport¶

1

public const f<StorageReport> OffsetAllocator.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> OffsetAllocator.getStorageReportFull()

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

Returns: StorageReportFull — Full storage report

Operators¶

operator=¶

1

public p operator=(OffsetAllocator& this, const OffsetAllocator& newValue)

Copy-assign the bookkeeping storage of another allocator into this one

Parameters