physx::PxFoundation Class Reference

Foundation SDK singleton class. More...

#include <PxFoundation.h>

Inheritance diagram for physx::PxFoundation:

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
virtual void	registerAllocationListener (PxAllocationListener &listener)=0
virtual void	deregisterAllocationListener (PxAllocationListener &listener)=0
virtual void	registerErrorCallback (PxErrorCallback &callback)=0
virtual void	deregisterErrorCallback (PxErrorCallback &callback)=0
virtual bool	error (PxErrorCode::Enum c, const char *file, int line, const char *messageFmt,...)=0
virtual bool	error (PxErrorCode::Enum, const char *file, int line, const char *messageFmt, va_list)=0

Detailed Description

Foundation SDK singleton class.

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

Member Function Documentation

getAllocatorCallback()

virtual PxAllocatorCallback & physx::PxFoundation::getAllocatorCallback ( )

pure virtual

Retrieves the allocator this object was created with.

Implemented in physx::Foundation.

getErrorCallback()

virtual PxErrorCallback & physx::PxFoundation::getErrorCallback ( )

pure virtual

retrieves error callback

Implemented in physx::Foundation.

getErrorLevel()

virtual PxErrorCode::Enum physx::PxFoundation::getErrorLevel ( ) const

pure virtual

Retrieves mask of errors to be reported.

Implemented in physx::Foundation.

getReportAllocationNames()

virtual bool physx::PxFoundation::getReportAllocationNames ( ) const

pure virtual

Retrieves if allocation names are being passed to allocator callback.

Implemented in physx::Foundation.

release()

virtual void physx::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()

Implemented in physx::Foundation.

setErrorLevel()

virtual void physx::PxFoundation::setErrorLevel ( PxErrorCode::Enum  mask = PxErrorCode::eMASK_ALL )

pure virtual

Sets mask of errors to report.

Implemented in physx::Foundation.

setReportAllocationNames()

virtual void physx::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.

Implemented in physx::Foundation.

---

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

• RavEngine/deps/physx/physx/include/foundation/PxFoundation.h