Class Profiler

Index

Constructors

Methods

begin beginFrame end endFrame getAverage getAverageFrameTime getTimingSummary reset setEnabled setSlowFrameThreshold

Constructors

constructor

new Profiler(): Profiler
Returns Profiler

Methods

begin

begin(label: string): void
Begin timing a named section
Parameters
- label: string
Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:48

beginFrame

beginFrame(): void
Call at the start of each frame

Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:30

end

end(label: string): void
End timing a named section
Parameters
- label: string
Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:54

endFrame

endFrame(): void
Call at the end of each frame

Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:36

getAverage

getAverage(label: string): number
Get average ms for a timing label
Parameters
- label: string
Returns number
- Defined in packages/clik-engine/src/debug/Profiler.ts:76

getAverageFrameTime

getAverageFrameTime(): number
Get average frame time

Returns number
- Defined in packages/clik-engine/src/debug/Profiler.ts:83

getTimingSummary

getTimingSummary(): Record<string, string>
Get timing summary for all tracked sections

Returns Record<string, string>
- Defined in packages/clik-engine/src/debug/Profiler.ts:89

reset

reset(): void
Reset all timings

Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:102

setEnabled

setEnabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:21

setSlowFrameThreshold

setSlowFrameThreshold(ms: number): void
Parameters
- ms: number
Returns void
- Defined in packages/clik-engine/src/debug/Profiler.ts:25