@rendley/sdk - v1.12.7
    Preparing search index...

    Class BlurFilter

    The BlurFilter applies a Gaussian blur to an object.

    The strength of the blur can be set for the x-axis and y-axis separately.

    PIXI

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    autoFit blurXFilter blurYFilter disposeRunner enabled legacy multisample noTransform padding program state uniformGroup defaultMultisample defaultResolution SOURCE_KEY_MAP

    Accessors

    blendMode blur blurX blurY quality repeatEdgePixels resolution uniforms defaultFragmentSrc defaultVertexSrc

    Methods

    apply checkUniformExists destroy from

    Constructors

    • Parameters

      • Optionalstrength: number

        The strength of the blur filter.

      • Optionalquality: number

        The quality of the blur filter.

      • Optionalresolution: number

        The resolution of the blur filter.

      • OptionalkernelSize: number

        The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.

      Returns Pixi.BlurFilter

    Properties

    autoFit: boolean

    If enabled, PixiJS will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.

    true
    blurXFilter: Pixi.BlurFilterPass
    blurYFilter: Pixi.BlurFilterPass
    disposeRunner: Runner
    enabled: boolean

    If enabled is true the filter is applied, if false it will not.

    legacy: boolean

    Legacy filters use position and uvs from attributes (set by filter system)

    multisample: null | MSAA_QUALITY

    The samples override of the filter instance. If set to null, the sample count of the current render target is used.

    PIXI.Filter.defaultMultisample
    noTransform: boolean

    If true, the filter will not apply transform to the input texture. This is useful for filters that do not require transform, such as blur or color matrix filters.

    false
    padding: number

    The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.

    program: Program

    Program that the shader uses.

    state: State

    The WebGL state the filter requires to render.

    uniformGroup: UniformGroup
    defaultMultisample: null | MSAA_QUALITY

    Default filter samples for any filter.

    PIXI.MSAA_QUALITY.NONE
    defaultResolution: null | number

    Default filter resolution for any filter.

    SOURCE_KEY_MAP: Dict<string>

    Used for caching shader IDs.

    Accessors

    • get blendMode(): BLEND_MODES

      Sets the blendmode of the filter

      Returns BLEND_MODES

      PIXI.BLEND_MODES.NORMAL
    • set blendMode(value: BLEND_MODES): void

      Sets the blend mode of the filter.

      Parameters

      Returns void

      PIXI.BLEND_MODES.NORMAL
    • get blur(): number

      Sets the strength of both the blurX and blurY properties simultaneously

      Returns number

      2
    • set blur(value: number): void

      Parameters

      • value: number

      Returns void

    • get blurX(): number

      Sets the strength of the blurX property

      Returns number

      2
    • set blurX(value: number): void

      Parameters

      • value: number

      Returns void

    • get blurY(): number

      Sets the strength of the blurY property

      Returns number

      2
    • set blurY(value: number): void

      Parameters

      • value: number

      Returns void

    • get quality(): number

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

      Returns number

      1
    • set quality(value: number): void

      Parameters

      • value: number

      Returns void

    • get repeatEdgePixels(): boolean

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

      Returns boolean

      false
    • set repeatEdgePixels(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

      PIXI.Filter.defaultResolution
    • set resolution(value: null | number): void

      Parameters

      • value: null | number

      Returns void

    • get uniforms(): Dict<any>

      Shader uniform values, shortcut for uniformGroup.uniforms.

      Returns Dict<any>

    • get defaultFragmentSrc(): string

      The default fragment shader source

      Returns string

    • get defaultVertexSrc(): string

      The default vertex shader source

      Returns string

    Methods

    • 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!

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods