Support Forum       G3D Web Page     
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
G3D::MemoryManager Class Reference

Abstraction of memory management. More...

Inherits G3D::ReferenceCountedObject.

Inherited by G3D::AlignedMemoryManager, G3D::AreaMemoryManager, G3D::BufferUnmapper, and G3D::CRTMemoryManager.

Public Member Functions

virtual void * alloc (size_t s)
 Return a pointer to s bytes of memory that are unused by the rest of the program. More...
 
virtual void free (void *ptr)
 Invoke to declare that this memory will no longer be used by the program. More...
 
virtual bool isThreadsafe () const
 Returns true if this memory manager is threadsafe (i.e., alloc and free can be called asychronously) More...
 

Static Public Member Functions

static shared_ptr< MemoryManagercreate ()
 Return the instance. More...
 

Protected Member Functions

 MemoryManager ()
 

Static Protected Member Functions

template<class T , class ... ArgTypes>
static shared_ptr< T > createShared (ArgTypes &&... args)
 Like std::make_shared, but works for protected constructors. More...
 

Detailed Description

Abstraction of memory management.

Default implementation uses G3D::System::malloc and is threadsafe.

See also
LargePoolMemoryManager, CRTMemoryManager, AlignedMemoryManager, AreaMemoryManager

Constructor & Destructor Documentation

◆ MemoryManager()

G3D::MemoryManager::MemoryManager ( )
protected

Member Function Documentation

◆ alloc()

virtual void* G3D::MemoryManager::alloc ( size_t  s)
virtual

Return a pointer to s bytes of memory that are unused by the rest of the program.

The contents of the memory are undefined

Reimplemented in G3D::BufferUnmapper, G3D::CRTMemoryManager, G3D::AreaMemoryManager, and G3D::AlignedMemoryManager.

◆ create()

static shared_ptr<MemoryManager> G3D::MemoryManager::create ( )
static

Return the instance.

There's only one instance of the default MemoryManager; it is cached after the first creation.

Referenced by G3D::Array< G3D::AABox >::Array(), G3D::categorizeByDerivedType(), and G3D::Table< String, double >::Table().

◆ createShared()

template<class T , class ... ArgTypes>
static shared_ptr<T> G3D::ReferenceCountedObject::createShared ( ArgTypes &&...  args)
inlinestaticprotectedinherited

Like std::make_shared, but works for protected constructors.

Call as createShared<myclass>.

◆ free()

virtual void G3D::MemoryManager::free ( void *  ptr)
virtual

Invoke to declare that this memory will no longer be used by the program.

The memory manager is not required to actually reuse or release this memory.

Reimplemented in G3D::BufferUnmapper, G3D::CRTMemoryManager, G3D::AreaMemoryManager, and G3D::AlignedMemoryManager.

◆ isThreadsafe()

virtual bool G3D::MemoryManager::isThreadsafe ( ) const
virtual

Returns true if this memory manager is threadsafe (i.e., alloc and free can be called asychronously)

Reimplemented in G3D::BufferUnmapper, G3D::CRTMemoryManager, G3D::AreaMemoryManager, and G3D::AlignedMemoryManager.


documentation generated on Wed Nov 24 2021 08:01:58 using doxygen 1.8.15