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 getFramesAverageMeasures getProfilerSectionTexts getStats

Constructors

constructor

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

Methods

begin

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

beginFrame

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

end

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

endFrame

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

getFramesAverageMeasures

getFramesAverageMeasures(): FrameMeasure
Return the measures for all the section of the game during the frames captured.

Returns FrameMeasure
- Defined in GDJS/Runtime/profiler.ts:159

`Static` getProfilerSectionTexts

getProfilerSectionTexts(sectionName, profilerSection, outputs): void
Convert measures for a section into texts. Useful for ingame profiling.
Parameters
- sectionName: string
  The name of the section
- profilerSection: any
  The section measures
- outputs: any
  The array where to push the results
Returns void
- Defined in GDJS/Runtime/profiler.ts:192

getStats

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

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