PxGpuDispatcher.h

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2013 NVIDIA Corporation. All rights reserved.

#ifndef PX_GPU_DISPATCHER_H
#define PX_GPU_DISPATCHER_H

#include "pxtask/PxTask.h"
#include "pxtask/PxGpuCopyDesc.h"

/* forward decl to avoid including <cuda.h> */
typedef struct CUstream_st* CUstream;

#ifndef PX_DOXYGEN
namespace physx
{
#endif

PX_PUSH_PACK_DEFAULT

class PxCudaContextManager;
class PxTaskManager;

class PxGpuDispatcher
{
public:
    virtual void                startSimulation() = 0;

    virtual void                startGroup() = 0;

    virtual void                submitTask(PxTask& task) = 0;

    virtual void                finishGroup() = 0;

    virtual void                addCompletionPrereq(PxBaseTask& task) = 0;

    virtual PxCudaContextManager* getCudaContextManager() = 0;

    virtual void                stopSimulation() = 0;

    virtual bool                failureDetected() const = 0;

    virtual void                forceFailureMode() = 0;

    virtual void*               getCurrentProfileBuffer() const = 0;

    virtual PxU16               registerKernelNames(const char**, PxU16 count) = 0;

    virtual void                launchCopyKernel(PxGpuCopyDesc* desc, PxU32 count, CUstream stream) = 0;

    virtual PxBaseTask&         getPreLaunchTask() = 0;

    virtual void                addPreLaunchDependent(PxBaseTask& dependent) = 0;

    virtual PxBaseTask&         getPostLaunchTask() = 0;
    
    virtual void                addPostLaunchDependent(PxBaseTask& dependent) = 0;

protected:
    virtual ~PxGpuDispatcher() {}
};

PX_POP_PACK

#ifndef PX_DOXYGEN
} // end physx namespace
#endif

#endif