Class DisplacementFilter

constructor

• new DisplacementFilter(): Pixi.filters.DisplacementFilter

• Returns Pixi.filters.DisplacementFilter

autoFit

true
Copy

disposeRunner

enabled

Readonly legacy

maskMatrix

maskSprite

multisample

PIXI.Filter.defaultMultisample
Copy

padding

program

scale

state

uniformGroup

Static SOURCE_KEY_MAP

Static defaultMultisample

PIXI.MSAA_QUALITY.NONE
Copy

Static defaultResolution

blendMode

• get blendMode(): BLEND_MODES

• Sets the blend mode of the filter.

  Returns BLEND_MODES

  Default

  PIXI.BLEND_MODES.NORMAL
  Copy

• set blendMode(value): void

• Parameters

  • value: BLEND_MODES

  Returns void

map

• get map(): Texture<Resource>

• The texture used for the displacement map. Must be power of 2 sized texture.

  Returns Texture<Resource>
• set map(value): void

• Parameters

  • value: Texture<Resource>

  Returns void

resolution

• get resolution(): null | number

• The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter. If set to null or 0, the resolution of the current render target is used.

  Returns null | number

  Default

  PIXI.Filter.defaultResolution
  Copy

• set resolution(value): void

• Parameters

  • value: null | number

  Returns void

uniforms

• get uniforms(): Dict<any>

• Shader uniform values, shortcut for uniformGroup.uniforms.

  Returns Dict<any>

Static defaultFragmentSrc

• get defaultFragmentSrc(): string

• The default fragment shader source

  Returns string

Static defaultVertexSrc

• get defaultVertexSrc(): string

• The default vertex shader source

  Returns string

apply

• apply(filterManager, input, output, clearMode): void

• Applies the filter.

  Parameters

  • filterManager: FilterSystem

    The manager.
  • input: RenderTexture

    The input target.
  • output: RenderTexture

    The output target.
  • clearMode: CLEAR_MODES

    clearMode.

  Returns void

checkUniformExists

• checkUniformExists(name, group): boolean

• Parameters

  • name: string
  • group: UniformGroup<Dict<any>>

  Returns boolean

destroy

• destroy(): void

• Returns void

Static from

• from(vertexSrc?, fragmentSrc?, uniforms?): Shader

• A short hand function to create a shader based of a vertex and fragment shader.

  Parameters

  • Optional vertexSrc: string

    The source of the vertex shader.
  • Optional fragmentSrc: string

    The source of the fragment shader.
  • Optional uniforms: Dict<any>

    Custom uniforms to use to augment the built-in ones.

  Returns Shader

  A shiny new PixiJS shader!