physx::PxTask Class Reference

A PxBaseTask implementation with deferred execution and full dependencies. More...

#include <PxTask.h>

Inheritance diagram for physx::PxTask:

Collaboration diagram for physx::PxTask:

Public Member Functions
virtual void	release () PX_OVERRIDE
	Release method implementation.
PX_INLINE void	finishBefore (PxTaskID taskID)
	Inform the PxTaskManager this task must finish before the given.
PX_INLINE void	startAfter (PxTaskID taskID)
	Inform the PxTaskManager this task cannot start until the given.
virtual void	addReference () PX_OVERRIDE
	Manually increment this task's reference count. The task will not be allowed to run until removeReference() is called.
virtual void	removeReference () PX_OVERRIDE
	Manually decrement this task's reference count. If the reference count reaches zero, the task will be dispatched.
virtual int32_t	getReference () const PX_OVERRIDE
	Return the ref-count for this task.
PX_INLINE PxTaskID	getTaskID () const
	Return the unique ID for this task.
virtual void	submitted ()
	Called by PxTaskManager at submission time for initialization.
Public Member Functions inherited from physx::PxBaseTask
virtual void	run ()=0
	The user-implemented run method where the task's work should be performed.
virtual const char *	getName () const =0
	Return a user-provided task name for profiling purposes.
PX_FORCE_INLINE PxTaskManager *	getTaskManager () const
	Return PxTaskManager to which this task was submitted.
PX_FORCE_INLINE void	setContextId (PxU64 id)
PX_FORCE_INLINE PxU64	getContextId () const

Protected Attributes
PxTaskID	mTaskID
	ID assigned at submission.
Protected Attributes inherited from physx::PxBaseTask
PxU64	mContextID
	Context ID for profiler interface.
PxTaskManager *	mTm
	Owning PxTaskManager instance.

Friends
class	PxTaskMgr

Detailed Description

A PxBaseTask implementation with deferred execution and full dependencies.

A PxTask must be submitted to a PxTaskManager to to be executed, Tasks may optionally be named when they are submitted.

Member Function Documentation

addReference()

virtual void physx::PxTask::addReference ( )

inlinevirtual

Manually increment this task's reference count. The task will not be allowed to run until removeReference() is called.

Implements physx::PxBaseTask.

getReference()

virtual int32_t physx::PxTask::getReference ( ) const

inlinevirtual

Return the ref-count for this task.

Implements physx::PxBaseTask.

release()

virtual void physx::PxTask::release ( )

inlinevirtual

Release method implementation.

Implements physx::PxBaseTask.

removeReference()

virtual void physx::PxTask::removeReference ( )

inlinevirtual

Manually decrement this task's reference count. If the reference count reaches zero, the task will be dispatched.

Implements physx::PxBaseTask.

submitted()

virtual void physx::PxTask::submitted ( )

inlinevirtual

Called by PxTaskManager at submission time for initialization.

Perform simulation step initialization here.

---

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

• RavEngine/deps/physx/physx/include/task/PxTask.h