Class BlurFilter

constructor

• new BlurFilter(): Pixi.filters.BlurFilter

• Returns Pixi.filters.BlurFilter

autoFit

true
Copy

blurXFilter

blurYFilter

disposeRunner

enabled

Readonlylegacy

multisample

PIXI.Filter.defaultMultisample
Copy

padding

program

state

uniformGroup

StaticdefaultMultisample

PIXI.MSAA_QUALITY.NONE
Copy

StaticdefaultResolution

StaticSOURCE_KEY_MAP

blendMode

• get blendMode(): BLEND_MODES

• Sets the blendmode of the filter

  Returns BLEND_MODES

  Default

  PIXI.BLEND_MODES.NORMAL
  Copy

• set blendMode(value: BLEND_MODES): void

• Sets the blend mode of the filter.

  Parameters

  • value: BLEND_MODES

  Returns void

  Default

  PIXI.BLEND_MODES.NORMAL
  Copy

blur

• get blur(): number

• Sets the strength of both the blurX and blurY properties simultaneously

  Returns number

  Default

  2
  Copy

• set blur(value: number): void

• Parameters

  • value: number

  Returns void

blurX

• get blurX(): number

• Sets the strength of the blurX property

  Returns number

  Default

  2
  Copy

• set blurX(value: number): void

• Parameters

  • value: number

  Returns void

blurY

• get blurY(): number

• Sets the strength of the blurY property

  Returns number

  Default

  2
  Copy

• set blurY(value: number): void

• Parameters

  • value: number

  Returns void

quality

• get quality(): number

• Sets the number of passes for blur. More passes means higher quality bluring.

  Returns number

  Default

  1
  Copy

• set quality(value: number): void

• Parameters

  • value: number

  Returns void

repeatEdgePixels

• get repeatEdgePixels(): boolean

• If set to true the edge of the target will be clamped

  Returns boolean

  Default

  false
  Copy

• set repeatEdgePixels(value: boolean): void

• Parameters

  • value: boolean

  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: null | number): void

• Parameters

  • value: null | number

  Returns void

uniforms

• get uniforms(): Dict<any>

• Shader uniform values, shortcut for uniformGroup.uniforms.

  Returns Dict<any>

StaticdefaultFragmentSrc

• get defaultFragmentSrc(): string

• The default fragment shader source

  Returns string

StaticdefaultVertexSrc

• get defaultVertexSrc(): string

• The default vertex shader source

  Returns string

apply

• apply(
      filterManager: FilterSystem,
      input: RenderTexture,
      output: RenderTexture,
      clearMode: CLEAR_MODES,
  ): void

• Applies the filter.

  Parameters

  • filterManager: FilterSystem

    The manager.
  • input: RenderTexture

    The input target.
  • output: RenderTexture

    The output target.
  • clearMode: CLEAR_MODES

    How to clear

  Returns void

checkUniformExists

• checkUniformExists(name: string, group: UniformGroup<Dict<any>>): boolean

• Parameters

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

  Returns boolean

destroy

• destroy(): void

• Returns void

Staticfrom

• from(vertexSrc?: string, fragmentSrc?: string, uniforms?: Dict<any>): Shader

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

  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 Shader

  A shiny new PixiJS shader!