NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxProfiler.h Source File

NVIDIA PhysX SDK 3.4 API

PxProfiler.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-2017 NVIDIA Corporation. All rights reserved.
00027 
00028 #ifndef PXFOUNDATION_PXPROFILER_H
00029 #define PXFOUNDATION_PXPROFILER_H
00030 
00031 #include "foundation/PxFoundation.h"
00032 
00033 namespace physx
00034 {
00035 
00040 class PxProfilerCallback
00041 {
00042 protected:
00043     virtual ~PxProfilerCallback()   {}
00044 
00045 public:
00046     /**************************************************************************************************************************
00047     Instrumented profiling events
00048     ***************************************************************************************************************************/
00049 
00057     virtual void* zoneStart(const char* eventName, bool detached, uint64_t contextId) = 0;
00058 
00068     virtual void zoneEnd(void* profilerData, const char* eventName, bool detached, uint64_t contextId) = 0;
00069 };
00070 
00071 class PxProfileScoped
00072 {
00073   public:
00074     PX_FORCE_INLINE PxProfileScoped(const char* eventName, bool detached, uint64_t contextId) : mCallback(PxGetProfilerCallback()), mProfilerData(NULL)
00075     {
00076         if(mCallback)
00077         {
00078             mEventName      = eventName;
00079             mContextId      = contextId;
00080             mDetached       = detached;
00081             mProfilerData   = mCallback->zoneStart(eventName, detached, contextId);
00082         }
00083     }
00084 
00085     PX_FORCE_INLINE ~PxProfileScoped()
00086     {
00087         if(mCallback)
00088             mCallback->zoneEnd(mProfilerData, mEventName, mDetached, mContextId);
00089     }
00090     physx::PxProfilerCallback*  mCallback;
00091     const char*                 mEventName;
00092     void*                       mProfilerData;
00093     uint64_t                    mContextId;
00094     bool                        mDetached;
00095 };
00096 
00097 } // end of physx namespace
00098 
00099 #if PX_DEBUG || PX_CHECKED || PX_PROFILE
00100     #define PX_PROFILE_ZONE(x, y)                                       \
00101         physx::PxProfileScoped PX_CONCAT(_scoped, __LINE__)(x, false, y)
00102     #define PX_PROFILE_START_CROSSTHREAD(x, y)                          \
00103         if(PxGetProfilerCallback())                                     \
00104             PxGetProfilerCallback()->zoneStart(x, true, y)
00105     #define PX_PROFILE_STOP_CROSSTHREAD(x, y)                           \
00106         if(PxGetProfilerCallback())                                     \
00107             PxGetProfilerCallback()->zoneEnd(NULL, x, true, y)
00108 #else
00109     #define PX_PROFILE_ZONE(x, y)
00110     #define PX_PROFILE_START_CROSSTHREAD(x, y)
00111     #define PX_PROFILE_STOP_CROSSTHREAD(x, y)
00112 #endif
00113 
00114 #define PX_PROFILE_POINTER_TO_U64(pointer) static_cast<uint64_t>(reinterpret_cast<size_t>(pointer))
00115 
00116 #endif // PXFOUNDATION_PXPROFILER_H


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