Memory

Files
file	OgreMemoryAllocatorConfig.h
	This file configures Ogre's memory allocators.

Namespaces
namespace	Ogre

Classes
class	Ogre::AlignedMemory
	Class to provide aligned memory allocate functionality. More...
class	Ogre::AllocatedObject< Alloc >
	Superclass for all objects that wish to use custom memory allocators when their new / delete operators are called. More...
class	Ogre::ArrayMemoryManager
	Abstract memory manager for managing large chunks of contiguous memory, optimized for SoA (Structure of Arrays) implementations. More...
class	Ogre::BoneArrayMemoryManager
	Implementation to create the Transform variables needed by Bones. More...
class	Ogre::BoneMemoryManager
	Wrap-around class that contains multiple ArrayMemoryManager, one per hierarchy depth. More...
class	Ogre::NodeArrayMemoryManager
	Implementation to create the Transform variables needed by Nodes & SceneNodes. More...
class	Ogre::NodeMemoryManager
	Wrap-around class that contains multiple ArrayMemoryManager, one per hierarchy depth. More...
class	Ogre::ObjectDataArrayMemoryManager
	Implementation to create the ObjectData variables needed by MovableObjects. More...
class	Ogre::ObjectMemoryManager
	Wrap-around class that contains multiple ArrayMemoryManager, one per render queue. More...
class	Ogre::STLAllocator< T, AllocPolicy >
struct	Ogre::STLAllocatorBase< T >
	Wrapper class for operating as an STL container allocator. More...
struct	Ogre::STLAllocatorBase< const T >

Macros
#define	OGRE_ALLOC_T(T, count, category)   static_cast<T*>(::Ogre::CategorisedAllocPolicy<category>::allocateBytes(sizeof(T)*(count)))
	Allocate a block of memory for a primitive type, and indicate the category of usage.
#define	OGRE_ALLOC_T_ALIGN(T, count, category, align)   static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(sizeof(T)*(count)))
	Allocate a block of memory for a primitive type aligned to user defined boundaries, and indicate the category of usage.
#define	OGRE_ALLOC_T_SIMD(T, count, category)   static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(sizeof(T)*(count)))
	Allocate a block of memory for a primitive type aligned to SIMD boundaries, and indicate the category of usage.
#define	OGRE_DELETE   delete
#define	OGRE_DELETE_ARRAY_T(ptr, T, count, category)   if(ptr){for (size_t b = 0; b < count; ++b) { (ptr)[b].~T();} ::Ogre::CategorisedAllocPolicy<category>::deallocateBytes((void*)ptr);}
	Free the memory allocated with OGRE_NEW_ARRAY_T. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.
#define	OGRE_DELETE_ARRAY_T_ALIGN(ptr, T, count, category, align)   if(ptr){for (size_t _b = 0; _b < count; ++_b) { (ptr)[_b].~T();} ::Ogre::CategorisedAlignAllocPolicy<category, align>::deallocateBytes((void*)ptr);}
	Free the memory allocated with OGRE_NEW_ARRAY_T_ALIGN. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.
#define	OGRE_DELETE_ARRAY_T_SIMD(ptr, T, count, category)   if(ptr){for (size_t b = 0; b < count; ++b) { (ptr)[b].~T();} ::Ogre::CategorisedAlignAllocPolicy<category>::deallocateBytes((void*)ptr);}
	Free the memory allocated with OGRE_NEW_ARRAY_T_SIMD. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.
#define	OGRE_DELETE_T(ptr, T, category)   if(ptr){(ptr)->~T(); ::Ogre::CategorisedAllocPolicy<category>::deallocateBytes((void*)ptr);}
	Free the memory allocated with OGRE_NEW_T. Category is required to be restated to ensure the matching policy is used.
#define	OGRE_DELETE_T_ALIGN(ptr, T, category, align)   if(ptr){(ptr)->~T(); ::Ogre::CategorisedAlignAllocPolicy<category, align>::deallocateBytes((void*)ptr);}
	Free the memory allocated with OGRE_NEW_T_ALIGN. Category is required to be restated to ensure the matching policy is used.
