makVrv::DtProfileManager Class Reference

The profile manager responsible for all profiling. More...

Classes
class	Initializer
	this is a static constructor used to create and initialize this class and the clock at startup by calling the constructor of the profile manager More...

Public Types
enum	ClientFlags { F3_STATS_OVERLAY = 0x00000001, IMGUI_OVERLAY = 0x00000010 }

Static Public Member Functions
static void	init ()
	Set up the profile manager (cpu count per second, etc.) More...
static void	startProfile (const char *name)
	begin a profile. This function is thread safe More...
static void	stopProfile ()
	begin stop a profile. This function is thread safe More...
static void	startPerformanceStat (const char *name)
	begin a performance stat. This function is thread safe More...
static void	stopPerformanceStat ()
	begin stop a profile. This function is thread safe More...
static void	getTime (DtUInt64 &time)
	Get a timestamp in CPU ticks. This function is thread safe. More...
static void	reset ()
	reset the entire tree More...
static void	incrementFrameCounter ()
	increments the frame counter. More...
static int	frameCountSinceReset ()
	get the number of frames since reset More...
static DtUInt64	timeSinceReset ()
	get the number of ticks since reset More...
static DtUInt64	ticksPerSecond ()
	get the number of ticks per second More...
static double	averageFps ()
	get the average frames per second over the last second More...
static double	instantFps ()
	get the instantaneous frames per second More...
static double	lowestFps ()
	lowest fps seen since reset More...
static double	instantFrameTime ()
	get the frame time in milliseconds More...
static double	averageFrameTime ()
static double	highestFrameTime ()
static DtProfileIterator *	profileIterator ()
	create a profile iterator More...
static DtProfileNode *	theRootNode ()
	tree root access for imgui More...
static DtProfileIterator *	statIterator ()
	create a performance stat iterator More...
static void	releaseIterator (DtProfileIterator *iterator)
	release a profile iterator More...
static bool	collectTracyStats ()
	are tracy stats active More...
static bool	collectTracyGpuStats ()
static void	setCollectTracyStats (bool val)
	set if stats are active More...
static void	setCollectTracyGpuStats (bool val)
static int	threadCount ()
static DtThreadProfileData *	threadData (int i)
static void	addClientFlag (int flag)
static void	removeClientFlag (int flag)
static int	clientFlags ()

Static Private Member Functions
static DtThreadProfileData *	getCurrentProfileNode ()
	get the profiler data for a particular thread More...
static DtThreadProfileData *	getCurrentPerformanceStatNode ()

Static Private Attributes
static Initializer	theInitializer
static DtProfileNode	theRoot
static DtProfileNode	thePerformanceStatRoot
static bool	theShouldReset
static int	theFrameCounter
static DtUInt64	theResetTime
static DtUInt64	thePreviousFrame
static DtUInt64 *	theFrameTimes
static DtUInt64	theMaxFrameTime
static int	theFrameTimeIndex
static bool	theInitializationDone
static int	thePreInitClientFlags
static int	theClientFlags
static bool	theCollectTracyStats
static bool	theCollectGpuTracyStats

Friends
class	Initializer

Detailed Description

The profile manager responsible for all profiling.

Member Enumeration Documentation

enum makVrv::DtProfileManager::ClientFlags

Enumerator
F3_STATS_OVERLAY
IMGUI_OVERLAY

Member Function Documentation

static void makVrv::DtProfileManager::init ( )

static

Set up the profile manager (cpu count per second, etc.)

static void makVrv::DtProfileManager::addClientFlag ( int  flag )

static

Clients who use the profile manager must register and unregister themselves. If no clients are registered, startProfile will return immediately so there's no overhead of generating profiles when nobody is using the data. Clients should register with addClientFlag before any calls to startProfile or startPerformanceStat and must unregister with removeClientFlag once they are done collecting stats. In most cases can be done at client initialization and destruction time.

static void makVrv::DtProfileManager::removeClientFlag ( int  flag )

static

static int makVrv::DtProfileManager::clientFlags ( )

static

static void makVrv::DtProfileManager::startProfile ( const char *  name )

static

begin a profile. This function is thread safe

Referenced by makVrv::DtProfileSample::DtProfileSample(), and makVrv::DtProfileTarget< true >::DtProfileTarget().

static void makVrv::DtProfileManager::stopProfile ( )

static

begin stop a profile. This function is thread safe

