#include "OgrePrerequisites.h"
#include "OgreMemoryAllocatedObject.h"
#include "OgreMemorySTLAllocator.h"
#include "OgreMemoryNedAlloc.h"
Go to the source code of this file.
Namespaces | |
namespace | Ogre |
Defines | |
#define | OGRE_MALLOC(bytes, category) ::Ogre::CategorisedAllocPolicy<category>::allocateBytes(bytes) |
Allocate a block of raw memory, and indicate the category of usage. | |
#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_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_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_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_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_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_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_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_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_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_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_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_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. | |
#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_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_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_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_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_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_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_NEW new |
#define | OGRE_DELETE delete |
Typedefs | |
typedef CategorisedAllocPolicy< MEMCATEGORY_GENERAL > | GeneralAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_GEOMETRY > | GeometryAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_ANIMATION > | AnimationAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_SCENE_CONTROL > | SceneCtlAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_SCENE_OBJECTS > | SceneObjAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_RESOURCE > | ResourceAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_SCRIPTING > | ScriptingAllocPolicy |
typedef CategorisedAllocPolicy< MEMCATEGORY_RENDERSYS > | RenderSysAllocPolicy |
typedef AllocatedObject< GeneralAllocPolicy > | GeneralAllocatedObject |
typedef AllocatedObject< GeometryAllocPolicy > | GeometryAllocatedObject |
typedef AllocatedObject< AnimationAllocPolicy > | AnimationAllocatedObject |
typedef AllocatedObject< SceneCtlAllocPolicy > | SceneCtlAllocatedObject |
typedef AllocatedObject< SceneObjAllocPolicy > | SceneObjAllocatedObject |
typedef AllocatedObject< ResourceAllocPolicy > | ResourceAllocatedObject |
typedef AllocatedObject< ScriptingAllocPolicy > | ScriptingAllocatedObject |
typedef AllocatedObject< RenderSysAllocPolicy > | RenderSysAllocatedObject |
typedef ScriptingAllocatedObject | AbstractNodeAlloc |
typedef AnimationAllocatedObject | AnimableAlloc |
typedef AnimationAllocatedObject | AnimationAlloc |
typedef GeneralAllocatedObject | ArchiveAlloc |
typedef GeometryAllocatedObject | BatchedGeometryAlloc |
typedef RenderSysAllocatedObject | BufferAlloc |
typedef GeneralAllocatedObject | CodecAlloc |
typedef ResourceAllocatedObject | CompositorInstAlloc |
typedef GeneralAllocatedObject | ConfigAlloc |
typedef GeneralAllocatedObject | ControllerAlloc |
typedef GeometryAllocatedObject | DebugGeomAlloc |
typedef GeneralAllocatedObject | DynLibAlloc |
typedef GeometryAllocatedObject | EdgeDataAlloc |
typedef GeneralAllocatedObject | FactoryAlloc |
typedef SceneObjAllocatedObject | FXAlloc |
typedef GeneralAllocatedObject | ImageAlloc |
typedef GeometryAllocatedObject | IndexDataAlloc |
typedef GeneralAllocatedObject | LogAlloc |
typedef SceneObjAllocatedObject | MovableAlloc |
typedef SceneCtlAllocatedObject | NodeAlloc |
typedef SceneObjAllocatedObject | OverlayAlloc |
typedef RenderSysAllocatedObject | GpuParamsAlloc |
typedef ResourceAllocatedObject | PassAlloc |
typedef GeometryAllocatedObject | PatchAlloc |
typedef GeneralAllocatedObject | PluginAlloc |
typedef GeneralAllocatedObject | ProfilerAlloc |
typedef GeometryAllocatedObject | ProgMeshAlloc |
typedef SceneCtlAllocatedObject | RenderQueueAlloc |
typedef RenderSysAllocatedObject | RenderSysAlloc |
typedef GeneralAllocatedObject | RootAlloc |
typedef ResourceAllocatedObject | ResourceAlloc |
typedef GeneralAllocatedObject | SerializerAlloc |
typedef SceneCtlAllocatedObject | SceneMgtAlloc |
typedef ScriptingAllocatedObject | ScriptCompilerAlloc |
typedef ScriptingAllocatedObject | ScriptTranslatorAlloc |
typedef SceneCtlAllocatedObject | ShadowDataAlloc |
typedef GeneralAllocatedObject | StreamAlloc |
typedef SceneObjAllocatedObject | SubEntityAlloc |
typedef ResourceAllocatedObject | SubMeshAlloc |
typedef ResourceAllocatedObject | TechniqueAlloc |
typedef GeneralAllocatedObject | TimerAlloc |
typedef ResourceAllocatedObject | TextureUnitStateAlloc |
typedef GeneralAllocatedObject | UtilityAlloc |
typedef GeometryAllocatedObject | VertexDataAlloc |
typedef RenderSysAllocatedObject | ViewportAlloc |
Enumerations | |
enum | MemoryCategory { MEMCATEGORY_GENERAL = 0, MEMCATEGORY_GEOMETRY = 1, MEMCATEGORY_ANIMATION = 2, MEMCATEGORY_SCENE_CONTROL = 3, MEMCATEGORY_SCENE_OBJECTS = 4, MEMCATEGORY_RESOURCE = 5, MEMCATEGORY_SCRIPTING = 6, MEMCATEGORY_RENDERSYS = 7, MEMCATEGORY_COUNT = 8 } |
A set of categories that indicate the purpose of a chunk of memory being allocated. More... | |
Functions | |
template<typename T> | |
T * | 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). |
You can modify this file to alter the allocation routines used for Ogre's main objects.
When customising memory allocation, all you need to do is provide one or more custom allocation policy classes. These classes need to implement:
// Allocate bytes - file/line/func information should be optional, // will be provided when available but not everywhere (e.g. release mode, STL allocations) static inline void* allocateBytes(size_t count, const char* file = 0, int line = 0, const char* func = 0); // Free bytes static inline void deallocateBytes(void* ptr); // Return the max number of bytes available to be allocated in a single allocation static inline size_t getMaxAllocationSize();
Policies are then used as implementations for the wrapper classes and macros which call them. AllocatedObject for example provides the hooks to override the new and delete operators for a class and redirect the functionality to the policy. STLAllocator is a class which is provided to STL containers in order to hook up allocation of the containers members to the allocation policy.
AllocatedClass* obj = OGRE_NEW AllocatedClass(); OGRE_DELETE obj; AllocatedClass* array = OGRE_NEW AllocatedClass[10]; OGRE_DELETE [] obj; ExternalClass* obj = OGRE_NEW_T(ExternalClass, MEMCATEGORY_GENERAL)(constructorArgs); OGRE_DELETE_T(obj, ExternalClass, MEMCATEGORY_GENERAL); ExternalClass* obj = OGRE_NEW_ARRAY_T(ExternalClass, 10, MEMCATEGORY_GENERAL); OGRE_DELETE_ARRAY_T(obj, NonVirtualClass, 10, MEMCATEGORY_GENERAL); long* pLong = OGRE_ALLOC_T(long, 10, MEMCATEGORY_GENERAL); OGRE_FREE(pLong, MEMCATEGORY_GENERAL); long* pLong = OGRE_NEW_T(long, MEMCATEGORY_GENERAL)(0); OGRE_FREE(pLong, MEMCATEGORY_GENERAL); void* pVoid = OGRE_MALLOC(1024, MEMCATEGORY_GENERAL); OGRE_FREE(pVoid, MEMCATEGORY_GENERAL);
Definition in file OgreMemoryAllocatorConfig.h.
|
Allocate a block of memory for a primitive type, and indicate the category of usage.
Definition at line 376 of file OgreMemoryAllocatorConfig.h. Referenced by Ogre::AxisAlignedBox::getAllCorners(), and Ogre::VertexCacheProfiler::VertexCacheProfiler(). |
|
Allocate a block of memory for a primitive type aligned to user defined boundaries, and indicate the category of usage.
Definition at line 397 of file OgreMemoryAllocatorConfig.h. |
|
Allocate a block of memory for a primitive type aligned to SIMD boundaries, and indicate the category of usage.
Definition at line 395 of file OgreMemoryAllocatorConfig.h. |
|
|
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.
Definition at line 387 of file OgreMemoryAllocatorConfig.h. |
|
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.
Definition at line 418 of file OgreMemoryAllocatorConfig.h. |
|
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.
Definition at line 410 of file OgreMemoryAllocatorConfig.h. |
|
Free the memory allocated with OGRE_NEW_T. Category is required to be restated to ensure the matching policy is used.
Definition at line 385 of file OgreMemoryAllocatorConfig.h. Referenced by Ogre::SharedPtr< Skeleton >::destroy(), and Ogre::Any::~Any(). |
|
Free the memory allocated with OGRE_NEW_T_ALIGN. Category is required to be restated to ensure the matching policy is used.
Definition at line 416 of file OgreMemoryAllocatorConfig.h. |
|
Free the memory allocated with OGRE_NEW_T_SIMD. Category is required to be restated to ensure the matching policy is used.
Definition at line 408 of file OgreMemoryAllocatorConfig.h. |
|
Free the memory allocated with OGRE_MALLOC or OGRE_ALLOC_T. Category is required to be restated to ensure the matching policy is used.
Definition at line 378 of file OgreMemoryAllocatorConfig.h. Referenced by Ogre::SharedPtr< Skeleton >::destroy(), Ogre::AxisAlignedBox::~AxisAlignedBox(), and Ogre::VertexCacheProfiler::~VertexCacheProfiler(). |
|
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.
Definition at line 401 of file OgreMemoryAllocatorConfig.h. |
|
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.
Definition at line 399 of file OgreMemoryAllocatorConfig.h. |
|
Allocate a block of raw memory, and indicate the category of usage.
Definition at line 374 of file OgreMemoryAllocatorConfig.h. |
|
Allocate a block of raw memory aligned to user defined boundaries, and indicate the category of usage.
Definition at line 393 of file OgreMemoryAllocatorConfig.h. |
|
Allocate a block of raw memory aligned to SIMD boundaries, and indicate the category of usage.
Definition at line 391 of file OgreMemoryAllocatorConfig.h. |
|
|
Allocate a block of memory for 'count' primitive types - do not use for classes that inherit from AllocatedObject.
Definition at line 383 of file OgreMemoryAllocatorConfig.h. |
|
Allocate a block of memory for 'count' primitive types aligned to user defined boundaries - do not use for classes that inherit from AllocatedObject.
Definition at line 414 of file OgreMemoryAllocatorConfig.h. |
|
Allocate a block of memory for 'count' primitive types aligned to SIMD boundaries - do not use for classes that inherit from AllocatedObject.
Definition at line 406 of file OgreMemoryAllocatorConfig.h. |
|
Allocate space for one primitive type, external type or non-virtual type with constructor parameters.
Definition at line 381 of file OgreMemoryAllocatorConfig.h. Referenced by Ogre::AnyNumeric::numholder< ValueType >::add(), Ogre::AnyNumeric::AnyNumeric(), Ogre::SharedPtr< Skeleton >::bind(), Ogre::AnyNumeric::numholder< ValueType >::clone(), Ogre::Any::holder< ValueType >::clone(), Ogre::AnyNumeric::numholder< ValueType >::divide(), Ogre::AnyNumeric::numholder< ValueType >::multiply(), and Ogre::AnyNumeric::numholder< ValueType >::subtract(). |
|
Allocate space for one primitive type, external type or non-virtual type aligned to user defined boundaries.
Definition at line 412 of file OgreMemoryAllocatorConfig.h. |
|
Allocate space for one primitive type, external type or non-virtual type aligned to SIMD boundaries.
Definition at line 404 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 241 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 242 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 243 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 229 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 219 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 244 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 245 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 246 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 247 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 248 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 249 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 250 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 251 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 252 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 253 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 254 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 255 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 227 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 217 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 228 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 218 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 262 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 256 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 257 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 258 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 259 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 260 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 261 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 263 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 264 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 265 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 266 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 267 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 268 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 269 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 234 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 224 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 271 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 232 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 222 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 270 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 230 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 220 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 273 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 231 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 221 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 274 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 233 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 223 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 275 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 272 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 276 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 277 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 278 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 279 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 280 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 282 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 281 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 283 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 284 of file OgreMemoryAllocatorConfig.h. |
|
Definition at line 285 of file OgreMemoryAllocatorConfig.h. |
|
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.
Definition at line 144 of file OgreMemoryAllocatorConfig.h. |
|
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).
Definition at line 304 of file OgreMemoryAllocatorConfig.h. |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 11 13:46:44 2009