Class GlobalLightSource

ratio

Static_initializeShaderKeys

Static_refreshUniformsKeys

StaticEDGE_OFFSET

Static_layers

• get _layers(): {
      background: {
          blendMode: string;
          defaultShader: typeof AdaptiveBackgroundShader;
      };
      coloration: {
          blendMode: string;
          defaultShader: typeof AdaptiveColorationShader;
      };
      illumination: {
          blendMode: string;
          defaultShader: typeof AdaptiveIlluminationShader;
      };
  }

  Returns {
      background: {
          blendMode: string;
          defaultShader: typeof AdaptiveBackgroundShader;
      };
      coloration: {
          blendMode: string;
          defaultShader: typeof AdaptiveColorationShader;
      };
      illumination: {
          blendMode: string;
          defaultShader: typeof AdaptiveIlluminationShader;
      };
  }

_initialize

• _initialize(data: any): void

  Parameters

  • data: any

  Returns void

_updateBackgroundUniforms

• _updateBackgroundUniforms(): void

  Update shader uniforms used for the background layer.

  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

animateFlickering

• animateFlickering(
      dt: number,
      options?: {
          amplification?: number;
          intensity?: number;
          reverse?: boolean;
          speed?: number;
      },
  ): void

  An animation with flickering ratio and light intensity

  Parameters

  • dt: number

    Delta time
  • Optionaloptions: {
        amplification?: number;
        intensity?: number;
        reverse?: boolean;
        speed?: number;
    } = {}

    Additional options which modify the flame animation

    • Optionalamplification?: number

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

    • Optionalintensity?: number

      The animation intensity, from 1 to 10

    • Optionalreverse?: boolean

      Reverse the animation direction

    • Optionalspeed?: number

      The animation speed, from 0 to 10

  Returns void

animatePulse

• animatePulse(
      dt: number,
      options?: { intensity?: number; reverse?: boolean; speed?: number },
  ): void

  A basic "pulse" animation which expands and contracts.

  Parameters

  • dt: number

    Delta time
  • Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}

    Additional options which modify the pulse animation

    • Optionalintensity?: number

      The animation intensity, from 1 to 10

    • Optionalreverse?: boolean

      Reverse the animation direction

    • Optionalspeed?: number

      The animation speed, from 0 to 10

  Returns void

animateSoundPulse

• animateSoundPulse(
      dt: number,
      options?: { intensity?: number; reverse?: boolean; speed?: number },
  ): void

  A sound-reactive animation that uses bass/mid/treble blending to control certain shader uniforms. "speed" is interpreted as how quickly we adapt to changes in audio. No time-based pulsing is used by default, but we incorporate dt into smoothing so that behavior is consistent across varying frame rates.

  Parameters

  • dt: number

    The delta time since the last frame, in milliseconds.
  • Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}

    Additional options for customizing the audio reaction.

    • Optionalintensity?: number

      A blend factor in [0..10] that transitions from bass (near 0) to treble (near 10) Mid frequencies dominate around intensity=5.

    • Optionalreverse?: boolean

      Whether to invert the final amplitude as 1 - amplitude.

    • Optionalspeed?: number

      A smoothing factor in [0..10], effectively updates/second.

  Returns void

animateTorch

• animateTorch(
      dt: number,
      options?: { intensity?: number; reverse?: boolean; speed?: number },
  ): void

  An animation with flickering ratio and light intensity.

  Parameters

  • dt: number

    Delta time
  • Optionaloptions: { intensity?: number; reverse?: boolean; speed?: number } = {}

    Additional options which modify the flame animation

    • Optionalintensity?: number

      The animation intensity, from 1 to 10

    • Optionalreverse?: boolean

      Reverse the animation direction

    • Optionalspeed?: number

      The animation speed, from 0 to 10

  Returns void

StaticgetCorrectedColor

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

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

  Parameters

  • level: LightingLevel

    The lighting level (one of CONST.LIGHTING_LEVELS)
  • colorDim: Color
  • colorBright: Color
  • OptionalcolorBackground: Color

  Returns Color

StaticgetCorrectedLevel

• getCorrectedLevel(level: LightingLevel): number

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

  Parameters

  • level: LightingLevel

    The lighting level (one of CONST.LIGHTING_LEVELS)

  Returns number

  The corrected level.