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

PxFoundation Class Reference
+ +[Foundation] +

Foundation SDK singleton class. +More... +

+#include <PxFoundation.h> +

+ +

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

Public Member Functions

virtual void release ()=0
 Destroys the instance it is called on.
virtual PxErrorCallback & getErrorCallback ()=0
virtual void setErrorLevel (PxErrorCode::Enum mask=PxErrorCode::eMASK_ALL)=0
virtual PxErrorCode::Enum getErrorLevel () const =0
virtual PxAllocatorCallback & getAllocatorCallback ()=0
virtual bool getReportAllocationNames () const =0
virtual void setReportAllocationNames (bool value)=0

Protected Member Functions

virtual ~PxFoundation ()
+

Detailed Description

+Foundation SDK singleton class. +

+You need to have an instance of this class to instance the higher level SDKs.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
virtual PxFoundation::~PxFoundation (  )  [inline, protected, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual PxAllocatorCallback& PxFoundation::getAllocatorCallback (  )  [pure virtual]
+
+
+ +

+Retrieves the allocator this object was created with. +

+

+ +

+
+ + + + + + + + +
virtual PxErrorCallback& PxFoundation::getErrorCallback (  )  [pure virtual]
+
+
+ +

+retrieves error callback +

+

+ +

+
+ + + + + + + + +
virtual PxErrorCode::Enum PxFoundation::getErrorLevel (  )  const [pure virtual]
+
+
+ +

+Retrieves mask of errors to be reported. +

+

+ +

+
+ + + + + + + + +
virtual bool PxFoundation::getReportAllocationNames (  )  const [pure virtual]
+
+
+ +

+Retrieves if allocation names are being passed to allocator callback. +

+

+ +

+
+ + + + + + + + +
virtual void PxFoundation::release (  )  [pure virtual]
+
+
+ +

+Destroys the instance it is called on. +

+The operation will fail, if there are still modules referencing the foundation object. Release all dependent modules prior to calling this method.

+

See also:
PxCreateFoundation()
+ +
+

+ +

+
+ + + + + + + + + +
virtual void PxFoundation::setErrorLevel (PxErrorCode::Enum  mask = PxErrorCode::eMASK_ALL  )  [pure virtual]
+
+
+ +

+Sets mask of errors to report. +

+

+ +

+
+ + + + + + + + + +
virtual void PxFoundation::setReportAllocationNames (bool  value  )  [pure virtual]
+
+
+ +

+Set if allocation names are being passed to allocator callback. Enabled by default in debug and checked build, disabled by default in profile and release build. +

+

+

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