The default coloration shader used for vision sources.

Hierarchy (view full)

Properties

initialUniforms: any

The initial values of the shader uniforms.

EXPOSURE: string = ""
CONTRAST: string = ""
SHADER_HEADER: string = ...

Memory allocations for the Adaptive Coloration Shader

fragmentShader: string = ...

The raw fragment shader used by this class. A subclass of AbstractBaseShader must implement the fragmentShader static field.

defaultUniforms: {
    technique: number;
    saturation: number;
    attenuation: number;
    colorEffect: number[];
    colorBackground: number[];
    colorTint: number[];
    time: number;
    screenDimensions: number[];
    useSampler: boolean;
    primaryTexture: any;
    linkedToDarknessLevel: boolean;
    depthTexture: any;
    depthElevation: number;
    ambientBrightest: number[];
    ambientDarkness: number[];
    ambientDaylight: number[];
    weights: number[];
    dimLevelCorrection: number;
    brightLevelCorrection: number;
    globalLight: boolean;
    globalLightThresholds: number[];
} = ...

The default uniform values for the shader. A subclass of AbstractBaseShader must implement the defaultUniforms static field.

Type declaration

  • technique: number
  • saturation: number
  • attenuation: number
  • colorEffect: number[]
  • colorBackground: number[]
  • colorTint: number[]
  • time: number
  • screenDimensions: number[]
  • useSampler: boolean
  • primaryTexture: any
  • linkedToDarknessLevel: boolean
  • depthTexture: any
  • depthElevation: number
  • ambientBrightest: number[]
  • ambientDarkness: number[]
  • ambientDaylight: number[]
  • weights: number[]
  • dimLevelCorrection: number
  • brightLevelCorrection: number
  • globalLight: boolean
  • globalLightThresholds: number[]
FRAGMENT_FUNCTIONS: string = ...

Common functions used by the fragment shaders.

Abstract

COMPUTE_ILLUMINATION: string = ...

Compute illumination uniforms

FRAGMENT_BEGIN: string = ...
SHADOW: string = ""
SHADER_TECHNIQUES: Record<string, ShaderTechnique> = ...

A mapping of available shader techniques

forceDefaultColor: boolean = false

Has this lighting shader a forced default color?

VERTEX_ATTRIBUTES: string = ...

Common attributes for vertex shaders.

VERTEX_UNIFORMS: string = ...

Common uniforms for vertex shaders.

VERTEX_FRAGMENT_VARYINGS: string = ...

Common varyings shared by vertex and fragment shaders.

VERTEX_FUNCTIONS: string = ""

Common functions used by the vertex shaders.

Abstract

FRAGMENT_UNIFORMS: string = ...

Common uniforms shared by fragment shaders.

CONSTANTS: string = ...

Inherit Doc

vertexShader: string = ...

The raw vertex shader used by this class. A subclass of AbstractBaseShader must implement the vertexShader static field.

SATURATION: string = ...

Saturation adjustment

SWITCH_COLOR: string = ...

Switch between an inner and outer color, by comparing distance from center to ratio Apply a strong gradient between the two areas if attenuation uniform is set to true

TRANSITION: string = ...

Transition between bright and dim colors, if requested

FALLOFF: string = ...

Incorporate falloff if a attenuation uniform is requested

FRAGMENT_END: string = ...

Shader final

Accessors

  • get isRequired(): boolean
  • Flag whether the coloration shader is currently required. If key uniforms are at their default values, we don't need to render the coloration container.

    Returns boolean

  • get COLORATION_TECHNIQUES(): string
  • The coloration technique coloration shader fragment

    Returns string

  • get ILLUMINATION_TECHNIQUES(): string
  • The coloration technique illumination shader fragment

    Returns string

  • get BACKGROUND_TECHNIQUES(): string
  • The coloration technique background shader fragment

    Returns string

  • get ADJUSTMENTS(): string
  • The adjustments made into fragment shaders

    Returns string

Methods

  • Protected Internal

    Perform operations which are required before binding the Shader to the Renderer.

    Parameters

    • mesh: DisplayObject

      The mesh display object linked to this shader.

    • renderer: Renderer

      The renderer

    Returns void

  • Construct adaptive shader according to shader type

    Parameters

    • shaderType: string

      shader type to construct : coloration, illumination, background, etc.

    Returns string

    the constructed shader adaptive block