RavEngine
Loading...
Searching...
No Matches
physx::PxDefaultCpuDispatcher Class Referenceabstract

A default implementation for a CPU task dispatcher. More...

#include <PxDefaultCpuDispatcher.h>

Inheritance diagram for physx::PxDefaultCpuDispatcher:
[legend]
Collaboration diagram for physx::PxDefaultCpuDispatcher:
[legend]

Public Member Functions

virtual void release ()=0
 Deletes the dispatcher.
 
virtual void setRunProfiled (bool runProfiled)=0
 Enables profiling at task level.
 
virtual bool getRunProfiled () const =0
 Checks if profiling is enabled at task level.
 
- Public Member Functions inherited from physx::PxCpuDispatcher
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.
 

Detailed Description

A default implementation for a CPU task dispatcher.

See also
PxDefaultCpuDispatcherCreate() PxCpuDispatcher

Member Function Documentation

◆ getRunProfiled()

virtual bool physx::PxDefaultCpuDispatcher::getRunProfiled ( ) const
pure virtual

Checks if profiling is enabled at task level.

Returns
True if tasks should be profiled.

Implemented in physx::Ext::DefaultCpuDispatcher.

◆ release()

virtual void physx::PxDefaultCpuDispatcher::release ( )
pure virtual

Deletes the dispatcher.

Do not keep a reference to the deleted instance.

See also
PxDefaultCpuDispatcherCreate()

Implemented in physx::Ext::DefaultCpuDispatcher.

◆ setRunProfiled()

virtual void physx::PxDefaultCpuDispatcher::setRunProfiled ( bool  runProfiled)
pure virtual

Enables profiling at task level.

Note
By default enabled only in profiling builds.
Parameters
[in]runProfiledTrue if tasks should be profiled.

Implemented in physx::Ext::DefaultCpuDispatcher.


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