NativeFrameProfiler

Kind	class
Package	debug.profiler
Full name	debug.profiler.NativeFrameProfiler
Source	source/debug/profiler/NativeFrameProfiler.hx

Public fields

Name	Type	Static	Default	Notes
PHASE_UPDATE	Int	yes	0	—
PHASE_RENDER	Int	yes	1	—
PHASE_AUDIO	Int	yes	2	—
PHASE_GC	Int	yes	3	—
RING_CAPACITY	Int	yes	2048	—
DEFAULT_RSS_SAMPLE_INTERVAL	Int	yes	60	—

Public methods

init

static function init(targetFps:Float = 60.0):Void

Only compiled when #if cpp.

Parameter	Type	Default
targetFps (optional)	Float	60.0

View source

ensureInit

static function ensureInit(targetFps:Float = 60.0):Void

Only compiled when #if cpp.

Parameter	Type	Default
targetFps (optional)	Float	60.0

View source

isInitialized

static function isInitialized():Bool

Only compiled when #if cpp.

View source

isExportInProgress

static function isExportInProgress():Bool

Only compiled when #if cpp.

View source

abortInFlightFrame

static function abortInFlightFrame():Void

Only compiled when #if cpp.

View source

reset

static function reset():Void

Only compiled when #if cpp.

View source

setEnabled

static function setEnabled(enabled:Bool):Void

Only compiled when #if cpp.

Parameter	Type	Default
enabled	Bool	—

View source

isEnabled

static function isEnabled():Bool

Only compiled when #if cpp.

View source

setRssSampleInterval

static function setRssSampleInterval(intervalFrames:Int):Void

Only compiled when #if cpp.

Parameter	Type	Default
intervalFrames	Int	—

View source

getRssSampleInterval

static function getRssSampleInterval():Int

Only compiled when #if cpp.

View source

setCollectMemoryMetrics

static function setCollectMemoryMetrics(enabled:Bool):Void

Only compiled when #if cpp.

Parameter	Type	Default
enabled	Bool	—

View source

getCollectMemoryMetrics

static function getCollectMemoryMetrics():Bool

Only compiled when #if cpp.

View source

setTargetFps

