126 lines
4.9 KiB
C++
126 lines
4.9 KiB
C++
// 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_PROFILE_ZONE_MANAGER_H
|
|
#define PX_PROFILE_ZONE_MANAGER_H
|
|
|
|
#include "physxprofilesdk/PxProfileEventSender.h"
|
|
#include "physxprofilesdk/PxProfileEventNames.h"
|
|
|
|
namespace physx {
|
|
class PxProfileZone;
|
|
class PxProfileNameProvider;
|
|
|
|
class PxProfileZoneHandler
|
|
{
|
|
protected:
|
|
virtual ~PxProfileZoneHandler(){}
|
|
public:
|
|
/*
|
|
* Not a threadsafe call; handlers are expected to be able to handle
|
|
* this from any thread.
|
|
*/
|
|
virtual void onZoneAdded( PxProfileZone& inSDK ) = 0;
|
|
virtual void onZoneRemoved( PxProfileZone& inSDK ) = 0;
|
|
};
|
|
|
|
class PxUserCustomProfiler
|
|
{
|
|
public:
|
|
virtual void onStartEvent( const char *eventName,PxU64 contextId,PxU32 threadId) = 0;
|
|
virtual void onStopEvent( const char *eventName,PxU64 contextId,PxU32 threadId) = 0;
|
|
virtual void onEventValue(const char *eventValue,PxI64 inValue) = 0;
|
|
|
|
protected:
|
|
virtual ~PxUserCustomProfiler(void)
|
|
{
|
|
|
|
}
|
|
};
|
|
|
|
/**
|
|
* The profiling system was setup in the expectation that there would be several
|
|
* systems that each had its own island of profile information. PhysX, client code,
|
|
* and APEX would be the first examples of these. Each one of these islands is represented
|
|
* by a profile zone.
|
|
*
|
|
* The Manager is a singleton-like object where all these different systems can be registered
|
|
* so that clients of the profiling system can have one point to capture *all* profiling events.
|
|
*
|
|
* Flushing the manager implies that you want to loop through all the profile zones and flush
|
|
* each one.
|
|
*/
|
|
class PxProfileZoneManager
|
|
: public PxProfileEventFlusher //Tell all SDK's to flush their queue of profile events.
|
|
{
|
|
protected:
|
|
virtual ~PxProfileZoneManager(){}
|
|
public:
|
|
/**
|
|
* Threadsafe call, can be done from any thread. Handlers that are already connected
|
|
* will get a new callback on the current thread.
|
|
*/
|
|
virtual void addProfileZone( PxProfileZone& inSDK ) = 0;
|
|
virtual void removeProfileZone( PxProfileZone& inSDK ) = 0;
|
|
|
|
/**
|
|
* Threadsafe call. The new handler will immediately be notified about all
|
|
* known SDKs.
|
|
*/
|
|
virtual void addProfileZoneHandler( PxProfileZoneHandler& inHandler ) = 0;
|
|
virtual void removeProfileZoneHandler( PxProfileZoneHandler& inHandler ) = 0;
|
|
|
|
|
|
/**
|
|
* Create a new profile zone. This means you don't need access to a PxFoundation to
|
|
* create your profile zone object, and your object is automatically registered with
|
|
* the profile zone manager.
|
|
*
|
|
* You still need to release your object when you are finished with it.
|
|
* \param inSDKName Name of the SDK object.
|
|
* \param inProvider Option set of event id to name mappings.
|
|
* \param inEventBufferByteSize rough maximum size of the event buffer. May exceed this size
|
|
* by sizeof one event. When full an immediate call to all listeners is made.
|
|
*/
|
|
virtual PxProfileZone& createProfileZone( const char* inSDKName, PxProfileNames inNames = PxProfileNames(), PxU32 inEventBufferByteSize = 0x4000 /*16k*/ ) = 0;
|
|
|
|
/**
|
|
* Deprecated form of the above function.
|
|
*/
|
|
virtual PxProfileZone& createProfileZone( const char* inSDKName, PxProfileNameProvider* inProvider = NULL, PxU32 inEventBufferByteSize = 0x4000 /*16k*/ ) = 0;
|
|
|
|
virtual void setUserCustomProfiler(PxUserCustomProfiler *callback) = 0;
|
|
|
|
virtual void release() = 0;
|
|
|
|
static PxProfileZoneManager& createProfileZoneManager(PxFoundation* inFoundation );
|
|
};
|
|
|
|
}
|
|
|
|
#endif // PX_PROFILE_ZONE_MANAGER_H
|