From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxAllocatorCallback.html | 172 +++++++++++++++++++++ 1 file changed, 172 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxAllocatorCallback.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxAllocatorCallback.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxAllocatorCallback.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxAllocatorCallback.html new file mode 100644 index 00000000..0795de0b --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxAllocatorCallback.html @@ -0,0 +1,172 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxAllocatorCallback Class Reference + + + + + + + +
+

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:
+
+

Inheritance graph
+ +PxDefaultAllocator +
[legend]
+ +

+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-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3