#define	OGRE_DELETE_T_SIMD(ptr, T, category)   if(ptr){(ptr)->~T(); ::Ogre::CategorisedAlignAllocPolicy<category>::deallocateBytes((void*)ptr);}
	Free the memory allocated with OGRE_NEW_T_SIMD. Category is required to be restated to ensure the matching policy is used.
#define	OGRE_FREE(ptr, category)   ::Ogre::CategorisedAllocPolicy<category>::deallocateBytes((void*)ptr)
	Free the memory allocated with OGRE_MALLOC or OGRE_ALLOC_T. Category is required to be restated to ensure the matching policy is used.
#define	OGRE_FREE_ALIGN(ptr, category, align)   ::Ogre::CategorisedAlignAllocPolicy<category, align>::deallocateBytes((void*)ptr)
	Free the memory allocated with either OGRE_MALLOC_ALIGN or OGRE_ALLOC_T_ALIGN. Category is required to be restated to ensure the matching policy is used.
#define	OGRE_FREE_SIMD(ptr, category)   ::Ogre::CategorisedAlignAllocPolicy<category>::deallocateBytes((void*)ptr)
	Free the memory allocated with either OGRE_MALLOC_SIMD or OGRE_ALLOC_T_SIMD. Category is required to be restated to ensure the matching policy is used.
#define	OGRE_MALLOC(bytes, category)   ::Ogre::CategorisedAllocPolicy<category>::allocateBytes(bytes)
	Allocate a block of raw memory, and indicate the category of usage.
#define	OGRE_MALLOC_ALIGN(bytes, category, align)   ::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(bytes)
	Allocate a block of raw memory aligned to user defined boundaries, and indicate the category of usage.
#define	OGRE_MALLOC_SIMD(bytes, category)   ::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(bytes)
	Allocate a block of raw memory aligned to SIMD boundaries, and indicate the category of usage.
#define	OGRE_NEW   new
#define	OGRE_NEW_ARRAY_T(T, count, category)   ::Ogre::constructN(static_cast<T*>(::Ogre::CategorisedAllocPolicy<category>::allocateBytes(sizeof(T)*(count))), count)
	Allocate a block of memory for 'count' primitive types - do not use for classes that inherit from AllocatedObject.
#define	OGRE_NEW_ARRAY_T_ALIGN(T, count, category, align)   ::Ogre::constructN(static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(sizeof(T)*(count))), count)
	Allocate a block of memory for 'count' primitive types aligned to user defined boundaries - do not use for classes that inherit from AllocatedObject.
#define	OGRE_NEW_ARRAY_T_SIMD(T, count, category)   ::Ogre::constructN(static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(sizeof(T)*(count))), count)
	Allocate a block of memory for 'count' primitive types aligned to SIMD boundaries - do not use for classes that inherit from AllocatedObject.
#define	OGRE_NEW_T(T, category)   new (::Ogre::CategorisedAllocPolicy<category>::allocateBytes(sizeof(T))) T
	Allocate space for one primitive type, external type or non-virtual type with constructor parameters.
#define	OGRE_NEW_T_ALIGN(T, category, align)   new (::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(sizeof(T))) T
	Allocate space for one primitive type, external type or non-virtual type aligned to user defined boundaries.
#define	OGRE_NEW_T_SIMD(T, category)   new (::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(sizeof(T))) T
	Allocate space for one primitive type, external type or non-virtual type aligned to SIMD boundaries.

Typedefs
typedef void(*	Ogre::CleanupRoutines) (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)

Enumerations
enum	Ogre::MemoryCategory {   Ogre::MEMCATEGORY_GENERAL = 0 , Ogre::MEMCATEGORY_GEOMETRY = 1 , Ogre::MEMCATEGORY_ANIMATION = 2 , Ogre::MEMCATEGORY_SCENE_CONTROL = 3 ,   Ogre::MEMCATEGORY_SCENE_OBJECTS = 4 , Ogre::MEMCATEGORY_RESOURCE = 5 , Ogre::MEMCATEGORY_SCRIPTING = 6 , Ogre::MEMCATEGORY_RENDERSYS = 7 ,   Ogre::MEMCATEGORY_COUNT = 8 }
	A set of categories that indicate the purpose of a chunk of memory being allocated. More...

