Class SceneOptimizer

constructor

• new SceneOptimizer(
      scene: Scene,
      options?: SceneOptimizerOptions,
      autoGeneratePriorities?: boolean,
      improvementMode?: boolean,
  ): SceneOptimizer

  Creates a new SceneOptimizer

  Parameters

  • scene: Scene

    defines the scene to work on

  • Optionaloptions: SceneOptimizerOptions

    defines the options to use with the SceneOptimizer

  • autoGeneratePriorities: boolean = true

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

  • improvementMode: boolean = false

    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

onFailureObservable

onNewOptimizationAppliedObservable

onSuccessObservable

currentFrameRate

• get currentFrameRate(): number

  Gets the current frame rate checked by the SceneOptimizer

  Returns number

currentPriorityLevel

• get currentPriorityLevel(): number

  Gets the current priority level (0 at start)

  Returns number

isInImprovementMode

• get isInImprovementMode(): boolean

  Gets or sets a boolean indicating if the optimizer is in improvement mode

  Returns boolean

• set isInImprovementMode(value: boolean): void

  Parameters

  • value: boolean

  Returns void

optimizations

• get optimizations(): SceneOptimization[]

  Gets the list of active optimizations

  Returns SceneOptimization[]

targetFrameRate

• get targetFrameRate(): number

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

  Returns number

• set targetFrameRate(value: number): void

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

  Parameters

  • value: number

  Returns void

trackerDuration

• get trackerDuration(): number

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

  Returns number

• set trackerDuration(value: number): void

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

  Parameters

  • value: number

  Returns void

dispose

• dispose(): void

  Release all resources

  Returns 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 optimization while frame rate is above the target frame rate

  Returns void

stop

• stop(): void

  Stops the current optimizer

  Returns void

StaticOptimizeAsync

• OptimizeAsync(
      scene: Scene,
      options?: SceneOptimizerOptions,
      onSuccess?: () => void,
      onFailure?: () => void,
  ): SceneOptimizer

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

  Parameters

  • scene: Scene

    defines the scene to work on

  • Optionaloptions: SceneOptimizerOptions

    defines the options to use with the SceneOptimizer

  • OptionalonSuccess: () => void

    defines a callback to call on success

  • OptionalonFailure: () => void

    defines a callback to call on failure

  Returns SceneOptimizer

  the new SceneOptimizer object