Profiler.h File Reference

#include <mutex>
#include <Jolt/Core/NonCopyable.h>
#include <Jolt/Core/TickCounter.h>
#include <Jolt/Core/UnorderedMapFwd.h>
#include "Profiler.inl"

Go to the source code of this file.

Classes
class	Profiler
	Singleton class for managing profiling information. More...
class	ProfileSample
class	ProfileThread
	Collects all samples of a single thread. More...
class	ProfileMeasurement
	Create this class on the stack to start sampling timing information of a particular scope. More...

Macros
#define	JPH_PROFILE_START(name)
	Start instrumenting program.
#define	JPH_PROFILE_END()
	End instrumenting program.
#define	JPH_PROFILE_THREAD_START(name)
	Start instrumenting a thread.
#define	JPH_PROFILE_THREAD_END()
	End instrumenting a thread.
#define	JPH_PROFILE_TAG2(line)
	Scope profiling measurement.
#define	JPH_PROFILE_TAG(line)
#define	JPH_PROFILE(...)
#define	JPH_PROFILE_FUNCTION()
	Scope profiling for function.
#define	JPH_PROFILE_NEXTFRAME()
	Update frame counter.
#define	JPH_PROFILE_DUMP(...)
	Dump profiling info.

Macro Definition Documentation

JPH_PROFILE

#define JPH_PROFILE

(

...

)

Value:

ProfileMeasurement JPH_PROFILE_TAG(__LINE__)(__VA_ARGS__)

JPH_PROFILE_DUMP

#define JPH_PROFILE_DUMP

(

...

)

Value:

Profiler::sInstance->Dump(__VA_ARGS__)

Dump profiling info.

JPH_PROFILE_END

#define JPH_PROFILE_END

(

)

Value:

do { JPH_PROFILE_THREAD_END(); delete Profiler::sInstance; Profiler::sInstance = nullptr; } while (false)

End instrumenting program.

JPH_PROFILE_FUNCTION

#define JPH_PROFILE_FUNCTION

(

)

Value:

JPH_PROFILE(JPH_FUNCTION_NAME)

Scope profiling for function.

JPH_PROFILE_NEXTFRAME

#define JPH_PROFILE_NEXTFRAME

(

)

Value:

Profiler::sInstance->NextFrame()

Update frame counter.

JPH_PROFILE_START

#define JPH_PROFILE_START

(

name

)

Value:

do { Profiler::sInstance = new Profiler; JPH_PROFILE_THREAD_START(name); } while (false)

Start instrumenting program.

JPH_PROFILE_TAG

#define JPH_PROFILE_TAG

(

line

)

Value:

JPH_PROFILE_TAG2(line)

JPH_PROFILE_TAG2

#define JPH_PROFILE_TAG2

(

line

)

Value:

profile##line

Scope profiling measurement.

JPH_PROFILE_THREAD_END

#define JPH_PROFILE_THREAD_END

(

)

Value:

do { delete ProfileThread::sGetInstance(); ProfileThread::sSetInstance(nullptr); } while (false)

End instrumenting a thread.

JPH_PROFILE_THREAD_START

#define JPH_PROFILE_THREAD_START

(

name

)

Value:

do { if (Profiler::sInstance) ProfileThread::sSetInstance(new ProfileThread(name)); } while (false)

Start instrumenting a thread.