Functions
void	Ogre::cleanerArrayAabb (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)
void	Ogre::cleanerArrayQuaternion (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)
void	Ogre::cleanerArrayVector3Unit (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)
void	Ogre::cleanerArrayVector3Zero (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)
void	Ogre::cleanerFlat (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)
template<typename T >
T *	Ogre::constructN (T *basePtr, size_t count)
	Utility function for constructing an array of objects with placement new, without using new[] (which allocates an undocumented amount of extra memory and so isn't appropriate for custom allocators).
template<typename T , typename P , typename OtherAllocator >
bool	Ogre::operator!= (STLAllocator< T, P > const &, OtherAllocator const &)
	determine equality, can memory from another allocator be released by this allocator, (ISO C++)
template<typename T , typename T2 , typename P >
bool	Ogre::operator!= (STLAllocator< T, P > const &, STLAllocator< T2, P > const &)
	determine equality, can memory from another allocator be released by this allocator, (ISO C++)
template<typename T , typename P , typename OtherAllocator >
bool	Ogre::operator== (STLAllocator< T, P > const &, OtherAllocator const &)
	determine equality, can memory from another allocator be released by this allocator, (ISO C++)
template<typename T , typename T2 , typename P >
bool	Ogre::operator== (STLAllocator< T, P > const &, STLAllocator< T2, P > const &)
	determine equality, can memory from another allocator be released by this allocator, (ISO C++)

Detailed Description

Macro Definition Documentation

OGRE_ALLOC_T

#define OGRE_ALLOC_T	(		T,
			count,
			category
	)		static_cast<T*>(::Ogre::CategorisedAllocPolicy<category>::allocateBytes(sizeof(T)*(count)))

Allocate a block of memory for a primitive type, and indicate the category of usage.

OGRE_ALLOC_T_ALIGN

#define OGRE_ALLOC_T_ALIGN	(		T,
			count,
			category,
			align
	)		static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(sizeof(T)*(count)))

Allocate a block of memory for a primitive type aligned to user defined boundaries, and indicate the category of usage.

OGRE_ALLOC_T_SIMD

#define OGRE_ALLOC_T_SIMD	(		T,
			count,
			category
	)		static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(sizeof(T)*(count)))

Allocate a block of memory for a primitive type aligned to SIMD boundaries, and indicate the category of usage.

OGRE_DELETE

#define OGRE_DELETE   delete

OGRE_DELETE_ARRAY_T

#define OGRE_DELETE_ARRAY_T	(		ptr,
			T,
			count,
			category
	)		if(ptr){for (size_t b = 0; b < count; ++b) { (ptr)[b].~T();} ::Ogre::CategorisedAllocPolicy<category>::deallocateBytes((void*)ptr);}

Free the memory allocated with OGRE_NEW_ARRAY_T. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.

OGRE_DELETE_ARRAY_T_ALIGN

#define OGRE_DELETE_ARRAY_T_ALIGN	(		ptr,
			T,
			count,
			category,
			align
	)		if(ptr){for (size_t _b = 0; _b < count; ++_b) { (ptr)[_b].~T();} ::Ogre::CategorisedAlignAllocPolicy<category, align>::deallocateBytes((void*)ptr);}

Free the memory allocated with OGRE_NEW_ARRAY_T_ALIGN. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.

OGRE_DELETE_ARRAY_T_SIMD

#define OGRE_DELETE_ARRAY_T_SIMD	(		ptr,
			T,
			count,
			category
	)		if(ptr){for (size_t b = 0; b < count; ++b) { (ptr)[b].~T();} ::Ogre::CategorisedAlignAllocPolicy<category>::deallocateBytes((void*)ptr);}

Free the memory allocated with OGRE_NEW_ARRAY_T_SIMD. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.

OGRE_DELETE_T

#define OGRE_DELETE_T	(		ptr,
			T,
			category
	)		if(ptr){(ptr)->~T(); ::Ogre::CategorisedAllocPolicy<category>::deallocateBytes((void*)ptr);}

Free the memory allocated with OGRE_NEW_T. Category is required to be restated to ensure the matching policy is used.

OGRE_DELETE_T_ALIGN

#define OGRE_DELETE_T_ALIGN	(		ptr,
			T,
			category,
			align
	)		if(ptr){(ptr)->~T(); ::Ogre::CategorisedAlignAllocPolicy<category, align>::deallocateBytes((void*)ptr);}

