Kaim::IPerfMarkerInterface Class Reference

#include <iperfmarkerinterface.h>

Class Description

An abstract interface for performance tracking markers.

You can implement this interface to handle the performance markers called internally by the Autodesk Navigation. You may also use KY_PERF_MARKER_BEGIN, KY_PERF_MARKER_END and KY_SCOPED_PERF_MARKER macros in you own code. A typical implementation of IPerfMarkerInterface forwards Begin() and End() to a platform specific profiling api.

Inherited by KyGlue::PerfMarkerInterface.

Static Public Member Functions
static IPerfMarkerInterface *&	Instance ()
	Returns a reference to the singleton pointer. This function called in BaseSystem::Init() with the variable set in BaseSystemConfig::m_perfMarkerInterface. More...
static void	BeginMarker (const char *name)
	calls Instance()->Begin(name); More...
static void	EndMarker ()
	calls Instance()->End(name); More...

Private Member Functions
virtual void	Begin (const char *name)=0
	Begin a new marker. More...
virtual void	End ()=0
	End the current marker. More...

Member Function Documentation

virtual void Kaim::IPerfMarkerInterface::Begin ( const char *  name )

privatepure virtual

Begin a new marker.

Implemented in KyGlue::PerfMarkerInterface.

static void Kaim::IPerfMarkerInterface::BeginMarker ( const char *  name )

inlinestatic

calls Instance()->Begin(name);

virtual void Kaim::IPerfMarkerInterface::End ( )

privatepure virtual

End the current marker.

Implemented in KyGlue::PerfMarkerInterface.

static void Kaim::IPerfMarkerInterface::EndMarker ( )

inlinestatic

calls Instance()->End(name);

static IPerfMarkerInterface*& Kaim::IPerfMarkerInterface::Instance ( )

inlinestatic

Returns a reference to the singleton pointer. This function called in BaseSystem::Init() with the variable set in BaseSystemConfig::m_perfMarkerInterface.

---

The documentation for this class was generated from the following file:

• gwnavruntime/basesystem/iperfmarkerinterface.h