Public Member Functions | Protected Member Functions | List of all members
PxFoundation Class Referenceabstract
Foundation

Foundation SDK singleton class. More...

#include <PxFoundation.h>

Public Member Functions

virtual void release ()=0
 Destroys the instance it is called on. More...
 
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

◆ ~PxFoundation()

virtual PxFoundation::~PxFoundation ( )
inlineprotectedvirtual

Member Function Documentation

◆ getAllocatorCallback()

virtual PxAllocatorCallback& PxFoundation::getAllocatorCallback ( )
pure virtual

Retrieves the allocator this object was created with.

◆ getErrorCallback()

virtual PxErrorCallback& PxFoundation::getErrorCallback ( )
pure virtual

retrieves error callback

◆ getErrorLevel()

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

Retrieves mask of errors to be reported.

◆ getReportAllocationNames()

virtual bool PxFoundation::getReportAllocationNames ( ) const
pure virtual

Retrieves if allocation names are being passed to allocator callback.

◆ release()

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

◆ setErrorLevel()

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

Sets mask of errors to report.

◆ setReportAllocationNames()

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: