Profiler Class Reference

Singleton class for managing profiling information. More...

#include <Profiler.h>

Inheritance diagram for Profiler:

Public Member Functions
JPH_OVERRIDE_NEW_DELETE	Profiler ()
	Constructor. More...
void	NextFrame ()
	Increments the frame counter to provide statistics per frame. More...
void	Dump (const string_view &inTag=string_view())
void	AddThread (ProfileThread *inThread)
	Add a thread to be instrumented. More...
void	RemoveThread (ProfileThread *inThread)
	Remove a thread from being instrumented. More...
Public Member Functions inherited from NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
void	operator= (const NonCopyable &)=delete

Static Public Attributes
static Profiler *	sInstance = nullptr
	Singleton instance. More...

Detailed Description

Singleton class for managing profiling information.

Constructor & Destructor Documentation

Profiler()

JPH_OVERRIDE_NEW_DELETE Profiler::Profiler ( )

inline

Constructor.

Member Function Documentation

AddThread()

void Profiler::AddThread

(

ProfileThread *

inThread

)

Add a thread to be instrumented.

Dump()

void Profiler::Dump

(

const string_view &

inTag = string_view()

)

Dump profiling statistics at the start of the next frame

Parameters

inTag

If not empty, this overrides the auto incrementing number in the filename of the dump file

NextFrame()

JPH_TSAN_NO_SANITIZE void Profiler::NextFrame

(

)

Increments the frame counter to provide statistics per frame.

RemoveThread()

void Profiler::RemoveThread

(

ProfileThread *

inThread

)

Remove a thread from being instrumented.

Member Data Documentation

sInstance

JPH_SUPPRESS_WARNINGS_STD_BEGIN JPH_SUPPRESS_WARNINGS_STD_END JPH_NAMESPACE_BEGIN Profiler * Profiler::sInstance = nullptr

static

Singleton instance.

---

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

• Jolt/Core/Profiler.h
• Jolt/Core/Profiler.cpp