Foundation::Core::AllocatorHeap Class Reference

General purpose heap allocator. More...

#include <AllocatorHeap.hpp>

Inheritance diagram for Foundation::Core::AllocatorHeap:

Public Member Functions
pointer	Allocate (size_type size, size_t alignment) noexcept override
void	Deallocate (pointer ptr) noexcept override
pointer	Reallocate (pointer ptr, size_type new_size, size_t alignment) noexcept override
Public Member Functions inherited from Foundation::Core::Allocator
virtual	~Allocator ()=default
Arena	AllocateArena (size_type size, size_t alignment)
Arena	AllocateArena (size_type size)
void	DeallocateArena (Arena arena)
Allocator *	Ptr ()

Detailed Description

General purpose heap allocator.

Note

By default, this allocator uses mimalloc for memory management - which can be overridden by defining FOUNDATION_OS_ALLOCATOR to use the OS's default allocator.

As mimalloc/OS allocators are thread-safe by default, so is this allocator.

Queried values will reflect the global state of the underlying allocator.

Member Function Documentation

Allocate()

pointer Foundation::Core::AllocatorHeap::Allocate ( size_type  size, size_t  alignment  )

overridevirtualnoexcept

Implements Foundation::Core::Allocator.

Deallocate()

void Foundation::Core::AllocatorHeap::Deallocate ( pointer  ptr )

overridevirtualnoexcept

Implements Foundation::Core::Allocator.

Reallocate()

pointer Foundation::Core::AllocatorHeap::Reallocate ( pointer  ptr, size_type  new_size, size_t  alignment  )

overridevirtualnoexcept

Implements Foundation::Core::Allocator.

---

The documentation for this class was generated from the following files:

• Source/Core/AllocatorHeap.hpp
• Source/Core/AllocatorHeap.cpp