Class NoiseFilter

constructor

• new NoiseFilter(noise?: number, seed?: number): Pixi.filters.NoiseFilter

  Parameters

  • Optionalnoise: number

    The noise intensity, should be a normalized value in the range [0, 1].

  • Optionalseed: number

    A random seed for the noise generation. Default is Math.random().

  Returns Pixi.filters.NoiseFilter

autoFit

true
Copy

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 blend mode of the filter.

  Returns BLEND_MODES

  Default

  PIXI.BLEND_MODES.NORMAL
  Copy

• set blendMode(value: BLEND_MODES): void

  Parameters

  • value: BLEND_MODES

  Returns void

noise

• get noise(): number

  The amount of noise to apply, this value should be in the range (0, 1].

  Returns number

  Default

  0.5
  Copy

• set noise(value: number): void

  Parameters

  • value: number

  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

seed

• get seed(): number

  A seed value to apply to the random noise generation. Math.random() is a good value to use.

  Returns number

• set seed(value: number): void

  Parameters

  • value: 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,
      _currentState?: FilterState,
  ): void

  Applies the filter

  Parameters

  • filterManager: FilterSystem

    The renderer to retrieve the filter from

  • input: RenderTexture

    The input render target.

  • output: RenderTexture

    The target to output to.

  • OptionalclearMode: CLEAR_MODES

    Should the output be cleared before rendering to it.

  • Optional_currentState: FilterState

    It's current state of filter. There are some useful properties in the currentState : target, filters, sourceFrame, destinationFrame, renderTarget, resolution

  Returns void

checkUniformExists

• checkUniformExists(name: string, group: UniformGroup): boolean

  Parameters

  • name: string
  • group: UniformGroup

  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!