PxPvd.h

Go to the documentation of this file.
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-2018 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 PxFoundation;
00045 class PxPvdTransport;
00046 
00050 struct PxPvdInstrumentationFlag
00051 {
00052     enum Enum
00053     {
00062         eDEBUG   = 1 << 0,
00063 
00074         ePROFILE = 1 << 1,
00075 
00096         eMEMORY  = 1 << 2,
00097 
00098         eALL     = (eDEBUG | ePROFILE | eMEMORY)
00099     };
00100 };
00101 
00107 typedef PxFlags<PxPvdInstrumentationFlag::Enum, uint8_t> PxPvdInstrumentationFlags;
00108 PX_FLAGS_OPERATORS(PxPvdInstrumentationFlag::Enum, uint8_t)
00109 
00110 
00114 class PxPvd : public physx::PxProfilerCallback
00115 {
00116   public:
00123     virtual bool connect(PxPvdTransport& transport, PxPvdInstrumentationFlags flags) = 0;
00124 
00129     virtual void disconnect() = 0;
00130 
00143     virtual bool isConnected(bool useCachedStatus = true) = 0;
00144 
00149     virtual PxPvdTransport* getTransport() = 0;
00150 
00154     virtual PxPvdInstrumentationFlags getInstrumentationFlags() = 0;
00155 
00159     virtual void release() = 0;
00160 
00161   protected:
00162     virtual ~PxPvd()
00163     {
00164     }
00165 };
00166 
00171 PX_C_EXPORT PxPvd* PX_CALL_CONV PxCreatePvd(PxFoundation& foundation);
00172 
00173 #if !PX_DOXYGEN
00174 } // namespace physx
00175 #endif
00176 
00178 #endif // PXPVDSDK_PXPVD_H


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