Класс EnProfiler

Set of methods for accessing script profiling data. Подробнее...

Закрытые статические члены
static proto void	Enable (bool enable, bool immediate=false, bool sessionReset=true)
	Enable the gathering of script profiling data.
static proto int	IsEnabled ()
	Return if script profiling is enabled.
static bool	IsEnabledD ()
	Return if script profiling is enabled through [DM].
static bool	IsEnabledP ()
	Return if script profiling is enabled through EnProfiler.
static bool	IsEnabledC ()
	Return if script profiling is actually turned on inside of the script context.
static proto void	SortData ()
	The internal sorting that happens at the end of the frame (so it is NOT necessary to call this manually) to supply Get...Per... functions.
static proto void	ResetSession (bool fullReset=false)
	Perform [SR], clearing SessionFrame, ProfiledSessionFrames, [SD] and [PD] (except for [CI])
EnProfilerFlags
Set of functions to configure the currently active EnProfilerFlags
static proto int	SetFlags (int flags, bool sessionReset=true)
	Override the currently used set of EnProfilerFlags across the API.
static proto int	GetFlags ()
	Get the currently used flags across the API.
static proto bool	IsFlagsSet (int flags)
	Check if the flags are set.
static proto int	AddFlags (int flags, bool sessionReset=true)
	Add flags to the currently used set of EnProfilerFlags across the API.
static proto int	RemoveFlags (int flags, bool sessionReset=true)
	Remove flags from the currently used set of EnProfilerFlags across the API.
static proto int	ClearFlags (bool sessionReset=true)
	Remove all flags from the currently used set of EnProfilerFlags across the API.
EnProfilerModule
Set of functions to configure the currently profiled EnProfilerModule
static proto void	SetModule (EnProfilerModule module, bool sessionReset=true)
	Set the module to be profiled.
static proto EnProfilerModule	GetModule ()
	Get the currently profiled module.
static proto owned string	ModuleToName (EnProfilerModule module)
	Helper to convert EnProfilerModule to string.
static proto bool	NameToModule (string moduleName, out EnProfilerModule module)
	Convert string to EnProfilerModule.
static proto void	SetInterval (int interval, bool sessionReset=true)
	Set the interval for the [SD] to update.
static proto int	GetInterval ()
	Get the currently set interval.
static proto void	SetTimeResolution (int resolution)
	Set the resolution of the fetched Time data.
static proto int	GetTimeResolution ()
	Get the currently set time resolution.
static proto void	EnableAverage (bool enable)
	Enable/disable returning calculated averages.
static proto bool	IsAverage ()
	Check if returning of average data is enabled.
static proto void	Dump ()
	Print out [SD] to script log.
Frame data
Set of functions to obtain information about frame counts
static proto int	GetGameFrame ()
	Get the total amount of frames passed.
static proto int	GetSessionFrame ()
	Get the total amount of frames in this profiling session.
static proto int	GetTotalFrames ()
	Get the total amount of frames across all profiling session.
static proto int	GetProfiledSessionFrames ()
	Get the total amount of frames profiled in this profiling session.
static proto int	GetProfiledFrames ()
	Get the total amount of frames profiled across all profiling session.
Sorted data
Set of functions to obtain [SD] Предупреждения Data is appended to the array, it will not clear any previous data already existing in the array Заметки Read SortData as well for more information regarding [SD]
static proto void	GetTimePerClass (notnull out array< ref EnProfilerTimeClassPair > outArr, int count=int.MAX)
	Obtain [SD] for Time Per Class.
static proto void	GetAllocationsPerClass (notnull out array< ref EnProfilerCountClassPair > outArr, int count=int.MAX)
	Obtain [SD] for Allocations Per Class.
static proto void	GetInstancesPerClass (notnull out array< ref EnProfilerCountClassPair > outArr, int count=int.MAX)
	Obtain [SD] for Instances Per Class.
static proto void	GetTimePerFunc (notnull out array< ref EnProfilerTimeFuncPair > outArr, int count=int.MAX)
	Obtain [SD] for Time Per Function.
static proto void	GetCountPerFunc (notnull out array< ref EnProfilerCountFuncPair > outArr, int count=int.MAX)
	Obtain [SD] for Count Per Function.
Specific data
Set of functions to obtain specific data
static proto float	GetTimeOfClass (typename clss, bool immediate=false)
	Obtain [SD] or [PD] regarding the time a specific class consumed.
static proto int	GetAllocationsOfClass (typename clss, bool immediate=false)
	Obtain [SD] or [PD] regarding the allocations of a specific class.
static proto int	GetInstancesOfClass (typename clss, bool immediate=false)
	Obtain [SD] or [PD] regarding the [CI] of a specific class.
static proto float	GetTimeOfFunc (string funct, typename clss, bool immediate=false)
	Obtain [SD] or [PD] regarding the time consumed by a specific function.
static proto float	GetTimeOfFuncG (string funct, bool immediate=false)
	Obtain [SD] or [PD] regarding the time consumed by a specific global function.
static proto int	GetCountOfFunc (string funct, typename clss, bool immediate=false)
	Obtain [SD] or [PD] regarding the amount of times a specific function was called.
static proto int	GetCountOfFuncG (string funct, bool immediate=false)
	Obtain [SD] or [PD] regarding the amount of times a specific function was called.
Misc
Set of helper functions
static bool	RequestImmediateData ()
	Helper method to ascertain the profiler will record [PD] right after this call.

Подробное описание

Set of methods for accessing script profiling data.

Заметки

To enable profiling on game launch, use parameter "-profile"

Any mention of "[DM]" in this context will mean the WIN+ALT debug menu

Any mention of "[CI]" in this context will mean Class Instances count

Any mention of "[SR]" in this context will mean a Session Reset (See ResetSession for more information)

Any mention of "[SD]" in this context will mean a Sorted Data, which is the data which supplies Get...Per... functions (the ones that give an array)

Any mention of "[PD]" in this context will mean a Profiling Data, which is the time, count and allocation information which is stored on the class/func itself

Предупреждения

[PD] is only calculated AFTER a function call is finished, there is no continuous timer running

Заметки

'proto' methods are not tracked, but will contribute to a script methods total time

См. определение в файле EnProfiler.c строка 72