Class TextureTransitionFilter

A filter specialized for transition effects between a source object and a target texture.

Hierarchy (View Summary)

AbstractBaseFilter
- TextureTransitionFilter

Index

Constructors

constructor

new TextureTransitionFilter(
    vertexSrc?: string,
    fragmentSrc?: string,
    uniforms?: Dict<any>,
): TextureTransitionFilter
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 TextureTransitionFilter
Inherited from AbstractBaseFilter.constructor

Accessors

targetTexture

set targetTexture(targetTexture: Texture<Resource>): void
Sampler target for this filter.
Parameters
- targetTexture: Texture<Resource>
Returns void

type

get type(): string
The transition type (see TextureTransitionFilter.TYPES).

Returns string
Default Value
```
TextureTransitionFilter.TYPES.FADE
```

`Static`defaultUniforms

get defaultUniforms(): {
    anchor: { x: number; y: number };
    backgroundColor: number[];
    filterMatrix: Matrix;
    filterMatrixInverse: Matrix;
    opaque: number;
    progress: number;
    rotation: number;
    targetTexture: null;
    targetUVMatrix: Matrix;
    tintAlpha: number[];
    type: number;
}
Returns {
    anchor: { x: number; y: number };
    backgroundColor: number[];
    filterMatrix: Matrix;
    filterMatrixInverse: Matrix;
    opaque: number;
    progress: number;
    rotation: number;
    targetTexture: null;
    targetUVMatrix: Matrix;
    tintAlpha: number[];
    type: number;
}

`Static`TYPES

get TYPES(): Readonly<
    {
        CROSSHATCH: "crosshatch";
        DOTS: "dots";
        FADE: "fade";
        GLITCH: "glitch";
        HOLE: "hole";
        HOLE_SWIRL: "holeSwirl";
        HOLOGRAM: "hologram";
        MORPH: "morph";
        SWIRL: "swirl";
        WATER_DROP: "waterDrop";
        WAVES: "waves";
        WHITE_NOISE: "whiteNoise";
        WIND: "wind";
    },
>
Transition types for this shader.

Returns Readonly<
    {
        CROSSHATCH: "crosshatch";
        DOTS: "dots";
        FADE: "fade";
        GLITCH: "glitch";
        HOLE: "hole";
        HOLE_SWIRL: "holeSwirl";
        HOLOGRAM: "hologram";
        MORPH: "morph";
        SWIRL: "swirl";
        WATER_DROP: "waterDrop";
        WAVES: "waves";
        WHITE_NOISE: "whiteNoise";
        WIND: "wind";
    },
>

Methods

apply

apply(filterManager: any, input: any, output: any, clear: any): void
Parameters
- filterManager: any
- input: any
- output: any
- clear: any
Returns void
Inherit Doc
Overrides AbstractBaseFilter.apply

`Static`_createFragmentShader

_createFragmentShader(): string
Returns string

`Static`_createVertexShader

_createVertexShader(): string
Returns string

`Static`animate

animate(
    subject: SpriteMesh | Sprite,
    texture: Texture<Resource>,
    options?: {
        duration?: number;
        easing?: string | Function;
        name?: string | symbol;
        type?: string;
    },
): Promise<boolean>
Animate a transition from a subject SpriteMesh/PIXI.Sprite to a given texture.
Parameters
- subject: SpriteMesh | Sprite
  The source mesh/sprite to apply a transition.
- texture: Texture<Resource>
  The target texture.
- Optionaloptions: {
      duration?: number;
      easing?: string | Function;
      name?: string | symbol;
      type?: string;
  } = {}
  - Optionalduration?: number
    The animation duration
  - Optionaleasing?: string | Function
    The easing function of the animation
  - Optionalname?: string | symbol
    The name of the foundry.canvas.animation.CanvasAnimation.
  - Optionaltype?: string
    The transition type (default to FADE.)
Returns Promise<boolean>
A Promise which resolves to true once the animation has concluded or false if the animation was prematurely terminated

`Static`create

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

Class TextureTransitionFilter

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TextureTransitionFilter

Accessors

targetTexture

Parameters

Returns void

type

Returns string

Default Value

StaticdefaultUniforms

Returns { anchor: { x: number; y: number }; backgroundColor: number[]; filterMatrix: Matrix; filterMatrixInverse: Matrix; opaque: number; progress: number; rotation: number; targetTexture: null; targetUVMatrix: Matrix; tintAlpha: number[]; type: number;}

StaticTYPES

Returns Readonly< { CROSSHATCH: "crosshatch"; DOTS: "dots"; FADE: "fade"; GLITCH: "glitch"; HOLE: "hole"; HOLE_SWIRL: "holeSwirl"; HOLOGRAM: "hologram"; MORPH: "morph"; SWIRL: "swirl"; WATER_DROP: "waterDrop"; WAVES: "waves"; WHITE_NOISE: "whiteNoise"; WIND: "wind"; },>

Methods

apply

Parameters

Returns void

Inherit Doc

Static_createFragmentShader

Returns string

Static_createVertexShader

Returns string

Staticanimate

Parameters

Optionalduration?: number

Optionaleasing?: string | Function

Optionalname?: string | symbol

Optionaltype?: string

Returns Promise<boolean>

Staticcreate

Parameters

Returns AbstractBaseFilter

Settings

On This Page

`Static`defaultUniforms

Returns {
anchor: { x: number; y: number };
backgroundColor: number[];
filterMatrix: Matrix;
filterMatrixInverse: Matrix;
opaque: number;
progress: number;
rotation: number;
targetTexture: null;
targetUVMatrix: Matrix;
tintAlpha: number[];
type: number;
}

`Static`TYPES

Returns Readonly<
{
CROSSHATCH: "crosshatch";
DOTS: "dots";
FADE: "fade";
GLITCH: "glitch";
HOLE: "hole";
HOLE_SWIRL: "holeSwirl";
HOLOGRAM: "hologram";
MORPH: "morph";
SWIRL: "swirl";
WATER_DROP: "waterDrop";
WAVES: "waves";
WHITE_NOISE: "whiteNoise";
WIND: "wind";
},
>

`Static`_createFragmentShader

`Static`_createVertexShader

`Static`animate

`Optional`duration?: number

`Optional`easing?: string | Function

`Optional`name?: string | symbol

`Optional`type?: string

`Static`create