Struct MkAllocatorRes 

pub struct MkAllocatorRes { /* private fields */ }

Bevy resource wrapping the memkit allocator.

Use this to access frame allocations in your systems:

fn my_system(alloc: Res<MkAllocatorRes>) {
    let data = alloc.frame_alloc::<MyStruct>();
    // data is valid until end of frame
}

Implementations

impl MkAllocatorRes

pub fn new(config: MkConfig) -> Self

Create a new allocator resource with the given config.

pub fn allocator(&self) -> &MkAllocator

Get a reference to the underlying allocator.

pub fn is_frame_active(&self) -> bool

Check if a frame is currently active.

pub fn frame_alloc<T>(&self) -> *mut T

Allocate a value in the current frame’s arena.

Returns a raw pointer to uninitialized memory. You must initialize it.

Panics

Panics if called outside of an active frame.

pub fn frame_slice<T>(&self, len: usize) -> Option<MkFrameSlice<'_, T>>

Allocate a slice in the current frame’s arena.

Returns an MkFrameSlice wrapper if successful.

pub fn frame_box<T>(&self, value: T) -> Option<MkFrameBox<'_, T>>

Allocate and initialize a value in the frame arena.

Returns an MkFrameBox wrapper if successful.

Methods from Deref<Target = MkAllocator>

pub fn config(&self) -> &MkConfig

Get the configuration.

pub fn begin_frame(&self)

Begin a new frame. Must be paired with end_frame().

pub fn end_frame(&self)

End the current frame. Resets frame arena.

pub fn frame(&self) -> u64

Get the current frame number.

pub fn frame_alloc<T>(&self) -> *mut T

Allocate from the frame arena.

pub fn frame_box<T>(&self, value: T) -> Option<MkFrameBox<'_, T>>

Allocate a value in the frame arena and return a box.

pub fn frame_slice<T>(&self, len: usize) -> Option<MkFrameSlice<'_, T>>

Allocate a slice in the frame arena.

pub fn frame_vec<T>(&self, capacity: usize) -> Option<MkFrameVec<'_, T>>

Allocate a vector in the frame arena with the given capacity.

pub fn pool_box<T>(&self, value: T) -> Option<MkPoolBox<T>>

Allocate from the pool.

pub fn heap_box<T>(&self, value: T) -> Option<MkHeapBox<T>>

Allocate from the heap.

pub fn scope(&self) -> MkScope<'_>

Create a scoped frame guard.

pub fn frame_head(&self) -> usize

Get the current frame head position (for checkpointing).

pub fn reset_frame_to(&self, pos: usize)

Reset frame to a checkpoint position.

pub fn stats(&self) -> GlobalStats

Get global statistics.

Trait Implementations

impl Deref for MkAllocatorRes

type Target = MkAllocator

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Resource for MkAllocatorRes

where Self: Send + Sync + 'static,