Class GlobalLightSource

constructor

• new GlobalLightSource(options?): GlobalLightSource

• An effect source is constructed by providing configuration options.

  Parameters

  • Optional options: BasseEffectSourceOptions = {}

    Options which modify the base effect source instance

  Returns GlobalLightSource

ratio

Static _initializeShaderKeys

Static _refreshUniformsKeys

Static EDGE_OFFSET

_initialize

• _initialize(data): void

• Parameters

  • data: any

  Returns void

_updateColorationUniforms

• _updateColorationUniforms(): void

• Update shader uniforms used for the coloration layer.

  Returns void

_updateIlluminationUniforms

• _updateIlluminationUniforms(): void

• Update shader uniforms used for the illumination layer.

  Returns void

_updateBackgroundUniforms

• _updateBackgroundUniforms(): void

• Update shader uniforms used for the background layer.

  Returns void

animateTorch

• animateTorch(dt, options?): void

• An animation with flickering ratio and light intensity.

  Parameters

  • dt: number

    Delta time
  • Optional options: {
        speed: number;
        intensity: number;
        reverse: boolean;
    } = {}

    Additional options which modify the flame animation

    • speed: number

      The animation speed, from 0 to 10

    • intensity: number

      The animation intensity, from 1 to 10

    • reverse: boolean

      Reverse the animation direction

  Returns void

animateFlickering

• animateFlickering(dt, options?): void

• An animation with flickering ratio and light intensity

  Parameters

  • dt: number

    Delta time
  • Optional options: {
        speed: number;
        intensity: number;
        amplification: number;
        reverse: boolean;
    } = {}

    Additional options which modify the flame animation

    • speed: number

      The animation speed, from 0 to 10

    • intensity: number

      The animation intensity, from 1 to 10

    • amplification: number

      Noise amplification (>1) or dampening (<1)

    • reverse: boolean

      Reverse the animation direction

  Returns void

animatePulse

• animatePulse(dt, options?): void

• A basic "pulse" animation which expands and contracts.

  Parameters

  • dt: number

    Delta time
  • Optional options: {
        speed: number;
        intensity: number;
        reverse: boolean;
    } = {}

    Additional options which modify the pulse animation

    • speed: number

      The animation speed, from 0 to 10

    • intensity: number

      The animation intensity, from 1 to 10

    • reverse: boolean

      Reverse the animation direction

  Returns void

Static getCorrectedLevel

• getCorrectedLevel(level): number

• Get corrected level according to level and active vision mode data.

  Parameters

  • level: LIGHTING_LEVELS

  Returns number

  The corrected level.

Static getCorrectedColor

• getCorrectedColor(level, colorDim, colorBright, colorBackground?): typeof Color

• Get corrected color according to level, dim color, bright color and background color.

  Parameters

  • level: LIGHTING_LEVELS
  • colorDim: typeof Color
  • colorBright: typeof Color
  • Optional colorBackground: typeof Color

  Returns typeof Color