NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxAllocatorCallback Class Reference

NVIDIA PhysX SDK 3.4 API

PxAllocatorCallback Class Reference
[Foundation]

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

#include <PxAllocatorCallback.h>

Inheritance diagram for PxAllocatorCallback:

List of all members.


Public Member Functions

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).

Constructor & Destructor Documentation

virtual PxAllocatorCallback::~PxAllocatorCallback (  )  [inline, virtual]

destructor


Member Function Documentation

virtual void* 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 PxDefaultAllocator.

virtual void 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 PxDefaultAllocator.


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



Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com