PxTaskManager.h

Go to the documentation of this file.
00001 //
00002 // Redistribution and use in source and binary forms, with or without
00003 // modification, are permitted provided that the following conditions
00004 // are met:
00005 //  * Redistributions of source code must retain the above copyright
00006 //    notice, this list of conditions and the following disclaimer.
00007 //  * Redistributions in binary form must reproduce the above copyright
00008 //    notice, this list of conditions and the following disclaimer in the
00009 //    documentation and/or other materials provided with the distribution.
00010 //  * Neither the name of NVIDIA CORPORATION nor the names of its
00011 //    contributors may be used to endorse or promote products derived
00012 //    from this software without specific prior written permission.
00013 //
00014 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
00015 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00016 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00017 // PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00018 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00019 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00020 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00021 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
00022 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00023 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00024 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00025 //
00026 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
00027 
00028 #ifndef PXTASK_PXTASKMANAGER_H
00029 #define PXTASK_PXTASKMANAGER_H
00030 
00031 #include "task/PxTaskDefine.h"
00032 #include "foundation/PxSimpleTypes.h"
00033 #include "foundation/PxErrorCallback.h"
00034 
00035 namespace physx
00036 {
00037 
00038 PX_PUSH_PACK_DEFAULT
00039 
00040 class PxBaseTask;
00041 class PxTask;
00042 class PxLightCpuTask;
00043 typedef unsigned int PxTaskID;
00044 
00053 struct PxTaskType
00054 {
00058     enum Enum
00059     {
00060         TT_CPU,             
00061         TT_GPU,             
00062         TT_NOT_PRESENT,     
00063         TT_COMPLETED        
00064     };
00065 };
00066 
00067 class PxCpuDispatcher;
00068 class PxGpuDispatcher;
00069 
00083 class PxTaskManager
00084 {
00085 public:
00086 
00094     virtual void     setCpuDispatcher(PxCpuDispatcher& ref) = 0;
00095 
00103     virtual void     setGpuDispatcher(PxGpuDispatcher& ref) = 0;
00104     
00112     virtual PxCpuDispatcher*            getCpuDispatcher() const = 0;
00113 
00121     virtual PxGpuDispatcher*            getGpuDispatcher() const = 0;
00122 
00130     virtual void    resetDependencies() = 0;
00131     
00139     virtual void    startSimulation() = 0;
00140 
00146     virtual void    stopSimulation() = 0;
00147 
00153     virtual void    taskCompleted(PxTask& task) = 0;
00154 
00161     virtual PxTaskID  getNamedTask(const char* name) = 0;
00162 
00172     virtual PxTaskID  submitNamedTask(PxTask* task, const char* name, PxTaskType::Enum type = PxTaskType::TT_CPU) = 0;
00173 
00182     virtual PxTaskID  submitUnnamedTask(PxTask& task, PxTaskType::Enum type = PxTaskType::TT_CPU) = 0;
00183 
00191     virtual PxTask*   getTaskFromID(PxTaskID id) = 0;
00192 
00196     virtual void        release() = 0;
00197 
00201     static PxTaskManager* createTaskManager(PxErrorCallback& errorCallback, PxCpuDispatcher* = 0, PxGpuDispatcher* = 0);
00202     
00203 protected:
00204     virtual ~PxTaskManager() {}
00205 
00208     virtual void finishBefore(PxTask& task, PxTaskID taskID) = 0;
00209     virtual void startAfter(PxTask& task, PxTaskID taskID) = 0;
00210 
00211     virtual void addReference(PxTaskID taskID) = 0;
00212     virtual void decrReference(PxTaskID taskID) = 0;
00213     virtual int32_t getReference(PxTaskID taskID) const = 0;
00214 
00215     virtual void decrReference(PxLightCpuTask&) = 0;
00216     virtual void addReference(PxLightCpuTask&) = 0;
00217 
00220     friend class PxBaseTask;
00221     friend class PxTask;
00222     friend class PxLightCpuTask;
00223     friend class PxGpuWorkerThread;
00224 };
00225 
00226 PX_POP_PACK
00227 
00228 } // end physx namespace
00229 
00230 
00231 #endif // PXTASK_PXTASKMANAGER_H


Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com