physx::PxCpuDispatcher Class Reference

A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK. More...

#include <PxCpuDispatcher.h>

List of all members.

Public Member Functions
virtual void	submitTask (PxBaseTask &task)=0
	Called by the TaskManager when a task is to be queued for execution.
virtual uint32_t	getWorkerCount () const =0
	Returns the number of available worker threads for this dispatcher.
virtual	~PxCpuDispatcher ()

---

Detailed Description

A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK.

A typical implementation would for example use a thread pool with the dispatcher pushing tasks onto worker thread queues or a global queue.

See also:

PxBaseTask

PxTask

PxTaskManager

---

Constructor & Destructor Documentation

virtual physx::PxCpuDispatcher::~PxCpuDispatcher

(

)

[inline, virtual]

---

Member Function Documentation

virtual uint32_t physx::PxCpuDispatcher::getWorkerCount

(

)

const [pure virtual]

Returns the number of available worker threads for this dispatcher.

The SDK will use this count to control how many tasks are submitted. By matching the number of tasks with the number of execution units task overhead can be reduced.

virtual void physx::PxCpuDispatcher::submitTask

(

PxBaseTask &

task

)

[pure virtual]

Called by the TaskManager when a task is to be queued for execution.

Upon receiving a task, the dispatcher should schedule the task to run when resource is available. After the task has been run, it should call the release() method and discard it's pointer.

Parameters:

[in]

task

The task to be run.

See also:

PxBaseTask

---

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

• PxCpuDispatcher.h