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/classPxDefaultAllocator.html | 155 +++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultAllocator.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultAllocator.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultAllocator.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultAllocator.html new file mode 100644 index 00000000..4fb54ea3 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultAllocator.html @@ -0,0 +1,155 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultAllocator Class Reference + + + + + + + +
+

PxDefaultAllocator Class Reference
+ +[Extensions] +

default implementation of the allocator interface required by the SDK +More... +

+#include <PxDefaultAllocator.h> +

+

+Inheritance diagram for PxDefaultAllocator:
+
+

Inheritance graph
+ +PxAllocatorCallback +
[legend]
+
+Collaboration diagram for PxDefaultAllocator:
+
+

Collaboration graph
+ +PxAllocatorCallback +
[legend]
+ +

+List of all members. + + + + + + + + +

Public Member Functions

void * allocate (size_t size, const char *, const char *, int)
 Allocates size bytes of memory, which must be 16-byte aligned.
void deallocate (void *ptr)
 Frees memory previously allocated by allocate().
+

Detailed Description

+default implementation of the allocator interface required by the SDK

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void* PxDefaultAllocator::allocate (size_t  size,
const char *  typeName,
const char *  filename,
int  line 
) [inline, 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.
+ +

Implements PxAllocatorCallback.

+ +

References platformAlignedAlloc(), and PX_ASSERT.

+ +
+

+ +

+
+ + + + + + + + + +
void PxDefaultAllocator::deallocate (void *  ptr  )  [inline, 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.
+
+ +

Implements PxAllocatorCallback.

+ +

References platformAlignedFree().

+ +
+

+

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