static function setTargetFps(targetFps:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
targetFps	Float	—

View source

setStateName

static function setStateName(stateName:String):Void

Only compiled when #if cpp.

Parameter	Type	Default
stateName	String	—

View source

nowMs

static function nowMs():Float

Only compiled when #if cpp.

View source

beginFrame

static function beginFrame(heapUsedBytes:Float, heapReservedBytes:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—
heapReservedBytes	Float	—

View source

endFrame

static function endFrame(heapUsedBytes:Float, heapReservedBytes:Float, drawCalls:Int, explicitFrameTimeMs:Float = 0.0):Void

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—
heapReservedBytes	Float	—
drawCalls	Int	—
explicitFrameTimeMs (optional)	Float	0.0

View source

beginUpdate

static function beginUpdate(heapUsedBytes:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endUpdate

static function endUpdate(heapUsedBytes:Float):Float

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

beginRender

static function beginRender(heapUsedBytes:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endRender

static function endRender(heapUsedBytes:Float):Float

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

beginAudio

static function beginAudio(heapUsedBytes:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endAudio

static function endAudio(heapUsedBytes:Float):Float

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

beginGC

static function beginGC(heapUsedBytes:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endGC

static function endGC(heapUsedBytes:Float):Float

Only compiled when #if cpp.

Parameter	Type	Default
heapUsedBytes	Float	—

View source

recordPhaseMs

static function recordPhaseMs(phase:Int, durationMs:Float):Void

Only compiled when #if cpp.

Parameter	Type	Default
phase	Int	—
durationMs	Float	—

View source

recordAllocation

static function recordAllocation(bytes:Float, count:Int = 1):Void

Only compiled when #if cpp.

Parameter	Type	Default
bytes	Float	—
count (optional)	Int	1

View source

recordGCPause

static function recordGCPause(pauseMs:Float, reclaimedBytes:Float, isExplicit:Bool = true):Void

Only compiled when #if cpp.

Parameter	Type	Default
pauseMs	Float	—
reclaimedBytes	Float	—
isExplicit (optional)	Bool	true

View source

loadLastFrame

static function loadLastFrame():Bool

Only compiled when #if cpp.

View source

loadBufferedFrame

static function loadBufferedFrame(chronologicalIndex:Int):Bool

Only compiled when #if cpp.

Parameter	Type	Default
chronologicalIndex	Int	—

View source

getBufferedFrameCount

static function getBufferedFrameCount():Int

Only compiled when #if cpp.

View source

lastSampleFrameIndex

static function lastSampleFrameIndex():Int

Only compiled when #if cpp.

View source

lastSampleTimestampMs

static function lastSampleTimestampMs():Float

Only compiled when #if cpp.

View source

lastSampleFrameTimeMs

static function lastSampleFrameTimeMs():Float

Only compiled when #if cpp.

View source

lastSampleWorkTimeMs

static function lastSampleWorkTimeMs():Float

Only compiled when #if cpp.

View source

lastSampleFps

static function lastSampleFps():Float

Only compiled when #if cpp.

View source

lastSampleRollingFps

static function lastSampleRollingFps():Float

Only compiled when #if cpp.

View source

lastSampleUpdateTimeMs

static function lastSampleUpdateTimeMs():Float

Only compiled when #if cpp.

View source

lastSampleRenderTimeMs

static function lastSampleRenderTimeMs():Float

Only compiled when #if cpp.

View source

lastSampleAudioTimeMs

static function lastSampleAudioTimeMs():Float

Only compiled when #if cpp.

View source

lastSampleGcPauseMs

static function lastSampleGcPauseMs():Float

Only compiled when #if cpp.

View source

lastSampleOtherTimeMs

static function lastSampleOtherTimeMs():Float

Only compiled when #if cpp.

View source

lastSampleUpdateInclusiveMs

static function lastSampleUpdateInclusiveMs():Float

Only compiled when #if cpp.

View source

lastSampleRenderInclusiveMs

static function lastSampleRenderInclusiveMs():Float

Only compiled when #if cpp.

View source

lastSampleAudioInclusiveMs

static function lastSampleAudioInclusiveMs():Float

Only compiled when #if cpp.

View source

lastSampleGcInclusiveMs

static function lastSampleGcInclusiveMs():Float

Only compiled when #if cpp.

View source

lastSampleAllocBytes

static function lastSampleAllocBytes():Float

Only compiled when #if cpp.

View source

lastSampleAllocCount

static function lastSampleAllocCount():Int

Only compiled when #if cpp.

View source

lastSampleGcReclaimedBytes

static function lastSampleGcReclaimedBytes():Float

Only compiled when #if cpp.

View source

lastSampleNetHeapDeltaBytes

static function lastSampleNetHeapDeltaBytes():Float

Only compiled when #if cpp.

View source

lastSampleHeapUsedBytes

static function lastSampleHeapUsedBytes():Float

Only compiled when #if cpp.

View source

lastSampleHeapReservedBytes

static function lastSampleHeapReservedBytes():Float

Only compiled when #if cpp.

View source

lastSampleRssBytes

static function lastSampleRssBytes():Float

Only compiled when #if cpp.

View source

lastSamplePeakRssBytes

static function lastSamplePeakRssBytes():Float

Only compiled when #if cpp.

View source

lastSampleGcCount

static function lastSampleGcCount():Int

Only compiled when #if cpp.

View source

lastSampleExplicitGcCount

static function lastSampleExplicitGcCount():Int

Only compiled when #if cpp.

View source

lastSampleImplicitGcCount

static function lastSampleImplicitGcCount():Int

Only compiled when #if cpp.

View source

lastSampleDrawCalls

static function lastSampleDrawCalls():Int

Only compiled when #if cpp.

View source

lastSampleUpdateSteps

static function lastSampleUpdateSteps():Int

Only compiled when #if cpp.

View source

lastSampleRssSampled

static function lastSampleRssSampled():Bool

Only compiled when #if cpp.

View source

lastSampleStateName

static function lastSampleStateName():String

Only compiled when #if cpp.

View source

refreshSummary

static function refreshSummary():Void

Only compiled when #if cpp.

View source

summaryTotalFrames

static function summaryTotalFrames():Int

Only compiled when #if cpp.

View source

summaryBufferedFrames

static function summaryBufferedFrames():Int

Only compiled when #if cpp.

View source

summarySessionDurationMs

static function summarySessionDurationMs():Float

Only compiled when #if cpp.

View source

summaryTargetFps

static function summaryTargetFps():Float

Only compiled when #if cpp.

View source

summaryTargetFrameTimeMs

static function summaryTargetFrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryCurrentFps

static function summaryCurrentFps():Float

Only compiled when #if cpp.

View source

summaryAvgFps

static function summaryAvgFps():Float

Only compiled when #if cpp.

View source

summaryMinFps

static function summaryMinFps():Float

Only compiled when #if cpp.

View source

summaryMaxFps

static function summaryMaxFps():Float

Only compiled when #if cpp.

View source

summaryOnePercentLowFps

static function summaryOnePercentLowFps():Float

Only compiled when #if cpp.

View source

summaryPointOnePercentLowFps

static function summaryPointOnePercentLowFps():Float

Only compiled when #if cpp.

View source

summarySlowest1PctAvgFps

static function summarySlowest1PctAvgFps():Float

Only compiled when #if cpp.

View source

summarySlowest01PctAvgFps

static function summarySlowest01PctAvgFps():Float

Only compiled when #if cpp.

View source

summaryLastFrameTimeMs

static function summaryLastFrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryAvgFrameTimeMs

static function summaryAvgFrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryMinFrameTimeMs

static function summaryMinFrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryMaxFrameTimeMs

static function summaryMaxFrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryStdDevFrameTimeMs

static function summaryStdDevFrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryP50FrameTimeMs

static function summaryP50FrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryP95FrameTimeMs

static function summaryP95FrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryP99FrameTimeMs

static function summaryP99FrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryP999FrameTimeMs

static function summaryP999FrameTimeMs():Float

Only compiled when #if cpp.

View source

summaryAvgUpdateTimeMs

static function summaryAvgUpdateTimeMs():Float

Only compiled when #if cpp.

View source

summaryMaxUpdateTimeMs

static function summaryMaxUpdateTimeMs():Float

Only compiled when #if cpp.

View source

summaryP95UpdateTimeMs

static function summaryP95UpdateTimeMs():Float

Only compiled when #if cpp.

View source

summaryAvgRenderTimeMs

static function summaryAvgRenderTimeMs():Float

Only compiled when #if cpp.

View source

summaryMaxRenderTimeMs

static function summaryMaxRenderTimeMs():Float

Only compiled when #if cpp.

View source

summaryP95RenderTimeMs

static function summaryP95RenderTimeMs():Float

Only compiled when #if cpp.

View source

summaryAvgAudioTimeMs

static function summaryAvgAudioTimeMs():Float

Only compiled when #if cpp.

View source

summaryMaxAudioTimeMs

static function summaryMaxAudioTimeMs():Float

Only compiled when #if cpp.

View source

summaryP95AudioTimeMs

static function summaryP95AudioTimeMs():Float

Only compiled when #if cpp.

View source

summaryAvgOtherTimeMs

static function summaryAvgOtherTimeMs():Float

Only compiled when #if cpp.

View source

summaryMaxOtherTimeMs

static function summaryMaxOtherTimeMs():Float

Only compiled when #if cpp.

View source

summaryTotalGcCount

static function summaryTotalGcCount():Int

Only compiled when #if cpp.

View source

summaryTotalExplicitGcCount

static function summaryTotalExplicitGcCount():Int

Only compiled when #if cpp.

View source

summaryTotalImplicitGcCount

static function summaryTotalImplicitGcCount():Int

Only compiled when #if cpp.

View source

summaryFramesWithGc

static function summaryFramesWithGc():Int

Only compiled when #if cpp.

View source

summaryTotalGcPauseMs

static function summaryTotalGcPauseMs():Float

Only compiled when #if cpp.

View source

summaryAvgGcPauseMs

static function summaryAvgGcPauseMs():Float

Only compiled when #if cpp.

View source

summaryMaxGcPauseMs

static function summaryMaxGcPauseMs():Float

Only compiled when #if cpp.

View source

summaryMaxGcPauseFrame

static function summaryMaxGcPauseFrame():Int

Only compiled when #if cpp.

View source

summaryTotalGcReclaimedBytes

static function summaryTotalGcReclaimedBytes():Float

Only compiled when #if cpp.

View source

summaryTotalAllocBytes

static function summaryTotalAllocBytes():Float

Only compiled when #if cpp.

View source

summaryTotalAllocCount

static function summaryTotalAllocCount():Int

Only compiled when #if cpp.

View source

summaryAvgAllocBytesPerFrame

static function summaryAvgAllocBytesPerFrame():Float

Only compiled when #if cpp.

View source

summaryAllocRateBytesPerSec

static function summaryAllocRateBytesPerSec():Float

Only compiled when #if cpp.

View source

summaryPeakFrameAllocBytes

static function summaryPeakFrameAllocBytes():Float

Only compiled when #if cpp.

View source

summaryPeakFrameAllocFrame

static function summaryPeakFrameAllocFrame():Int

Only compiled when #if cpp.

View source

summaryCurrentHeapUsedBytes

static function summaryCurrentHeapUsedBytes():Float

Only compiled when #if cpp.

View source

summaryCurrentHeapReservedBytes

static function summaryCurrentHeapReservedBytes():Float

Only compiled when #if cpp.

View source

summaryPeakHeapUsedBytes

static function summaryPeakHeapUsedBytes():Float

Only compiled when #if cpp.

View source

summaryPeakHeapReservedBytes

static function summaryPeakHeapReservedBytes():Float

Only compiled when #if cpp.

View source

summaryCurrentRssBytes

static function summaryCurrentRssBytes():Float

Only compiled when #if cpp.

View source

summaryPeakRssBytes

static function summaryPeakRssBytes():Float

Only compiled when #if cpp.

View source

summaryDroppedFrames

static function summaryDroppedFrames():Int

Only compiled when #if cpp.

View source

summarySpikeCount16Ms

static function summarySpikeCount16Ms():Int

Only compiled when #if cpp.

View source

summarySpikeCount25Ms

static function summarySpikeCount25Ms():Int

Only compiled when #if cpp.

View source

summarySpikeCount33Ms

static function summarySpikeCount33Ms():Int

Only compiled when #if cpp.

View source

summarySpikeCount50Ms

static function summarySpikeCount50Ms():Int

Only compiled when #if cpp.

View source

summaryAvgDrawCalls

static function summaryAvgDrawCalls():Float

Only compiled when #if cpp.

View source

summaryMaxDrawCalls

static function summaryMaxDrawCalls():Int

Only compiled when #if cpp.

View source

summaryCpuTimeMs

static function summaryCpuTimeMs():Float

Only compiled when #if cpp.

View source

summaryCpuUtilizationPct

static function summaryCpuUtilizationPct():Float

Only compiled when #if cpp.

View source

summaryCpuNormalizedPct

static function summaryCpuNormalizedPct():Float

Only compiled when #if cpp.

View source

summaryLogicalCpuCount

static function summaryLogicalCpuCount():Int

Only compiled when #if cpp.

View source

summaryCpuTimeAvailable

static function summaryCpuTimeAvailable():Bool

Only compiled when #if cpp.

View source

summaryRssAvailable

static function summaryRssAvailable():Bool

Only compiled when #if cpp.

View source

summaryHeapStatsAvailable

static function summaryHeapStatsAvailable():Bool

Only compiled when #if cpp.

View source

summaryRssSampleIntervalFrames

static function summaryRssSampleIntervalFrames():Int

Only compiled when #if cpp.

View source

formatOverlay

static function formatOverlay():String

Only compiled when #if cpp.

View source

exportLog

static function exportLog(requestedPath:String = "", engineVersion:String = "0.3.2", platformName:String = "C++/hxcpp"):String

Only compiled when #if cpp.

Parameter	Type	Default
requestedPath (optional)	String	""
engineVersion (optional)	String	"0.3.2"
platformName (optional)	String	"C++/hxcpp"

View source

escapeCsvField

static function escapeCsvField(s:String):String

Only compiled when #if !(cpp).

Parameter	Type	Default
s	String	—

View source

nowMs

static function nowMs():Float

Only compiled when #if !(cpp).

View source

init

static function init(targetFps:Float = 60.0):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
targetFps (optional)	Float	60.0

View source

ensureInit

static function ensureInit(targetFps:Float = 60.0):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
targetFps (optional)	Float	60.0

View source

isInitialized

static function isInitialized():Bool

Only compiled when #if !(cpp).

View source

isExportInProgress

static function isExportInProgress():Bool

Only compiled when #if !(cpp).

View source

abortInFlightFrame

static function abortInFlightFrame():Void

Only compiled when #if !(cpp).

View source

reset

static function reset():Void

Only compiled when #if !(cpp).

View source

setEnabled

static function setEnabled(enabled:Bool):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
enabled	Bool	—

View source

isEnabled

static function isEnabled():Bool

Only compiled when #if !(cpp).

View source

setRssSampleInterval

static function setRssSampleInterval(intervalFrames:Int):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
intervalFrames	Int	—

View source

getRssSampleInterval

static function getRssSampleInterval():Int

Only compiled when #if !(cpp).

View source

setCollectMemoryMetrics

static function setCollectMemoryMetrics(enabled:Bool):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
enabled	Bool	—

View source

getCollectMemoryMetrics

static function getCollectMemoryMetrics():Bool

Only compiled when #if !(cpp).

View source

setTargetFps

static function setTargetFps(targetFps:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
targetFps	Float	—

View source

setStateName

static function setStateName(stateName:String):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
stateName	String	—

View source

beginFrame

static function beginFrame(heapUsedBytes:Float, heapReservedBytes:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—
heapReservedBytes	Float	—

View source

beginUpdate

static function beginUpdate(heapUsedBytes:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endUpdate

static function endUpdate(heapUsedBytes:Float):Float

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

beginRender

static function beginRender(heapUsedBytes:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endRender

static function endRender(heapUsedBytes:Float):Float

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

beginAudio

static function beginAudio(heapUsedBytes:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endAudio

static function endAudio(heapUsedBytes:Float):Float

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

beginGC

static function beginGC(heapUsedBytes:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

endGC

static function endGC(heapUsedBytes:Float):Float

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—

View source

recordPhaseMs

static function recordPhaseMs(phase:Int, durationMs:Float):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
phase	Int	—
durationMs	Float	—

View source

recordAllocation

static function recordAllocation(bytes:Float, count:Int = 1):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
bytes	Float	—
count (optional)	Int	1

View source

recordGCPause

static function recordGCPause(pauseMs:Float, reclaimedBytes:Float, isExplicit:Bool = true):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
pauseMs	Float	—
reclaimedBytes	Float	—
isExplicit (optional)	Bool	true

View source

endFrame

static function endFrame(heapUsedBytes:Float, heapReservedBytes:Float, drawCalls:Int, explicitFrameTimeMs:Float = 0.0):Void

Only compiled when #if !(cpp).

Parameter	Type	Default
heapUsedBytes	Float	—
heapReservedBytes	Float	—
drawCalls	Int	—
explicitFrameTimeMs (optional)	Float	0.0

View source

loadLastFrame

static function loadLastFrame():Bool

Only compiled when #if !(cpp).

View source

loadBufferedFrame

static function loadBufferedFrame(chronologicalIndex:Int):Bool

Only compiled when #if !(cpp).

Parameter	Type	Default
chronologicalIndex	Int	—

View source

getBufferedFrameCount

static function getBufferedFrameCount():Int

Only compiled when #if !(cpp).

View source

lastSampleFrameIndex

static function lastSampleFrameIndex():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleTimestampMs

static function lastSampleTimestampMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleFrameTimeMs

static function lastSampleFrameTimeMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleWorkTimeMs

static function lastSampleWorkTimeMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleFps

static function lastSampleFps():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleRollingFps

static function lastSampleRollingFps():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleUpdateTimeMs

static function lastSampleUpdateTimeMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleRenderTimeMs

static function lastSampleRenderTimeMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleAudioTimeMs

static function lastSampleAudioTimeMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleGcPauseMs

static function lastSampleGcPauseMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleOtherTimeMs

static function lastSampleOtherTimeMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleUpdateInclusiveMs

static function lastSampleUpdateInclusiveMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleRenderInclusiveMs

static function lastSampleRenderInclusiveMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleAudioInclusiveMs

static function lastSampleAudioInclusiveMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleGcInclusiveMs

static function lastSampleGcInclusiveMs():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleAllocBytes

static function lastSampleAllocBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleAllocCount

static function lastSampleAllocCount():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleGcReclaimedBytes

static function lastSampleGcReclaimedBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleNetHeapDeltaBytes

static function lastSampleNetHeapDeltaBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleHeapUsedBytes

static function lastSampleHeapUsedBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleHeapReservedBytes

static function lastSampleHeapReservedBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleRssBytes

static function lastSampleRssBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSamplePeakRssBytes

static function lastSamplePeakRssBytes():Float return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleGcCount

static function lastSampleGcCount():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleExplicitGcCount

static function lastSampleExplicitGcCount():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleImplicitGcCount

static function lastSampleImplicitGcCount():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleDrawCalls

static function lastSampleDrawCalls():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleUpdateSteps

static function lastSampleUpdateSteps():Int return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleRssSampled

static function lastSampleRssSampled():Bool return _loadedSample !

Only compiled when #if !(cpp).

View source

lastSampleStateName

static function lastSampleStateName():String return _loadedSample !

Only compiled when #if !(cpp).

View source

refreshSummary

static function refreshSummary():Void

Only compiled when #if !(cpp).

View source

summaryTotalFrames

static function summaryTotalFrames():Int return _totalFrames

Only compiled when #if !(cpp).

View source

summaryBufferedFrames

static function summaryBufferedFrames():Int return _ringCount

Only compiled when #if !(cpp).

View source

summarySessionDurationMs

static function summarySessionDurationMs():Float return _sumFrameTimeMs

Only compiled when #if !(cpp).

View source

summaryTargetFps

static function summaryTargetFps():Float return _targetFps

Only compiled when #if !(cpp).

View source

summaryTargetFrameTimeMs

static function summaryTargetFrameTimeMs():Float return _targetFps > 0.0 ? (1000.0 / _targetFps) : 16.6667

Only compiled when #if !(cpp).

View source

summaryCurrentFps

static function summaryCurrentFps():Float return _currentRollingFps

Only compiled when #if !(cpp).

View source

summaryAvgFps

static function summaryAvgFps():Float return _totalFrames > 0 && _sumFrameTimeMs > 0.0 ? ((_totalFrames * 1000.0) / _sumFrameTimeMs) : 0.0

Only compiled when #if !(cpp).

View source

summaryMinFps

static function summaryMinFps():Float return _maxFrameTimeMs > 0.0 ? (1000.0 / _maxFrameTimeMs) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxFps

static function summaryMaxFps():Float return _minFrameTimeMs < 1e11 && _minFrameTimeMs > 0.0 ? (1000.0 / _minFrameTimeMs) : 0.0

Only compiled when #if !(cpp).

View source

summaryOnePercentLowFps

static function summaryOnePercentLowFps():Float return _summaryP99 > 0.0 ? (1000.0 / _summaryP99) : 0.0

Only compiled when #if !(cpp).

View source

summaryPointOnePercentLowFps

static function summaryPointOnePercentLowFps():Float return _summaryP999 > 0.0 ? (1000.0 / _summaryP999) : 0.0

Only compiled when #if !(cpp).

View source

summarySlowest1PctAvgFps

static function summarySlowest1PctAvgFps():Float return _summarySlowest1PctFps

Only compiled when #if !(cpp).

View source

summarySlowest01PctAvgFps

static function summarySlowest01PctAvgFps():Float return _summarySlowest01PctFps

Only compiled when #if !(cpp).

View source

summaryLastFrameTimeMs

static function summaryLastFrameTimeMs():Float return loadLastFrame() ? _loadedSample.frameTimeMs : 0.0

Only compiled when #if !(cpp).

View source

summaryAvgFrameTimeMs

static function summaryAvgFrameTimeMs():Float return _totalFrames > 0 ? (_sumFrameTimeMs / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryMinFrameTimeMs

static function summaryMinFrameTimeMs():Float return _minFrameTimeMs < 1e11 ? _minFrameTimeMs : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxFrameTimeMs

static function summaryMaxFrameTimeMs():Float return _maxFrameTimeMs

Only compiled when #if !(cpp).

View source

summaryStdDevFrameTimeMs

static function summaryStdDevFrameTimeMs():Float

Only compiled when #if !(cpp).

View source

summaryP50FrameTimeMs

static function summaryP50FrameTimeMs():Float return _summaryP50

Only compiled when #if !(cpp).

View source

summaryP95FrameTimeMs

static function summaryP95FrameTimeMs():Float return _summaryP95

Only compiled when #if !(cpp).

View source

summaryP99FrameTimeMs

static function summaryP99FrameTimeMs():Float return _summaryP99

Only compiled when #if !(cpp).

View source

summaryP999FrameTimeMs

static function summaryP999FrameTimeMs():Float return _summaryP999

Only compiled when #if !(cpp).

View source

summaryAvgUpdateTimeMs

static function summaryAvgUpdateTimeMs():Float return _totalFrames > 0 ? (_sumUpdateMs / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxUpdateTimeMs

static function summaryMaxUpdateTimeMs():Float return _maxUpdateMs

Only compiled when #if !(cpp).

View source

summaryP95UpdateTimeMs

static function summaryP95UpdateTimeMs():Float return _summaryP95Update

Only compiled when #if !(cpp).

View source

summaryAvgRenderTimeMs

static function summaryAvgRenderTimeMs():Float return _totalFrames > 0 ? (_sumRenderMs / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxRenderTimeMs

static function summaryMaxRenderTimeMs():Float return _maxRenderMs

Only compiled when #if !(cpp).

View source

summaryP95RenderTimeMs

static function summaryP95RenderTimeMs():Float return _summaryP95Render

Only compiled when #if !(cpp).

View source

summaryAvgAudioTimeMs

static function summaryAvgAudioTimeMs():Float return _totalFrames > 0 ? (_sumAudioMs / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxAudioTimeMs

static function summaryMaxAudioTimeMs():Float return _maxAudioMs

Only compiled when #if !(cpp).

View source

summaryP95AudioTimeMs

static function summaryP95AudioTimeMs():Float return _summaryP95Audio

Only compiled when #if !(cpp).

View source

summaryAvgOtherTimeMs

static function summaryAvgOtherTimeMs():Float return _totalFrames > 0 ? (_sumOtherMs / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxOtherTimeMs

static function summaryMaxOtherTimeMs():Float return _maxOtherMs

Only compiled when #if !(cpp).

View source

summaryTotalGcCount

static function summaryTotalGcCount():Int return _totalGcCount

Only compiled when #if !(cpp).

View source

summaryTotalExplicitGcCount

static function summaryTotalExplicitGcCount():Int return _totalExplicitGcCount

Only compiled when #if !(cpp).

View source

summaryTotalImplicitGcCount

static function summaryTotalImplicitGcCount():Int return _totalImplicitGcCount

Only compiled when #if !(cpp).

View source

summaryFramesWithGc

static function summaryFramesWithGc():Int return _framesWithGc

Only compiled when #if !(cpp).

View source

summaryTotalGcPauseMs

static function summaryTotalGcPauseMs():Float return _totalGcPauseMs

Only compiled when #if !(cpp).

View source

summaryAvgGcPauseMs

static function summaryAvgGcPauseMs():Float return _totalGcCount > 0 ? (_totalGcPauseMs / _totalGcCount) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxGcPauseMs

static function summaryMaxGcPauseMs():Float return _maxGcPauseMs

Only compiled when #if !(cpp).

View source

summaryMaxGcPauseFrame

static function summaryMaxGcPauseFrame():Int return _maxGcPauseFrame

Only compiled when #if !(cpp).

View source

summaryTotalGcReclaimedBytes

static function summaryTotalGcReclaimedBytes():Float return _totalGcReclaimedBytes

Only compiled when #if !(cpp).

View source

summaryTotalAllocBytes

static function summaryTotalAllocBytes():Float return _totalAllocBytes

Only compiled when #if !(cpp).

View source

summaryTotalAllocCount

static function summaryTotalAllocCount():Int return _totalAllocCount

Only compiled when #if !(cpp).

View source

summaryAvgAllocBytesPerFrame

static function summaryAvgAllocBytesPerFrame():Float return _totalFrames > 0 ? (_totalAllocBytes / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryAllocRateBytesPerSec

static function summaryAllocRateBytesPerSec():Float return _sumFrameTimeMs > 0.0 ? ((_totalAllocBytes * 1000.0) / _sumFrameTimeMs) : 0.0

Only compiled when #if !(cpp).

View source

summaryPeakFrameAllocBytes

static function summaryPeakFrameAllocBytes():Float return _peakFrameAllocBytes

Only compiled when #if !(cpp).

View source

summaryPeakFrameAllocFrame

static function summaryPeakFrameAllocFrame():Int return _peakFrameAllocFrame

Only compiled when #if !(cpp).

View source

summaryCurrentHeapUsedBytes

static function summaryCurrentHeapUsedBytes():Float return _currentHeapUsed

Only compiled when #if !(cpp).

View source

summaryCurrentHeapReservedBytes

static function summaryCurrentHeapReservedBytes():Float return _currentHeapReserved

Only compiled when #if !(cpp).

View source

summaryPeakHeapUsedBytes

static function summaryPeakHeapUsedBytes():Float return _peakHeapUsed

Only compiled when #if !(cpp).

View source

summaryPeakHeapReservedBytes

static function summaryPeakHeapReservedBytes():Float return _peakHeapReserved

Only compiled when #if !(cpp).

View source

summaryCurrentRssBytes

static function summaryCurrentRssBytes():Float return _collectMemory ? _lastSampledRss : 0.0

Only compiled when #if !(cpp).

View source

summaryPeakRssBytes

static function summaryPeakRssBytes():Float return _collectMemory ? _lastSampledPeakRss : 0.0

Only compiled when #if !(cpp).

View source

summaryDroppedFrames

static function summaryDroppedFrames():Int return _droppedFrames

Only compiled when #if !(cpp).

View source

summarySpikeCount16Ms

static function summarySpikeCount16Ms():Int return _spike16

Only compiled when #if !(cpp).

View source

summarySpikeCount25Ms

static function summarySpikeCount25Ms():Int return _spike25

Only compiled when #if !(cpp).

View source

summarySpikeCount33Ms

static function summarySpikeCount33Ms():Int return _spike33

Only compiled when #if !(cpp).

View source

summarySpikeCount50Ms

static function summarySpikeCount50Ms():Int return _spike50

Only compiled when #if !(cpp).

View source

summaryAvgDrawCalls

static function summaryAvgDrawCalls():Float return _totalFrames > 0 ? (_totalDrawCalls / _totalFrames) : 0.0

Only compiled when #if !(cpp).

View source

summaryMaxDrawCalls

static function summaryMaxDrawCalls():Int return _maxDrawCalls

Only compiled when #if !(cpp).

View source

summaryCpuTimeMs

static function summaryCpuTimeMs():Float return 0.0

Only compiled when #if !(cpp).

View source

summaryCpuUtilizationPct

static function summaryCpuUtilizationPct():Float return 0.0

Only compiled when #if !(cpp).

View source

summaryCpuNormalizedPct

static function summaryCpuNormalizedPct():Float return 0.0

Only compiled when #if !(cpp).

View source

summaryLogicalCpuCount

static function summaryLogicalCpuCount():Int return 1

Only compiled when #if !(cpp).

View source

summaryCpuTimeAvailable

static function summaryCpuTimeAvailable():Bool return false

Only compiled when #if !(cpp).

View source

summaryRssAvailable

static function summaryRssAvailable():Bool return _collectMemory && _rssAvailable

Only compiled when #if !(cpp).

View source

summaryHeapStatsAvailable

static function summaryHeapStatsAvailable():Bool return _collectMemory && _heapStatsAvailable

Only compiled when #if !(cpp).

View source

summaryRssSampleIntervalFrames

static function summaryRssSampleIntervalFrames():Int return _rssSampleInterval

Only compiled when #if !(cpp).

View source

formatOverlay

static function formatOverlay():String

Only compiled when #if !(cpp).

View source

resolveLogPath

static function resolveLogPath(requestedPath:String):String

Only compiled when #if !(cpp).

Parameter	Type	Default
requestedPath	String	—

View source

exportLog

static function exportLog(requestedPath:String = "", engineVersion:String = "0.3.2", platformName:String = "Haxe"):String

Only compiled when #if !(cpp).

Parameter	Type	Default
requestedPath (optional)	String	""
engineVersion (optional)	String	"0.3.2"
platformName (optional)	String	"Haxe"

View source

Internals

Private / internal members

Field	Type	Static
_initialized	Bool	yes
_enabled	Bool	yes
_inFlight	Bool	yes
_exportInProgress	Bool	yes
_collectMemory	Bool	yes
_rssSampleInterval	Int	yes
_targetFps	Float	yes
_sessionStartMs	Float	yes
_currentFrameStartMs	Float	yes
_lastFrameEndMs	Float	yes
_currentRollingFps	Float	yes
_rollingWindowMs	Float	yes
_rollingWindowCount	Int	yes
_currentStateName	String	yes
_cachedOverlayFrame	Int	yes
_cachedOverlayP95	Float	yes
_cachedOverlayP99	Float	yes
_phaseStack	Array<{phase:Int, startMs:Float, childDurationMs:Float}>	yes
_phaseDepth	Array<Int>	yes
_hasObservedHeap	Bool	yes
_heapStatsAvailable	Bool	yes
_rssAvailable	Bool	yes
_lastObservedHeap	Float	yes
_frameStartHeap	Float	yes
_currentHeapUsed	Float	yes
_currentHeapReserved	Float	yes
_peakHeapUsed	Float	yes
_peakHeapReserved	Float	yes
_lastSampledRss	Float	yes
_lastSampledPeakRss	Float	yes
_totalFrames	Int	yes
_sumFrameTimeMs	Float	yes
_sumSqFrameTimeMs	Float	yes
_minFrameTimeMs	Float	yes
_maxFrameTimeMs	Float	yes
_sumUpdateMs	Float	yes
_maxUpdateMs	Float	yes
_sumRenderMs	Float	yes
_maxRenderMs	Float	yes
_sumAudioMs	Float	yes
_maxAudioMs	Float	yes
_sumOtherMs	Float	yes
_maxOtherMs	Float	yes
_totalGcCount	Int	yes
_totalExplicitGcCount	Int	yes
_totalImplicitGcCount	Int	yes
_framesWithGc	Int	yes
_totalGcPauseMs	Float	yes
_maxGcPauseMs	Float	yes
_maxGcPauseFrame	Int	yes
_totalGcReclaimedBytes	Float	yes
_totalAllocBytes	Float	yes
_totalAllocCount	Int	yes
_peakFrameAllocBytes	Float	yes
_peakFrameAllocFrame	Int	yes
_droppedFrames	Int	yes
_spike16	Int	yes
_spike25	Int	yes
_spike33	Int	yes
_spike50	Int	yes
_totalDrawCalls	Int	yes
_maxDrawCalls	Int	yes
_samples	Array<FallbackSample>	yes
_ringWriteIndex	Int	yes
_ringCount	Int	yes
_activeSample	FallbackSample	yes
_loadedSample	FallbackSample	yes
_summaryP50	Float	yes
_summaryP95	Float	yes
_summaryP99	Float	yes
_summaryP999	Float	yes
_summarySlowest1PctFps	Float	yes
_summarySlowest01PctFps	Float	yes
_summaryP95Update	Float	yes
_summaryP95Render	Float	yes
_summaryP95Audio	Float	yes

Method
static inline function isFiniteFloat(v:Float):Bool
static inline function sanitizeDuration(v:Float):Float
static function sanitizeSingleLine(s:String):String
static function observeHeap(heapUsedBytes:Float, isExplicitGcEnd:Bool):Void
static function beginPhase(phase:Int, heapUsedBytes:Float):Void
static function popTopPhaseAt(now:Float, heapUsedBytes:Float):Float
static function endPhase(phase:Int, heapUsedBytes:Float):Float
static function percentile(sorted:Array<Float>, p:Float):Float
static function slowestTailMeanFps(sorted:Array<Float>, tailFraction:Float):Float
static function roundStr(v:Float, decimals:Int = 2):String