Classes
struct	AllocationResult
	Result type for allocation operations. More...

struct	AllocatorStats
	Statistics for tracking allocator usage. More...

class	ArenaAllocator
	Lock-free, thread-safe arena allocator. More...

class	DoubleFrameAllocator
	Double-buffered frame allocator. More...

class	FrameAllocator
	Linear allocator that clears every frame. More...

class	FreeListAllocator
	Free list allocator with best-fit strategy. More...

class	GrowableAllocator
	Growable allocator adapter that automatically expands capacity. More...

class	NFrameAllocator
	N-buffered frame allocator. More...

class	PoolAllocator
	Pool allocator for fixed-size allocations. More...

class	StackAllocator
	Stack/linear allocator with LIFO deallocation support. More...

class	STLAllocatorAdapter
	STL-compatible allocator adapter for custom allocators. More...

Concepts
concept	Allocator
	Concept for basic allocator interface.

concept	ResettableAllocator
	Concept for allocators that can be reset/cleared.

concept	AllocatorWithStats
	Concept for allocators that provide statistics.

Typedefs
using	TripleFrameAllocator = NFrameAllocator< 3 >
	Triple-buffered frame allocator.

using	QuadFrameAllocator = NFrameAllocator< 4 >
	Quad-buffered frame allocator.

template<typename T >
using	STLFrameAllocator = STLAllocatorAdapter< T, FrameAllocator >

template<typename T >
using	STLPoolAllocator = STLAllocatorAdapter< T, PoolAllocator >

template<typename T >
using	STLStackAllocator = STLAllocatorAdapter< T, StackAllocator >

template<typename T >
using	STLFreeListAllocator = STLAllocatorAdapter< T, FreeListAllocator >

template<typename T , typename UnderlyingAlloc >
using	STLGrowableAllocator = STLAllocatorAdapter< T, GrowableAllocator< UnderlyingAlloc > >

Functions
constexpr size_t	AlignUp (size_t size, size_t alignment) noexcept
	Helper function to align a size up to the given alignment.

void *	AlignUpPtr (void *ptr, size_t alignment) noexcept
	Helper function to align a pointer up to the given alignment.

bool	IsAligned (const void *ptr, size_t alignment) noexcept
	Helper function to check if a pointer is aligned.

constexpr bool	IsPowerOfTwo (size_t size) noexcept
	Helper function to check if a size is a power of 2.

size_t	CalculatePadding (const void *ptr, size_t alignment) noexcept
	Calculate padding needed for alignment.

size_t	CalculatePaddingWithHeader (const void *ptr, size_t alignment, size_t header_size) noexcept
	Calculate padding with header for alignment.

template<typename T , Allocator Alloc>
constexpr T *	Allocate (Alloc &allocator) noexcept

template<typename T , Allocator Alloc>
constexpr T *	Allocate (Alloc &allocator, size_t count) noexcept

template<typename T , Allocator Alloc, typename... Args> requires std::constructible_from<T, Args...>
constexpr T *	AllocateAndConstruct (Alloc &allocator, Args &&... args) noexcept(std::is_nothrow_constructible_v< T, Args... >)

template<typename T , Allocator Alloc> requires std::default_initializable<T>
constexpr T *	AllocateAndConstructArray (Alloc &allocator, size_t count) noexcept(std::is_nothrow_default_constructible_v< T >)

void *	AlignedAlloc (size_t alignment, size_t size)
	Allocate memory with the specified alignment.

void	AlignedFree (void *ptr)
	Free memory allocated with AlignedAlloc.

Variables
constexpr size_t	kDefaultAlignment = 64
	Default alignment for allocations (cache line size for most modern CPUs).

constexpr size_t	kMinAlignment = alignof(std::max_align_t)
	Minimum alignment for any allocation.

Typedef Documentation

◆ QuadFrameAllocator

using helios::memory::QuadFrameAllocator = typedef NFrameAllocator<4>

Quad-buffered frame allocator.

Definition at line 323 of file n_frame_allocator.hpp.

◆ STLFrameAllocator

template<typename T >

using helios::memory::STLFrameAllocator = typedef STLAllocatorAdapter<T, FrameAllocator>

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 188 of file stl_allocator_adapter.hpp.

◆ STLFreeListAllocator

template<typename T >

using helios::memory::STLFreeListAllocator = typedef STLAllocatorAdapter<T, FreeListAllocator>

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 233 of file stl_allocator_adapter.hpp.

◆ STLGrowableAllocator

template<typename T , typename UnderlyingAlloc >

using helios::memory::STLGrowableAllocator = typedef STLAllocatorAdapter<T, GrowableAllocator<UnderlyingAlloc> >

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 251 of file stl_allocator_adapter.hpp.

◆ STLPoolAllocator

template<typename T >

using helios::memory::STLPoolAllocator = typedef STLAllocatorAdapter<T, PoolAllocator>

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 203 of file stl_allocator_adapter.hpp.

◆ STLStackAllocator

template<typename T >

using helios::memory::STLStackAllocator = typedef STLAllocatorAdapter<T, StackAllocator>

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 218 of file stl_allocator_adapter.hpp.

◆ TripleFrameAllocator

using helios::memory::TripleFrameAllocator = typedef NFrameAllocator<3>

Triple-buffered frame allocator.

Definition at line 322 of file n_frame_allocator.hpp.

Function Documentation

◆ AlignedAlloc()

void * helios::memory::AlignedAlloc	(	size_t	alignment,
		size_t	size
	)

inline

Allocate memory with the specified alignment.

Allocates a block of memory of the specified size aligned to the specified alignment boundary. The alignment must be a power of two and non-zero. The size must also be non-zero.

Uses _aligned_malloc on MSVC and std::aligned_alloc on other platforms.

Warning

Triggers assertion in next cases:

alignment is zero
alignment is not a power of two
size is zero

Parameters

alignment	The alignment in bytes (must be a power of two and non-zero).
size	The size of the memory block to allocate in bytes (must be non-zero).

Returns: A pointer to the allocated memory block.

Exceptions

std::bad_alloc if the allocation fails.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/pool_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp.

Definition at line 30 of file common.hpp.

                                                         {
  HELIOS_ASSERT(alignment != 0, "Failed to allocate memory: alignment cannot be zero!");
  HELIOS_ASSERT(IsPowerOfTwo(alignment), "Failed to allocate memory: alignment must be a power of two!");
  HELIOS_ASSERT(size != 0, "Failed to allocate memory: size cannot be zero!");
#ifdef _MSC_VER
  return _aligned_malloc(size, alignment);
#else
  // POSIX aligned_alloc requires size to be a multiple of alignment
  // Round up size to the next multiple of alignment
  return std::aligned_alloc(alignment, AlignUp(size, alignment));
#endif
}

◆ AlignedFree()

void helios::memory::AlignedFree ( void * ptr )

inline

Free memory allocated with AlignedAlloc.

Frees a block of memory allocated with AlignedAlloc. The ptr must be a pointer returned by AlignedAlloc.

Uses _aligned_free on MSVC and std::free on other platforms.

Warning: Triggers assertion if ptr is nullptr.

Parameters

ptr	The pointer to the memory block to free.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/pool_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp.

Definition at line 53 of file common.hpp.

                                   {
  HELIOS_ASSERT(ptr != nullptr, "Failed to free memory: pointer cannot be nullptr!");
#ifdef _MSC_VER
  _aligned_free(ptr);
#else
  std::free(ptr);
#endif
}

◆ AlignUp()

constexpr size_t helios::memory::AlignUp	(	size_t	size,
		size_t	alignment
	)

constexprnoexcept

Helper function to align a size up to the given alignment.

Parameters

size	Size to align
alignment	Alignment boundary (must be power of 2)

Returns: Aligned size

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/pool_allocator.hpp.

Definition at line 91 of file allocator_traits.hpp.

                                                                               {
  return (size + alignment - 1) & ~(alignment - 1);
}

◆ AlignUpPtr()

void * helios::memory::AlignUpPtr	(	void *	ptr,
		size_t	alignment
	)

inlinenoexcept

Helper function to align a pointer up to the given alignment.

Parameters

ptr	Pointer to align
alignment	Alignment boundary (must be power of 2)

Returns: Aligned pointer

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp.

Definition at line 101 of file allocator_traits.hpp.

                                                                            {
  const auto addr = reinterpret_cast<uintptr_t>(ptr);
  const auto aligned_addr = (addr + alignment - 1) & ~(alignment - 1);
  return reinterpret_cast<void*>(aligned_addr);
}

◆ Allocate() [1/2]

template<typename T , Allocator Alloc>

constexpr T * helios::memory::Allocate ( Alloc & allocator )

constexprnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/arena_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/growable_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/pool_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp.

Definition at line 183 of file allocator_traits.hpp.

                                                               {
  constexpr size_t size = sizeof(T);
  constexpr size_t alignment = std::max(alignof(T), kMinAlignment);
  auto result = allocator.Allocate(size, alignment);
  return static_cast<T*>(result.ptr);
}

◆ Allocate() [2/2]

template<typename T , Allocator Alloc>

constexpr T * helios::memory::Allocate	(	Alloc &	allocator,
		size_t	count
	)

constexprnoexcept

Definition at line 212 of file allocator_traits.hpp.

                                                                             {
  if (count == 0) [[unlikely]] {
    return nullptr;
  }
  constexpr size_t alignment = std::max(alignof(T), kMinAlignment);
  const size_t size = sizeof(T) * count;
  auto result = allocator.Allocate(size, alignment);
  return static_cast<T*>(result.ptr);
}

◆ AllocateAndConstruct()

template<typename T , Allocator Alloc, typename... Args>
requires std::constructible_from<T, Args...>