Free the memory allocated with OGRE_NEW_T_ALIGN. Category is required to be restated to ensure the matching policy is used.

OGRE_DELETE_T_SIMD

#define OGRE_DELETE_T_SIMD	(		ptr,
			T,
			category
	)		if(ptr){(ptr)->~T(); ::Ogre::CategorisedAlignAllocPolicy<category>::deallocateBytes((void*)ptr);}

Free the memory allocated with OGRE_NEW_T_SIMD. Category is required to be restated to ensure the matching policy is used.

OGRE_FREE

#define OGRE_FREE	(		ptr,
			category
	)		::Ogre::CategorisedAllocPolicy<category>::deallocateBytes((void*)ptr)

Free the memory allocated with OGRE_MALLOC or OGRE_ALLOC_T. Category is required to be restated to ensure the matching policy is used.

OGRE_FREE_ALIGN

#define OGRE_FREE_ALIGN	(		ptr,
			category,
			align
	)		::Ogre::CategorisedAlignAllocPolicy<category, align>::deallocateBytes((void*)ptr)

Free the memory allocated with either OGRE_MALLOC_ALIGN or OGRE_ALLOC_T_ALIGN. Category is required to be restated to ensure the matching policy is used.

OGRE_FREE_SIMD

#define OGRE_FREE_SIMD	(		ptr,
			category
	)		::Ogre::CategorisedAlignAllocPolicy<category>::deallocateBytes((void*)ptr)

Free the memory allocated with either OGRE_MALLOC_SIMD or OGRE_ALLOC_T_SIMD. Category is required to be restated to ensure the matching policy is used.

OGRE_MALLOC

#define OGRE_MALLOC	(		bytes,
			category
	)		::Ogre::CategorisedAllocPolicy<category>::allocateBytes(bytes)

Allocate a block of raw memory, and indicate the category of usage.

OGRE_MALLOC_ALIGN

#define OGRE_MALLOC_ALIGN	(		bytes,
			category,
			align
	)		::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(bytes)

Allocate a block of raw memory aligned to user defined boundaries, and indicate the category of usage.

OGRE_MALLOC_SIMD

#define OGRE_MALLOC_SIMD	(		bytes,
			category
	)		::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(bytes)

Allocate a block of raw memory aligned to SIMD boundaries, and indicate the category of usage.

OGRE_NEW

#define OGRE_NEW   new

OGRE_NEW_ARRAY_T

#define OGRE_NEW_ARRAY_T	(		T,
			count,
			category
	)		::Ogre::constructN(static_cast<T*>(::Ogre::CategorisedAllocPolicy<category>::allocateBytes(sizeof(T)*(count))), count)

Allocate a block of memory for 'count' primitive types - do not use for classes that inherit from AllocatedObject.

OGRE_NEW_ARRAY_T_ALIGN

#define OGRE_NEW_ARRAY_T_ALIGN	(		T,
			count,
			category,
			align
	)		::Ogre::constructN(static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(sizeof(T)*(count))), count)

Allocate a block of memory for 'count' primitive types aligned to user defined boundaries - do not use for classes that inherit from AllocatedObject.

OGRE_NEW_ARRAY_T_SIMD

#define OGRE_NEW_ARRAY_T_SIMD	(		T,
			count,
			category
	)		::Ogre::constructN(static_cast<T*>(::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(sizeof(T)*(count))), count)

Allocate a block of memory for 'count' primitive types aligned to SIMD boundaries - do not use for classes that inherit from AllocatedObject.

OGRE_NEW_T

#define OGRE_NEW_T	(		T,
			category
	)		new (::Ogre::CategorisedAllocPolicy<category>::allocateBytes(sizeof(T))) T

Allocate space for one primitive type, external type or non-virtual type with constructor parameters.

OGRE_NEW_T_ALIGN

#define OGRE_NEW_T_ALIGN	(		T,
			category,
			align
	)		new (::Ogre::CategorisedAlignAllocPolicy<category, align>::allocateBytes(sizeof(T))) T

Allocate space for one primitive type, external type or non-virtual type aligned to user defined boundaries.

OGRE_NEW_T_SIMD

#define OGRE_NEW_T_SIMD	(		T,
			category
	)		new (::Ogre::CategorisedAlignAllocPolicy<category>::allocateBytes(sizeof(T))) T

