PxTaskManager.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.

#ifndef PXTASK_PXTASKMANAGER_H
#define PXTASK_PXTASKMANAGER_H

#include "task/PxTaskDefine.h"
#include "foundation/PxSimpleTypes.h"
#include "foundation/PxErrorCallback.h"

namespace physx
{
PX_PUSH_PACK_DEFAULT

class PxBaseTask;
class PxTask;
class PxLightCpuTask;
typedef unsigned int PxTaskID;

struct PxTaskType
{
    enum Enum
    {
        TT_CPU,             
        TT_GPU,             
        TT_NOT_PRESENT,     
        TT_COMPLETED        
    };
};

class PxCpuDispatcher;
class PxGpuDispatcher;

class PxTaskManager
{
public:

    virtual void     setCpuDispatcher(PxCpuDispatcher& ref) = 0;

    virtual void     setGpuDispatcher(PxGpuDispatcher& ref) = 0;
    
    virtual PxCpuDispatcher*            getCpuDispatcher() const = 0;

    virtual PxGpuDispatcher*            getGpuDispatcher() const = 0;

    virtual void    resetDependencies() = 0;
    
    virtual void    startSimulation() = 0;

    virtual void    stopSimulation() = 0;

    virtual void    taskCompleted(PxTask& task) = 0;

    virtual PxTaskID  getNamedTask(const char* name) = 0;

    virtual PxTaskID  submitNamedTask(PxTask* task, const char* name, PxTaskType::Enum type = PxTaskType::TT_CPU) = 0;

    virtual PxTaskID  submitUnnamedTask(PxTask& task, PxTaskType::Enum type = PxTaskType::TT_CPU) = 0;

    virtual PxTask*   getTaskFromID(PxTaskID id) = 0;

    virtual void        release() = 0;

    static PxTaskManager* createTaskManager(PxErrorCallback& errorCallback, PxCpuDispatcher* = 0, PxGpuDispatcher* = 0);
    
protected:
    virtual ~PxTaskManager() {}

    virtual void finishBefore(PxTask& task, PxTaskID taskID) = 0;
    virtual void startAfter(PxTask& task, PxTaskID taskID) = 0;

    virtual void addReference(PxTaskID taskID) = 0;
    virtual void decrReference(PxTaskID taskID) = 0;
    virtual int32_t getReference(PxTaskID taskID) const = 0;

    virtual void decrReference(PxLightCpuTask&) = 0;
    virtual void addReference(PxLightCpuTask&) = 0;

    friend class PxBaseTask;
    friend class PxTask;
    friend class PxLightCpuTask;
    friend class PxGpuWorkerThread;
};

PX_POP_PACK

} // end physx namespace


#endif // PXTASK_PXTASKMANAGER_H