Helper functionality of the profiling system. More...

#include <Profiling.h>

Classes
struct	CPUScope

struct	CPUScopesBufferFlat

struct	GPUScope
	Helper struct to hold GPU profiling data. More...

struct	ProfilingData

struct	ThreadInfo

Public Types
using	ScopeTimeoutDelegate = xiiDelegate<void(xiiStringView sName, xiiStringView sFunctionName, xiiTime duration)>

Static Public Member Functions
static void	Clear ()

static void	Capture (xiiProfilingSystem::ProfilingData &out_capture, bool bClearAfterCapture=false)

static void	SetDiscardThreshold (xiiTime threshold)
	Scopes are discarded if their duration is shorter than the specified threshold. Default is 0.1ms.

static void	SetScopeTimeoutCallback (ScopeTimeoutDelegate callback)
	Sets a callback that is triggered when a profiling scope takes longer than desired.

static void	StartNewFrame ()
	Should be called once per frame to capture the timestamp of the new frame.

static void	AddCPUScope (xiiStringView sName, xiiStringView sFunctionName, xiiTime beginTime, xiiTime endTime, xiiTime scopeTimeout)
	Adds a new scoped event for the calling thread in the profiling system.

static xiiUInt64	GetFrameCount ()
	Get current frame counter.

static void	InitializeGPUData (xiiUInt32 uiGpuCount=1)
	Initialized internal data structures for GPU profiling data. Needs to be called before adding any data.

static void	AddGPUScope (xiiStringView sName, xiiTime beginTime, xiiTime endTime, xiiUInt32 uiGpuIndex=0)
	Adds a GPU profiling scope in the internal event ringbuffer.

Friends
xiiUInt32	RunThread (xiiThread *pThread)

Detailed Description

Helper functionality of the profiling system.

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

/home/runner/work/XII/XII/Source/Engine/Foundation/Profiling/Profiling.h
/home/runner/work/XII/XII/Source/Engine/Foundation/Profiling/Implementation/Profiling.cpp

Classes