Allocate space for one primitive type, external type or non-virtual type aligned to SIMD boundaries.

Typedef Documentation

CleanupRoutines

typedef void(* Ogre::CleanupRoutines) (char *dstPtr, size_t indexDst, char *srcPtr, size_t indexSrc, size_t numSlots, size_t numFreeSlots, size_t elementsMemSize)

Enumeration Type Documentation

MemoryCategory

enum Ogre::MemoryCategory

A set of categories that indicate the purpose of a chunk of memory being allocated.

These categories will be provided at allocation time in order to allow the allocation policy to vary its behaviour if it wishes. This allows you to use a single policy but still have variant behaviour. The level of control it gives you is at a higher level than assigning different policies to different classes, but is the only control you have over general allocations that are primitive types.

Enumerator
MEMCATEGORY_GENERAL	General purpose.
MEMCATEGORY_GEOMETRY	Geometry held in main memory.
MEMCATEGORY_ANIMATION	Animation data like tracks, bone matrices.
MEMCATEGORY_SCENE_CONTROL	Nodes, control data.
MEMCATEGORY_SCENE_OBJECTS	Scene object instances.
MEMCATEGORY_RESOURCE	Other resources.
MEMCATEGORY_SCRIPTING	Scripting.
MEMCATEGORY_RENDERSYS	Rendersystem structures.
MEMCATEGORY_COUNT

Function Documentation

cleanerArrayAabb()

void Ogre::cleanerArrayAabb ( char *  dstPtr, size_t  indexDst, char *  srcPtr, size_t  indexSrc, size_t  numSlots, size_t  numFreeSlots, size_t  elementsMemSize  )

extern

cleanerArrayQuaternion()

void Ogre::cleanerArrayQuaternion ( char *  dstPtr, size_t  indexDst, char *  srcPtr, size_t  indexSrc, size_t  numSlots, size_t  numFreeSlots, size_t  elementsMemSize  )

extern

cleanerArrayVector3Unit()

void Ogre::cleanerArrayVector3Unit ( char *  dstPtr, size_t  indexDst, char *  srcPtr, size_t  indexSrc, size_t  numSlots, size_t  numFreeSlots, size_t  elementsMemSize  )

extern

cleanerArrayVector3Zero()

void Ogre::cleanerArrayVector3Zero ( char *  dstPtr, size_t  indexDst, char *  srcPtr, size_t  indexSrc, size_t  numSlots, size_t  numFreeSlots, size_t  elementsMemSize  )

extern

cleanerFlat()

void Ogre::cleanerFlat ( char *  dstPtr, size_t  indexDst, char *  srcPtr, size_t  indexSrc, size_t  numSlots, size_t  numFreeSlots, size_t  elementsMemSize  )

extern

constructN()

template<typename T >

T * Ogre::constructN	(	T *	basePtr,
		size_t	count
	)

Utility function for constructing an array of objects with placement new, without using new[] (which allocates an undocumented amount of extra memory and so isn't appropriate for custom allocators).

operator!=() [1/2]

template<typename T , typename P , typename OtherAllocator >

bool Ogre::operator!= ( STLAllocator< T, P > const &  , OtherAllocator const &    )

inline

determine equality, can memory from another allocator be released by this allocator, (ISO C++)

operator!=() [2/2]

template<typename T , typename T2 , typename P >

bool Ogre::operator!= ( STLAllocator< T, P > const &  , STLAllocator< T2, P > const &    )

inline

determine equality, can memory from another allocator be released by this allocator, (ISO C++)

operator==() [1/2]

template<typename T , typename P , typename OtherAllocator >

bool Ogre::operator== ( STLAllocator< T, P > const &  , OtherAllocator const &    )

inline

determine equality, can memory from another allocator be released by this allocator, (ISO C++)

operator==() [2/2]

template<typename T , typename T2 , typename P >

bool Ogre::operator== ( STLAllocator< T, P > const &  , STLAllocator< T2, P > const &    )

inline

determine equality, can memory from another allocator be released by this allocator, (ISO C++)

Referenced by Ogre::DualQuaternion::operator!=(), Ogre::Matrix3::operator!=(), and Ogre::Quaternion::operator!=().