| 1 | // |
|---|
| 2 | // Redistribution and use in source and binary forms, with or without |
|---|
| 3 | // modification, are permitted provided that the following conditions |
|---|
| 4 | // are met: |
|---|
| 5 | // * Redistributions of source code must retain the above copyright |
|---|
| 6 | // notice, this list of conditions and the following disclaimer. |
|---|
| 7 | // * Redistributions in binary form must reproduce the above copyright |
|---|
| 8 | // notice, this list of conditions and the following disclaimer in the |
|---|
| 9 | // documentation and/or other materials provided with the distribution. |
|---|
| 10 | // * Neither the name of NVIDIA CORPORATION nor the names of its |
|---|
| 11 | // contributors may be used to endorse or promote products derived |
|---|
| 12 | // from this software without specific prior written permission. |
|---|
| 13 | // |
|---|
| 14 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY |
|---|
| 15 | // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|---|
| 16 | // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
|---|
| 17 | // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
|---|
| 18 | // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
|---|
| 19 | // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
|---|
| 20 | // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
|---|
| 21 | // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
|---|
| 22 | // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|---|
| 23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|---|
| 24 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|---|
| 25 | // |
|---|
| 26 | // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved. |
|---|
| 27 | // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved. |
|---|
| 28 | // Copyright (c) 2001-2004 NovodeX AG. All rights reserved. |
|---|
| 29 | |
|---|
| 30 | |
|---|
| 31 | #ifndef PX_PHYSICS_EXTENSIONS_DEFAULT_CPU_DISPATCHER_H |
|---|
| 32 | #define PX_PHYSICS_EXTENSIONS_DEFAULT_CPU_DISPATCHER_H |
|---|
| 33 | /** \addtogroup extensions |
|---|
| 34 | @{ |
|---|
| 35 | */ |
|---|
| 36 | |
|---|
| 37 | #include "common/PxPhysXCommonConfig.h" |
|---|
| 38 | #include "task/PxCpuDispatcher.h" |
|---|
| 39 | |
|---|
| 40 | #if !PX_DOXYGEN |
|---|
| 41 | namespace physx |
|---|
| 42 | { |
|---|
| 43 | #endif |
|---|
| 44 | |
|---|
| 45 | /** |
|---|
| 46 | \brief A default implementation for a CPU task dispatcher. |
|---|
| 47 | |
|---|
| 48 | @see PxDefaultCpuDispatcherCreate() PxCpuDispatcher |
|---|
| 49 | */ |
|---|
| 50 | class PxDefaultCpuDispatcher: public PxCpuDispatcher |
|---|
| 51 | { |
|---|
| 52 | public: |
|---|
| 53 | /** |
|---|
| 54 | \brief Deletes the dispatcher. |
|---|
| 55 | |
|---|
| 56 | Do not keep a reference to the deleted instance. |
|---|
| 57 | |
|---|
| 58 | @see PxDefaultCpuDispatcherCreate() |
|---|
| 59 | */ |
|---|
| 60 | virtual void release() = 0; |
|---|
| 61 | |
|---|
| 62 | /** |
|---|
| 63 | \brief Enables profiling at task level. |
|---|
| 64 | |
|---|
| 65 | \note By default enabled only in profiling builds. |
|---|
| 66 | |
|---|
| 67 | \param[in] runProfiled True if tasks should be profiled. |
|---|
| 68 | */ |
|---|
| 69 | virtual void setRunProfiled(bool runProfiled) = 0; |
|---|
| 70 | |
|---|
| 71 | /** |
|---|
| 72 | \brief Checks if profiling is enabled at task level. |
|---|
| 73 | |
|---|
| 74 | \return True if tasks should be profiled. |
|---|
| 75 | */ |
|---|
| 76 | virtual bool getRunProfiled() const = 0; |
|---|
| 77 | }; |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | /** |
|---|
| 81 | \brief Create default dispatcher, extensions SDK needs to be initialized first. |
|---|
| 82 | |
|---|
| 83 | \param[in] numThreads Number of worker threads the dispatcher should use. |
|---|
| 84 | \param[in] affinityMasks Array with affinity mask for each thread. If not defined, default masks will be used. |
|---|
| 85 | |
|---|
| 86 | \note numThreads may be zero in which case no worker thread are initialized and |
|---|
| 87 | simulation tasks will be executed on the thread that calls PxScene::simulate() |
|---|
| 88 | |
|---|
| 89 | @see PxDefaultCpuDispatcher |
|---|
| 90 | */ |
|---|
| 91 | PxDefaultCpuDispatcher* PxDefaultCpuDispatcherCreate(PxU32 numThreads, PxU32* affinityMasks = NULL); |
|---|
| 92 | |
|---|
| 93 | #if !PX_DOXYGEN |
|---|
| 94 | } // namespace physx |
|---|
| 95 | #endif |
|---|
| 96 | |
|---|
| 97 | /** @} */ |
|---|
| 98 | #endif |
|---|
| 99 | |
|---|
