Class TextureTransitionFilter

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

StaticdefaultUniforms

StaticfragmentShader

StaticvertexShader

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
  Copy

StaticTYPES

• 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";
      },
  >

apply

• apply(filterManager: any, input: any, output: any, clear: any): void

  Parameters

  • filterManager: any
  • input: any
  • output: any
  • clear: any

  Returns void

  Inherit Doc

Staticanimate

• 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