Class Profiler

A basic profiling tool that can be used to measure time spent in sections of the engine.

Index

Constructors

Methods

begin beginFrame end endFrame getFrameTimes getFramesAverageMeasures getFramesMaxMeasures getProfilerSectionTexts getStats

Constructors

constructor

new Profiler(): Profiler
Returns Profiler
- Defined in GDJS/Runtime/profiler.ts:59

Methods

begin

begin(sectionName): void
Parameters
- sectionName: string
Returns void
- Defined in GDJS/Runtime/profiler.ts:84

beginFrame

beginFrame(): void
Returns void
- Defined in GDJS/Runtime/profiler.ts:74

end

end(sectionName?): void
Parameters
- Optional sectionName: string
Returns void
- Defined in GDJS/Runtime/profiler.ts:106

endFrame

endFrame(): void
Returns void
- Defined in GDJS/Runtime/profiler.ts:123

getFrameTimes

getFrameTimes(): number[]
Return the total time of each captured frame, in chronological order (up to the last 600 frames).

Returns number[]
- Defined in GDJS/Runtime/profiler.ts:241

getFramesAverageMeasures

getFramesAverageMeasures(): FrameMeasureOutput
Return the measures for all the section of the game during the frames captured, as a plain tree (no back-references): safe to serialize with JSON.stringify.

Returns FrameMeasureOutput
- Defined in GDJS/Runtime/profiler.ts:177

getFramesMaxMeasures

getFramesMaxMeasures(): FrameMeasureOutput
Return, for each section, the maximum time it took during a single captured frame - the "worst frame" per section, catching the spikes that averages hide. Plain tree, safe to serialize with JSON.stringify.

Returns FrameMeasureOutput
- Defined in GDJS/Runtime/profiler.ts:223

`Static` getProfilerSectionTexts

getProfilerSectionTexts(sectionName, profilerSection, outputs, parentTime?): void
Convert measures for a section into texts. Useful for ingame profiling.
Parameters
- sectionName: string
  The name of the section
- profilerSection: FrameMeasureOutput
  The section measures
- outputs: string[]
  The array where to push the results
- Optional parentTime: null | number
Returns void
- Defined in GDJS/Runtime/profiler.ts:267

getStats

getStats(): ProfilerStats
Get stats measured during the frames captured.

Returns ProfilerStats
- Defined in GDJS/Runtime/profiler.ts:255