Referenced by makVrv::DtProfileSample::~DtProfileSample(), and makVrv::DtProfileTarget< true >::~DtProfileTarget().

static void makVrv::DtProfileManager::startPerformanceStat ( const char *  name )

static

begin a performance stat. This function is thread safe

Referenced by makVrv::DtPerfomanceStatSample::DtPerfomanceStatSample().

static void makVrv::DtProfileManager::stopPerformanceStat ( )

static

begin stop a profile. This function is thread safe

Referenced by makVrv::DtPerfomanceStatSample::~DtPerfomanceStatSample().

static void makVrv::DtProfileManager::getTime ( DtUInt64 &  time )

static

Get a timestamp in CPU ticks. This function is thread safe.

static void makVrv::DtProfileManager::reset ( )

static

reset the entire tree

static void makVrv::DtProfileManager::incrementFrameCounter ( )

static

increments the frame counter.

This needs to be called once per frame from the main thread in order to compute time/frame correctly

static int makVrv::DtProfileManager::frameCountSinceReset ( )

inlinestatic

get the number of frames since reset

static DtUInt64 makVrv::DtProfileManager::timeSinceReset ( )

static

get the number of ticks since reset

static DtUInt64 makVrv::DtProfileManager::ticksPerSecond ( )

static

get the number of ticks per second

static double makVrv::DtProfileManager::averageFps ( )

static

get the average frames per second over the last second

static double makVrv::DtProfileManager::instantFps ( )

static

get the instantaneous frames per second

static double makVrv::DtProfileManager::lowestFps ( )

static

lowest fps seen since reset

static double makVrv::DtProfileManager::instantFrameTime ( )

static

get the frame time in milliseconds

static double makVrv::DtProfileManager::averageFrameTime ( )

static

static double makVrv::DtProfileManager::highestFrameTime ( )

static

static DtProfileIterator* makVrv::DtProfileManager::profileIterator ( )

static

create a profile iterator

static DtProfileNode* makVrv::DtProfileManager::theRootNode ( )

inlinestatic

tree root access for imgui

static DtProfileIterator* makVrv::DtProfileManager::statIterator ( )

static

create a performance stat iterator

static void makVrv::DtProfileManager::releaseIterator ( DtProfileIterator *  iterator )

static

release a profile iterator

static bool makVrv::DtProfileManager::collectTracyStats ( )

inlinestatic

are tracy stats active

static bool makVrv::DtProfileManager::collectTracyGpuStats ( )

inlinestatic

static void makVrv::DtProfileManager::setCollectTracyStats ( bool  val )

inlinestatic

set if stats are active

static void makVrv::DtProfileManager::setCollectTracyGpuStats ( bool  val )

inlinestatic

static int makVrv::DtProfileManager::threadCount ( )

static

static DtThreadProfileData* makVrv::DtProfileManager::threadData ( int  i )

static

static DtThreadProfileData* makVrv::DtProfileManager::getCurrentProfileNode ( )

staticprivate

get the profiler data for a particular thread

static DtThreadProfileData* makVrv::DtProfileManager::getCurrentPerformanceStatNode ( )

staticprivate

Friends And Related Function Documentation

friend class Initializer

friend

Member Data Documentation

Initializer makVrv::DtProfileManager::theInitializer

staticprivate

DtProfileNode makVrv::DtProfileManager::theRoot

staticprivate

DtProfileNode makVrv::DtProfileManager::thePerformanceStatRoot

staticprivate

bool makVrv::DtProfileManager::theShouldReset

staticprivate

int makVrv::DtProfileManager::theFrameCounter

staticprivate

DtUInt64 makVrv::DtProfileManager::theResetTime

staticprivate

DtUInt64 makVrv::DtProfileManager::thePreviousFrame

staticprivate

DtUInt64* makVrv::DtProfileManager::theFrameTimes

staticprivate

DtUInt64 makVrv::DtProfileManager::theMaxFrameTime

staticprivate

int makVrv::DtProfileManager::theFrameTimeIndex

staticprivate

bool makVrv::DtProfileManager::theInitializationDone

staticprivate

int makVrv::DtProfileManager::thePreInitClientFlags

staticprivate

int makVrv::DtProfileManager::theClientFlags

staticprivate

bool makVrv::DtProfileManager::theCollectTracyStats

staticprivate

bool makVrv::DtProfileManager::theCollectGpuTracyStats

staticprivate

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvUtil/DtProfileManager.h