Class PerformanceStatisticsInternal

constructor

• new PerformanceStatistics(enabled?, maxNumFrames?): PerformanceStatistics

• Creates an instance of PerformanceStatistics. Overrides the current instance.

  Parameters

  • Optional enabled: boolean = true

    If false the performance values will not be stored.

  • Optional maxNumFrames: number = 1000

    The maximum number of frames that are to be stored.

  Returns PerformanceStatistics

  Memberof

  PerformanceStatistics

Readonly appResults

Readonly configs

Readonly currentFrame

enabled

maxNumFrames

isFull

• get isFull(): boolean

• Returns true when the maximum number of storable frames is reached.

  Returns boolean

  Memberof

  PerformanceStatistics

Static instance

• get instance(): PerformanceStatistics

• Global instance to the instance. The current instance can be overridden by creating a new PerformanceStatistics.

  Returns PerformanceStatistics

addMemoryInfo

• addMemoryInfo(): void

• Add memory statistics to the current frame if available.

  Returns void

  Note

  Currently only supported on Chrome

addWebGLInfo

• addWebGLInfo(webGlInfo): void

• Add the render state information from [[THREE.WebGLInfo]] to the current frame.

  Parameters

  • webGlInfo: WebGLInfo

  Returns void

clear

• clear(): void

• Clears all settings, all stored frame events as well as the current frame values.

  Returns void

  Memberof

  PerformanceStatistics

clearFrames

• clearFrames(): void

• Clears only all stored frame events as well as the current frame values.

  Returns void

  Memberof

  PerformanceStatistics

getAsPlainObject

• getAsPlainObject(onlyLastFrame?): any

• Convert to a plain object that can be serialized. Required to copy the test results over to nightwatch.

  Parameters

  • onlyLastFrame: boolean = false

  Returns any

getAsSimpleFrameStatistics

• getAsSimpleFrameStatistics(onlyLastFrame?): SimpleFrameStatistics

• Convert to a plain object that can be serialized. Required to copy the test results over to nightwatch.

  Parameters

  • onlyLastFrame: boolean = false

  Returns SimpleFrameStatistics

getLastFrameStatistics

• getLastFrameStatistics(): any

• Convert the last frame values to a plain object that can be serialized. Required to copy the test results over to nightwatch.

  Returns any

log

• log(header?, footer?): void

• Logs all values to the logger.

  Parameters

  • Optional header: string

    Optional header line.

  • Optional footer: string

    Optional footer line.

  Returns void

storeAndClearFrameInfo

• storeAndClearFrameInfo(): boolean

• Stores the current frame events into the array of events and clears all values.

  Returns boolean

  Returns false if the maximum number of storable frames has been reached.

  Memberof

  PerformanceStatistics