HolyLib Wiki

Home / vprof

vprof

vprof

This library adds a vprof(the engine performanc profiler) related functions.

Methods

boolean vprof.AtRoot( )
Returns true if is vprof scope currently is at it's root node.
number vprof.BudgetGroupNameToBudgetGroupID( string name )
Returns the budget group id by the given name.
vprof.COUNTER_GROUP_DEFAULT()
vprof.COUNTER_GROUP_NO_RESET()
vprof.COUNTER_GROUP_TELEMETRY()
vprof.COUNTER_GROUP_TEXTURE_GLOBAL()
vprof.COUNTER_GROUP_TEXTURE_PER_FRAME()
vprof.EnterScope( string name, number detailLevel, string budgetGroup )
Enters a new scope. The scope name is permanently allocated and only freed when vprof.Term is called.
Use a consistent scope name if you don't want to have memory leaks.
vprof.ExitScope()
Leaves the current scope.
VProfCounter vprof.FindOrCreateCounter( string name, number group )
Returns or counter the given vprof counter.
If the vprof counter limit is hit, it will return a dummy vprof counter!
Color vprof.GetBudgetGroupColor( number index )
Returns the color of the given budget group.
number vprof.GetBudgetGroupFlags( number index )
Returns the name of the budget group by the given index.
string vprof.GetBudgetGroupName( number index )
Returns the name of the budget group by the given index.
VProfCounter vprof.GetCounter( number index )
Returns the vprof counter of the given index.
VProfNode vprof.GetCurrentNode( )
Returns the current node.
number vprof.GetDetailLevel( )
Returns the current detail level.
number vprof.GetNumBudgetGroups( )
Returns the number of budget groups.
number vprof.GetNumCounters( )
Returns the number of counters that exist.
number vprof.GetPeakFrameTime( )
Returns the peak time of the root node.
VProfNode vprof.GetRoot( )
Returns the root node.
number vprof.GetTimeLastFrame( )
Returns the time the last frame took.
number vprof.GetTotalTimeSampled( )
Returns the total time of the root node.
vprof.HideBudgetGroup( string name, boolean hide = false )
Hides/Unhides the given budget group.
boolean vprof.IsEnabled( )
Returns true if vprof is enabled/running.
vprof.MarkFrame()
If vprof is enabled, it will call VProfNode:MarkFrame on the root node.
number vprof.NumFramesSampled( )
Returns the number of frames it sampled.
vprof.Pause()
Pauses vprof.
vprof.Reset()
Resets vprof.
vprof.ResetCounters()
Resets all vprof counters back to 0.
vprof.ResetPeaks()
Resets all peaks.
vprof.Resume()
Resumes vprof.
vprof.Start()
Starts vprof.
vprof.Stop()
Stops vprof.
vprof.Term()
Terminates vprof and frees the memory of everything.
This will invalidate all VProfCounter and VProfNode.
This means that if you try to use one that you stored in lua, it could crash! This should probably never be used.