Skip to main content

FrameSample

Kindtypedef
Packagedebug
Full namedebug.FrameSample
Sourcesource/debug/FrameProfiler.hx

Per-frame sample snapshot captured by the Phoenix Engine frame profiler.

Units & Semantics:

  • All durations are in milliseconds.
  • Exclusive durations (updateTimeMs, renderTimeMs, audioTimeMs, gcPauseMs): Nested child phase durations are subtracted from their enclosing parent phase via an explicit LIFO phase stack (phaseStack).
  • Inclusive durations (updateInclusiveMs, renderInclusiveMs, audioInclusiveMs, gcInclusiveMs): Total time spent inside the outermost activation(s) of each phase, including nested child phases.
  • gcPauseMs and gcCount/explicitGcCount reflect directly measured GC pauses.
  • implicitGcCount counts observed negative heap-delta intervals outside explicit GC scopes (heuristic indicator of uninstrumented collection, not an exact cycle count).
  • rssSampled is true when process RSS was freshly sampled on this frame and false when carried forward from the previous periodic RSS sample.

Internals​

Private / internal members
FieldTypeStatic
frameIndexIntno
timestampMsFloatno
frameTimeMsFloatno
workTimeMsFloatno
fpsFloatno
rollingFpsFloatno
updateTimeMsFloatno
renderTimeMsFloatno
audioTimeMsFloatno
gcPauseMsFloatno
otherTimeMsFloatno
updateInclusiveMsFloatno
renderInclusiveMsFloatno
audioInclusiveMsFloatno
gcInclusiveMsFloatno
allocBytesFloatno
allocCountIntno
gcReclaimedBytesFloatno
netHeapDeltaBytesFloatno
heapUsedBytesFloatno
heapReservedBytesFloatno
rssBytesFloatno
peakRssBytesFloatno
gcCountIntno
explicitGcCountIntno
implicitGcCountIntno
drawCallsIntno
updateStepsIntno
rssSampledBoolno
stateNameStringno