pixi.js
    Preparing search index...

    Interface NoiseFilterOptions

    Configuration options for the NoiseFilter.

    The NoiseFilter adds random noise to the rendered content. The noise effect can be controlled through the noise intensity and an optional seed value for reproducible results.

    // Basic noise effect
    const options: NoiseFilterOptions = {
        noise: 0.5,
        seed: Math.random()
    };

    // Create filter with options
    const noiseFilter = new NoiseFilter(options);
    interface NoiseFilterOptions {
        antialias?: boolean | FilterAntialias;
        blendMode?: BLEND_MODES;
        blendRequired?: boolean;
        clipToViewport?: boolean;
        noise?: number;
        padding?: number;
        resolution?: number | "inherit";
        seed?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    antialias? blendMode? blendRequired? clipToViewport? noise? padding? resolution? seed?

    Properties

    antialias?: boolean | FilterAntialias

    If true the filter will make use of antialiasing. Although it looks better this can have a performance impact. If set to 'inherit', the filter will detect the antialiasing of the render target and change this automatically. Definitely don't set this to true if the render target has antialiasing set to false. As it will antialias, but you won't see the difference. (default 'off')

    This can be a boolean or [FilterAntialias]FilterAntialias string.

    blendMode?: BLEND_MODES

    optional blend mode used by the filter when rendering (defaults to 'normal')

    blendRequired?: boolean

    If this is set to true, the filter system will grab a snap shot of the area being rendered to and pass this into the shader. This is useful for blend modes that need to be aware of the pixels they are rendering to. Only use if you need that data, otherwise its an extra gpu copy you don't need! (default false)

    clipToViewport?: boolean

    If this is set to true, the filter system will clip filter texture into viewport This is useful for filters that applied to whole texture. (default true)

    noise?: number

    The amount of noise to apply. Should be in range (0, 1]:

    • 0.1 = subtle noise
    • 0.5 = moderate noise (default)
    • 1.0 = maximum noise
    0.5

    // Moderate noise effect
    const noiseFilter = new NoiseFilter({ noise: 0.5 });
    padding?: number

    the amount of pixels to pad the container with when applying the filter. For example a blur extends the container out as it blurs, so padding is applied to ensure that extra detail is rendered as well without clipping occurring. (default 0)

    resolution?: number | "inherit"

    the resolution the filter should be rendered at. The lower the resolution, the more performant the filter will be, but the lower the quality of the output. (default 1) If 'inherit', the resolution of the render target is used. Consider lowering this for things like blurs filters

    seed?: number

    A seed value to apply to the random noise generation. Using the same seed will generate the same noise pattern.

    Math.random()

    // Using a fixed seed for reproducible noise
    const noiseFilter = new NoiseFilter({ seed: 12345 });

    Settings

    Member Visibility

    On This Page

    Properties