Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines an optimization based on user defined callback.

description

More details at https://doc.babylonjs.com/features/featuresDeepDive/scene/sceneOptimizer

Hierarchy

Index

Constructors

  • Creates the SceneOptimization object

    Parameters

    • Optional priority: number

      defines the priority of this optimization (0 by default which means first in the list)

    Returns CustomOptimization

Properties

onApply: ((scene: Scene, optimizer: SceneOptimizer) => boolean)

Type declaration

onGetDescription: (() => string)

Type declaration

    • (): string
    • Callback called to get custom description

      Returns string

priority: number

Defines the priority of this optimization (0 by default which means first in the list)

Methods

  • This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization

    Parameters

    • scene: Scene

      defines the current scene where to apply this optimization

    • optimizer: SceneOptimizer

      defines the current optimizer

    Returns boolean

    true if everything that can be done was applied

  • getDescription(): string
  • Gets a string describing the action executed by the current optimization

    Returns string

    description string

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme