RavEngine
Loading...
Searching...
No Matches
PxDefaultCpuDispatcher.h
1// Redistribution and use in source and binary forms, with or without
2// modification, are permitted provided that the following conditions
3// are met:
4// * Redistributions of source code must retain the above copyright
5// notice, this list of conditions and the following disclaimer.
6// * Redistributions in binary form must reproduce the above copyright
7// notice, this list of conditions and the following disclaimer in the
8// documentation and/or other materials provided with the distribution.
9// * Neither the name of NVIDIA CORPORATION nor the names of its
10// contributors may be used to endorse or promote products derived
11// from this software without specific prior written permission.
12//
13// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
14// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
17// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24//
25// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
26// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
27// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
28
29#ifndef PX_DEFAULT_CPU_DISPATCHER_H
30#define PX_DEFAULT_CPU_DISPATCHER_H
35#include "common/PxPhysXCommonConfig.h"
36#include "task/PxCpuDispatcher.h"
37
38#if !PX_DOXYGEN
39namespace physx
40{
41#endif
42
49{
50public:
58 virtual void release() = 0;
59
67 virtual void setRunProfiled(bool runProfiled) = 0;
68
74 virtual bool getRunProfiled() const = 0;
75};
76
77
87{
88 enum Enum
89 {
90 eWAIT_FOR_WORK,
91 eYIELD_THREAD,
92 eYIELD_PROCESSOR
93 };
94};
95
96
116PxDefaultCpuDispatcher* PxDefaultCpuDispatcherCreate(PxU32 numThreads, PxU32* affinityMasks = NULL, PxDefaultCpuDispatcherWaitForWorkMode::Enum mode = PxDefaultCpuDispatcherWaitForWorkMode::eWAIT_FOR_WORK, PxU32 yieldProcessorCount = 0);
117
118#if !PX_DOXYGEN
119} // namespace physx
120#endif
121
123#endif
A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK.
Definition PxCpuDispatcher.h:50
A default implementation for a CPU task dispatcher.
Definition PxDefaultCpuDispatcher.h:49
virtual void setRunProfiled(bool runProfiled)=0
Enables profiling at task level.
virtual void release()=0
Deletes the dispatcher.
virtual bool getRunProfiled() const =0
Checks if profiling is enabled at task level.
Sorts an array of objects in ascending order, assuming that the predicate implements the < operator:
Definition PxBoxController.h:39
PxDefaultCpuDispatcher * PxDefaultCpuDispatcherCreate(PxU32 numThreads, PxU32 *affinityMasks=NULL, PxDefaultCpuDispatcherWaitForWorkMode::Enum mode=PxDefaultCpuDispatcherWaitForWorkMode::eWAIT_FOR_WORK, PxU32 yieldProcessorCount=0)
Create default dispatcher, extensions SDK needs to be initialized first.
Definition ExtDefaultCpuDispatcher.cpp:36
If a thread ends up waiting for work it will find itself in a spin-wait loop until work becomes avail...
Definition PxDefaultCpuDispatcher.h:87