00001 // This code contains NVIDIA Confidential Information and is disclosed to you
00002 // under a form of NVIDIA software license agreement provided separately to you.
00003 //
00004 // Notice
00005 // NVIDIA Corporation and its licensors retain all intellectual property and
00006 // proprietary rights in and to this software and related documentation and
00007 // any modifications thereto. Any use, reproduction, disclosure, or
00008 // distribution of this software and related documentation without an express
00009 // license agreement from NVIDIA Corporation is strictly prohibited.
00010 //
00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
00015 //
00016 // Information and code furnished is believed to be accurate and reliable.
00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
00018 // information or for any infringement of patents or other rights of third parties that may
00019 // result from its use. No license is granted by implication or otherwise under any patent
00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
00021 // This code supersedes and replaces all information previously supplied.
00022 // NVIDIA Corporation products are not authorized for use as critical
00023 // components in life support devices or systems without express written approval of
00024 // NVIDIA Corporation.
00025 //
00026 // Copyright (c) 2008-2017 NVIDIA Corporation. All rights reserved.
00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
00029 
00030 #ifndef PXPVDSDK_PXPVD_H
00031 #define PXPVDSDK_PXPVD_H
00032 
00036 #include "foundation/PxFlags.h"
00037 #include "foundation/PxProfiler.h"
00038 
00039 #if !PX_DOXYGEN
00040 namespace physx
00041 {
00042 #endif
00043 
00044 class PxPvdTransport;
00045 
00046 #if PX_WINDOWS_FAMILY && !PX_ARM_FAMILY
00047 #ifndef PX_PVDSDK_DLL
00048 #define PX_PVDSDK_API PX_DLL_IMPORT
00049 #elif PX_PVDSDK_DLL
00050 #define PX_PVDSDK_API PX_DLL_EXPORT
00051 #endif
00052 #elif PX_UNIX_FAMILY
00053 #ifdef PX_PVDSDK_DLL
00054 #define PX_PVDSDK_API PX_UNIX_EXPORT
00055 #endif
00056 #endif
00057 
00058 #ifndef PX_PVDSDK_API
00059 #define PX_PVDSDK_API
00060 #endif
00061 
00065 struct PxPvdInstrumentationFlag
00066 {
00067     enum Enum
00068     {
00077         eDEBUG   = 1 << 0,
00078 
00089         ePROFILE = 1 << 1,
00090 
00111         eMEMORY  = 1 << 2,
00112 
00113         eALL     = (eDEBUG | ePROFILE | eMEMORY)
00114     };
00115 };
00116 
00122 typedef PxFlags<PxPvdInstrumentationFlag::Enum, uint8_t> PxPvdInstrumentationFlags;
00123 PX_FLAGS_OPERATORS(PxPvdInstrumentationFlag::Enum, uint8_t)
00124 
00125 
00129 class PxPvd : public physx::PxProfilerCallback
00130 {
00131   public:
00138     virtual bool connect(PxPvdTransport& transport, PxPvdInstrumentationFlags flags) = 0;
00139 
00144     virtual void disconnect() = 0;
00145 
00158     virtual bool isConnected(bool useCachedStatus = true) = 0;
00159 
00164     virtual PxPvdTransport* getTransport() = 0;
00165 
00169     virtual PxPvdInstrumentationFlags getInstrumentationFlags() = 0;
00170 
00174     virtual void release() = 0;
00175 
00176   protected:
00177     virtual ~PxPvd()
00178     {
00179     }
00180 };
00181 
00186 PX_PVDSDK_API PxPvd* PX_CALL_CONV PxCreatePvd(PxFoundation& foundation);
00187 
00188 #if !PX_DOXYGEN
00189 } // namespace physx
00190 #endif
00191 
00193 #endif // PXPVDSDK_PXPVD_H