physx::PxAllocatorCallback Class Reference

Abstract base class for an application defined memory allocator that can be used by the Nv library. More...

#include <PxAllocatorCallback.h>

Inheritance diagram for physx::PxAllocatorCallback:

Public Member Functions
virtual void *	allocate (size_t size, const char *typeName, const char *filename, int line)=0
	Allocates size bytes of memory, which must be 16-byte aligned.
virtual void	deallocate (void *ptr)=0
	Frees memory previously allocated by allocate().
virtual	~PxAllocatorCallback ()
	destructor
virtual void *	allocate (size_t size, const char *typeName, const char *filename, int line)=0
	Allocates size bytes of memory, which must be 16-byte aligned.
virtual void	deallocate (void *ptr)=0
	Frees memory previously allocated by allocate().

Detailed Description

Abstract base class for an application defined memory allocator that can be used by the Nv library.

Note

The SDK state should not be modified from within any allocation/free function.

Threading: All methods of this class should be thread safe as it can be called from the user thread or the physics processing thread(s).

Member Function Documentation

allocate() [1/2]

virtual void * physx::PxAllocatorCallback::allocate ( size_t  size, const char *  typeName, const char *  filename, int  line  )

pure virtual

Allocates size bytes of memory, which must be 16-byte aligned.

This method should never return NULL. If you run out of memory, then you should terminate the app or take some other appropriate action.

Threading: This function should be thread safe as it can be called in the context of the user thread and physics processing thread(s).

Parameters

size	Number of bytes to allocate.
typeName	Name of the datatype that is being allocated
filename	The source file which allocated the memory
line	The source line which allocated the memory

Returns

The allocated block of memory.

Implemented in physx::PxDefaultAllocator, and physx::PxBroadcastingAllocator.

allocate() [2/2]

virtual void * physx::PxAllocatorCallback::allocate ( size_t  size, const char *  typeName, const char *  filename, int  line  )

pure virtual

Allocates size bytes of memory, which must be 16-byte aligned.

This method should never return NULL. If you run out of memory, then you should terminate the app or take some other appropriate action.

Threading: This function should be thread safe as it can be called in the context of the user thread and physics processing thread(s).

Parameters

size	Number of bytes to allocate.
typeName	Name of the datatype that is being allocated
filename	The source file which allocated the memory
line	The source line which allocated the memory

Returns

The allocated block of memory.

Implemented in physx::PxDefaultAllocator, and physx::PxBroadcastingAllocator.

deallocate() [1/2]

virtual void physx::PxAllocatorCallback::deallocate ( void *  ptr )

pure virtual

Frees memory previously allocated by allocate().

Threading: This function should be thread safe as it can be called in the context of the user thread and physics processing thread(s).

Parameters

ptr	Memory to free.

Implemented in physx::PxDefaultAllocator, and physx::PxBroadcastingAllocator.

deallocate() [2/2]

virtual void physx::PxAllocatorCallback::deallocate ( void *  ptr )

pure virtual

Frees memory previously allocated by allocate().

Threading: This function should be thread safe as it can be called in the context of the user thread and physics processing thread(s).

Parameters

ptr	Memory to free.

Implemented in physx::PxDefaultAllocator, and physx::PxBroadcastingAllocator.

---

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

• RavEngine/deps/physx/physx/include/foundation/PxAllocatorCallback.h
• RavEngine/deps/physx/pxshared/include/foundation/PxAllocatorCallback.h