AeonGames::MemoryPoolBuffer Class Reference

Abstract interface for a pool-based buffer allocator. More...

#include <aeongames/MemoryPoolBuffer.hpp>

Inheritance diagram for AeonGames::MemoryPoolBuffer:

Collaboration diagram for AeonGames::MemoryPoolBuffer:

Public Member Functions
virtual BufferAccessor	Allocate (size_t aSize)=0
	Allocate a sub-region from the memory pool.
virtual void	Reset ()=0
	Reset the pool, freeing all previous allocations.
virtual const Buffer &	GetBuffer () const =0
	Get a reference to the underlying Buffer.

Detailed Description

Abstract interface for a pool-based buffer allocator.

Definition at line 27 of file MemoryPoolBuffer.hpp.

Member Function Documentation

Allocate()

virtual BufferAccessor AeonGames::MemoryPoolBuffer::Allocate ( size_t aSize )

pure virtual

Allocate a sub-region from the memory pool.

Parameters

aSize

Number of bytes to allocate.

Returns

A BufferAccessor describing the allocated region.

Implemented in AeonGames::OpenGLMemoryPoolBuffer, and AeonGames::VulkanMemoryPoolBuffer.

GetBuffer()

virtual const Buffer & AeonGames::MemoryPoolBuffer::GetBuffer ( ) const

pure virtual

Get a reference to the underlying Buffer.

Returns

Const reference to the buffer.

Implemented in AeonGames::OpenGLMemoryPoolBuffer, and AeonGames::VulkanMemoryPoolBuffer.

Reset()

virtual void AeonGames::MemoryPoolBuffer::Reset ( )

pure virtual

Reset the pool, freeing all previous allocations.

Implemented in AeonGames::OpenGLMemoryPoolBuffer, and AeonGames::VulkanMemoryPoolBuffer.

---

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

• include/aeongames/MemoryPoolBuffer.hpp