Class PrimaryCanvasGroupAmbienceFilter

A filter used to apply color adjustments and other modifications to the environment.

Hierarchy (View Summary)

AbstractBaseMaskFilter
- PrimaryCanvasGroupAmbienceFilter

Index

Constructors

constructor

new PrimaryCanvasGroupAmbienceFilter(
    vertexSrc?: string,
    fragmentSrc?: string,
    uniforms?: Dict<any>,
): PrimaryCanvasGroupAmbienceFilter
Parameters
- OptionalvertexSrc: string
  The source of the vertex shader.
- OptionalfragmentSrc: string
  The source of the fragment shader.
- Optionaluniforms: Dict<any>
  Custom uniforms to use to augment the built-in ones.
Returns PrimaryCanvasGroupAmbienceFilter
Inherited from AbstractBaseMaskFilter.constructor

Accessors

`Static`defaultUniforms

get defaultUniforms(): {
    baseIntensity: number;
    baseLuminosity: number;
    baseSaturation: number;
    baseShadows: number;
    baseTint: number[];
    cycle: boolean;
    darkIntensity: number;
    darkLuminosity: number;
    darknessLevelTexture: null;
    darkSaturation: number;
    darkShadows: number;
    darkTint: number[];
    uSampler: null;
}
Returns {
    baseIntensity: number;
    baseLuminosity: number;
    baseSaturation: number;
    baseShadows: number;
    baseTint: number[];
    cycle: boolean;
    darkIntensity: number;
    darkLuminosity: number;
    darknessLevelTexture: null;
    darkSaturation: number;
    darkShadows: number;
    darkTint: number[];
    uSampler: null;
}

Methods

apply

apply(
    filterManager: any,
    input: any,
    output: any,
    clear: any,
    currentState: any,
): void
Parameters
- filterManager: any
- input: any
- output: any
- clear: any
- currentState: any
Returns void
Inherited from AbstractBaseMaskFilter.apply

`Static`_createFragmentShader

_createFragmentShader(): string
Returns string

`Static`_createVertexShader

_createVertexShader(): string
Returns string
Inherited from AbstractBaseMaskFilter._createVertexShader

`Static`create

create(uniforms: any, options: any): AbstractBaseFilter
Parameters
- uniforms: any
- options: any
Returns AbstractBaseFilter
Inherited from AbstractBaseMaskFilter.create

Class PrimaryCanvasGroupAmbienceFilter

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PrimaryCanvasGroupAmbienceFilter

Accessors

`Static`defaultUniforms

Methods

apply

Parameters

Returns void

`Static`_createFragmentShader

Returns string

`Static`_createVertexShader

Returns string

`Static`create

Parameters

Returns AbstractBaseFilter

Settings

On This Page

Class PrimaryCanvasGroupAmbienceFilter

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PrimaryCanvasGroupAmbienceFilter

Accessors

StaticdefaultUniforms

Returns { baseIntensity: number; baseLuminosity: number; baseSaturation: number; baseShadows: number; baseTint: number[]; cycle: boolean; darkIntensity: number; darkLuminosity: number; darknessLevelTexture: null; darkSaturation: number; darkShadows: number; darkTint: number[]; uSampler: null;}

Methods

apply

Parameters

Returns void

Static_createFragmentShader

Returns string

Static_createVertexShader

Returns string

Staticcreate

Parameters

Returns AbstractBaseFilter

Settings

On This Page

`Static`defaultUniforms

Returns {
baseIntensity: number;
baseLuminosity: number;
baseSaturation: number;
baseShadows: number;
baseTint: number[];
cycle: boolean;
darkIntensity: number;
darkLuminosity: number;
darknessLevelTexture: null;
darkSaturation: number;
darkShadows: number;
darkTint: number[];
uSampler: null;
}

`Static`_createFragmentShader

`Static`_createVertexShader

`Static`create