HolyLib Wiki

Home / VProfNode

VProfNode

VProfNode

This class represents the engine VProfNode class

Metatable function Description
__tostring Returns a formated string of the VProfNode -> VProfNode [name]

Currently a VProfNode NEVER becomes NULL meaning in cases like vprof.Term it will become unsafe to use a VProfNode.
Try to not store VProfNode, use vprof.GetCurrentNode instead.

Methods

VProfNode:ClearPrevTime()
Clears the previous time.
VProfNode:EnterScope()
Enters the scope.
VProfNode:ExitScope()
Enters the scope.
number VProfNode:GetBudgetGroupID( )
Returns the budget group id of the node.
VProfNode VProfNode:GetChild( )
Returns the child node of this node.
number VProfNode:GetClientData( )
Returns the set client data.
number VProfNode:GetCurCalls( )
Returns the amount of times this node was in scope in this frame.
number VProfNode:GetCurTime( )
Returns the current time of this node.
number VProfNode:GetCurTimeLessChildren( )
Returns the current time of this node but without it's children.
number VProfNode:GetL2CacheMisses( )
Returns the number of L2 cache misses.
Does this even work?
string VProfNode:GetName( )
Returns the name of this node.
VProfNode VProfNode:GetParent( )
Returns the parent node of this node.
number VProfNode:GetPeakTime( )
Returns the peak time of this node.
number VProfNode:GetPrevL2CacheMissLessChildren( )
Returns the previous number of L2 cache misses without the children.
Does this even work?
number VProfNode:GetPrevLoadHitStoreLessChildren( )
Does nothing / returns always 0.
VProfNode VProfNode:GetPrevSibling( )
Returns the previous silbling of this node.
number VProfNode:GetPrevTime( )
Returns the previous time of this node.
number VProfNode:GetPrevTimeLessChildren( )
Returns the previous time of this node but without it's children.
VProfNode VProfNode:GetSibling( )
Returns the next sibling of this node.
VProfNode VProfNode:GetSubNode( string name, number detailLevel, string budgetGroup )
Returns or creates a node with the given data. 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.
table VProfNode:GetTable( )
Returns the lua table used by newindex and index
number VProfNode:GetTotalCalls( )
Returns how often this node was in scope.
number VProfNode:GetTotalTime( )
Returns the total time of this node.
number VProfNode:GetTotalTimeLessChildren( )
Returns the total time of this node but without it's children.
VProfNode:MarkFrame()
Marks the frame.
It will move all current times into their previous variants and reset them to 0.
It will also call VProfNode:MarkFrame on all children and siblings.
VProfNode:Pause()
Pauses this node.
VProfNode:Reset()
Resets this node.
VProfNode:ResetPeak()
Resets the peak of this node.
VProfNode:Resume()
Resumes this node.
VProfNode:SetBudgetGroupID( number budgetGroup )
Sets the new budget group by it's id.
VProfNode:SetClientData( number data )
Sets the client data.
VProfNode:SetCurFrameTime( number frameTime )
Sets the current frametime.