SceneOptimizer

Class used to run optimizations in order to reach a target frame rate

description

More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer

Hierarchy

  • SceneOptimizer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new SceneOptimizer

    Parameters

    • scene: Scene

      defines the scene to work on

    • Optional options: SceneOptimizerOptions

      defines the options to use with the SceneOptimizer

    • Optional autoGeneratePriorities: boolean

      defines if priorities must be generated and not read from SceneOptimization property (true by default)

    • Optional improvementMode: boolean

      defines if the scene optimizer must run the maximum optimization while staying over a target frame instead of trying to reach the target framerate (false by default)

    Returns SceneOptimizer

Properties

currentFrameRate

currentFrameRate: number

Gets the current frame rate checked by the SceneOptimizer

currentPriorityLevel

currentPriorityLevel: number

Gets the current priority level (0 at start)

isInImprovementMode

isInImprovementMode: boolean

Gets a boolean indicating if the optimizer is in improvement mode

onFailureObservable

onFailureObservable: Observable<SceneOptimizer>

Defines an observable called when the optimizer is not able to reach the target frame rate

onNewOptimizationAppliedObservable

onNewOptimizationAppliedObservable: Observable<SceneOptimization>

Defines an observable called when the optimizer enables an optimization

onSuccessObservable

onSuccessObservable: Observable<SceneOptimizer>

Defines an observable called when the optimizer reaches the target frame rate

optimizations

optimizations: SceneOptimization[]

Gets the list of active optimizations

targetFrameRate

targetFrameRate: number

Gets or sets the current target frame rate (60 by default)

trackerDuration

trackerDuration: number

Gets or sets the current interval between two checks (every 2000ms by default)

Methods

dispose

  • dispose(): void

reset

  • reset(): void

  • Reset the optimizer to initial step (current priority level = 0)

    Returns void

start

  • start(): void

  • Start the optimizer. By default it will try to reach a specific framerate but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate

    Returns void

stop

  • stop(): void

  • Stops the current optimizer

    Returns void

Static OptimizeAsync

  • Helper function to create a SceneOptimizer with one single line of code

    Parameters

    • scene: Scene

      defines the scene to work on

    • Optional options: SceneOptimizerOptions

      defines the options to use with the SceneOptimizer

    • Optional onSuccess: function

      defines a callback to call on success

        • (): void

        • Returns void

    • Optional onFailure: function

      defines a callback to call on failure

        • (): void

        • Returns void

    Returns SceneOptimizer

    the new SceneOptimizer object

Generated using TypeDoc