Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PerformanceStatistics

Performance measurement central.

remarks

Maintains the current. Implemented as an instance for easy access.

FrameStats, which holds all individual performance numbers.

internal

Hierarchy

  • PerformanceStatistics

Index

Constructors

constructor

Properties

Readonly appResults

appResults: Map<string, number> = new Map()

Additional results stored for the current application run, not per frame. Only the last value is stored.

Readonly configs

configs: Map<string, string> = new Map()

Additional configuration values stored for the current application run, not per frame. Only the last value is stored.

memberof

PerformanceStatistics

Readonly currentFrame

currentFrame: FrameStats = new FrameStats()

Current frame statistics. Contains all values for the current frame. Will be cleared when [[PerformanceStatistics#storeFrameInfo]] is called.

memberof

PerformanceStatistics

enabled

enabled: boolean

maxNumFrames

maxNumFrames: number

Accessors

isFull

  • get isFull(): boolean

Static instance

Methods

addMemoryInfo

  • addMemoryInfo(): void

addWebGLInfo

  • addWebGLInfo(webGlInfo: WebGLInfo): void

clear

  • clear(): void

clearFrames

  • clearFrames(): void

getAsPlainObject

  • getAsPlainObject(onlyLastFrame?: boolean): any
  • Convert to a plain object that can be serialized. Required to copy the test results over to nightwatch.

    Parameters

    • Default value onlyLastFrame: boolean = false

    Returns any

getAsSimpleFrameStatistics

getLastFrameStatistics

  • getLastFrameStatistics(): any

log

  • log(header?: undefined | string, footer?: undefined | string): void
  • Logs all values to the logger.

    Parameters

    • Optional header: undefined | string

      Optional header line.

    • Optional footer: undefined | string

      Optional footer line.

    Returns void

storeAndClearFrameInfo

  • storeAndClearFrameInfo(): boolean
  • Stores the current frame events into the array of events and clears all values.

    memberof

    PerformanceStatistics

    Returns boolean

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

Generated using TypeDoc