constexpr T * helios::memory::AllocateAndConstruct	(	Alloc &	allocator,
		Args &&...	args
	)

constexprnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp.

Definition at line 241 of file allocator_traits.hpp.

                                                                                                                    {
  T* ptr = Allocate<T>(allocator);
  if (ptr != nullptr) [[likely]] {
    std::construct_at(ptr, std::forward<Args>(args)...);
  }
  return ptr;
}

◆ AllocateAndConstructArray()

template<typename T , Allocator Alloc>
requires std::default_initializable<T>

constexpr T * helios::memory::AllocateAndConstructArray	(	Alloc &	allocator,
		size_t	count
	)

constexprnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp.

Definition at line 268 of file allocator_traits.hpp.

                                              {
  T* ptr = Allocate<T>(allocator, count);
  if (ptr != nullptr) [[likely]] {
    for (size_t i = 0; i < count; ++i) {
      std::construct_at(ptr + i);
    }
  }
  return ptr;
}

◆ CalculatePadding()

size_t helios::memory::CalculatePadding	(	const void *	ptr,
		size_t	alignment
	)

inlinenoexcept

Calculate padding needed for alignment.

Parameters

ptr	Current pointer
alignment	Desired alignment

Returns: Padding needed in bytes

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/arena_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp.

Definition at line 132 of file allocator_traits.hpp.

                                                                                         {
  const auto addr = reinterpret_cast<uintptr_t>(ptr);
  const auto aligned_addr = (addr + alignment - 1) & ~(alignment - 1);
  return aligned_addr - addr;
}

◆ CalculatePaddingWithHeader()

size_t helios::memory::CalculatePaddingWithHeader	(	const void *	ptr,
		size_t	alignment,
		size_t	header_size
	)

inlinenoexcept

Calculate padding with header for alignment.

Parameters

ptr	Current pointer
alignment	Desired alignment
header_size	Size of header to include

Returns: Padding needed in bytes

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp.

Definition at line 145 of file allocator_traits.hpp.

                                                                                                                       {
  const auto addr = reinterpret_cast<uintptr_t>(ptr);
  const auto aligned_addr = (addr + alignment - 1) & ~(alignment - 1);
  size_t padding = aligned_addr - addr;
 
  // Check if we need more padding to fit the header
  if (padding < header_size) {
    header_size -= padding;
    // Align header_size to alignment
    if (header_size % alignment > 0) {
      padding += alignment * (1 + (header_size / alignment));
    } else {
      padding += alignment * (header_size / alignment);
    }
  }
 
  return padding;
}

◆ IsAligned()

bool helios::memory::IsAligned	(	const void *	ptr,
		size_t	alignment
	)

inlinenoexcept

Helper function to check if a pointer is aligned.

Parameters

ptr	Pointer to check
alignment	Alignment boundary

Returns: True if pointer is aligned

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp.

Definition at line 113 of file allocator_traits.hpp.

                                                                                {
  return (reinterpret_cast<uintptr_t>(ptr) & (alignment - 1)) == 0;
}

◆ IsPowerOfTwo()

constexpr bool helios::memory::IsPowerOfTwo ( size_t size )

constexprnoexcept

Helper function to check if a size is a power of 2.

Parameters

size	Size to check

Returns: True if size is power of 2

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/arena_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/growable_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/pool_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp.

Definition at line 122 of file allocator_traits.hpp.

                                                                {
  return size != 0 && (size & (size - 1)) == 0;
}

Variable Documentation

◆ kDefaultAlignment

constexpr size_t helios::memory::kDefaultAlignment = 64

constexpr

Default alignment for allocations (cache line size for most modern CPUs).

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_resources.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/arena_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/growable_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/pool_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp.

Definition at line 78 of file allocator_traits.hpp.

◆ kMinAlignment

constexpr size_t helios::memory::kMinAlignment = alignof(std::max_align_t)

constexpr

Minimum alignment for any allocation.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/allocator_traits.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/arena_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/frame_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/free_list_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/growable_allocator.hpp, /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stack_allocator.hpp, and /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 83 of file allocator_traits.hpp.

	Helios Engine 0.1.0 A modular ECS based data-oriented C++23 game engine

Classes

Concepts

Typedefs

Functions

Variables

Typedef Documentation

◆ QuadFrameAllocator

◆ STLFrameAllocator

◆ STLFreeListAllocator

◆ STLGrowableAllocator

◆ STLPoolAllocator

◆ STLStackAllocator

◆ TripleFrameAllocator

Function Documentation

◆ AlignedAlloc()

◆ AlignedFree()

◆ AlignUp()

◆ AlignUpPtr()

◆ Allocate() [1/2]

◆ Allocate() [2/2]

◆ AllocateAndConstruct()

◆ AllocateAndConstructArray()

◆ CalculatePadding()

◆ CalculatePaddingWithHeader()

◆ IsAligned()

◆ IsPowerOfTwo()

Variable Documentation

◆ kDefaultAlignment

◆ kMinAlignment