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

    Class AlphaFilter

    Simplest filter - applies alpha.

    Use this instead of Container's alpha property to avoid visual layering of individual elements. AlphaFilter applies alpha evenly across the entire display object and any opaque elements it contains. If elements are not opaque, they will blend with each other anyway.

    Very handy if you want to use common features of all filters:

    1. Assign a blendMode to this filter, blend all elements inside display object with background.

    2. To use clipping in display coordinates, assign a filterArea to the same container that has this filter.

    PIXI

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

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

    Accessors

    alpha blendMode resolution uniforms defaultFragmentSrc defaultVertexSrc

    Methods

    apply checkUniformExists destroy from

    Constructors

    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
    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 alpha(): number

      Coefficient for alpha multiplication

      Returns number

      1
    • set alpha(value: number): void

      Parameters

      • value: number

      Returns void

    • get blendMode(): BLEND_MODES

      Sets the blend mode of the filter.

      Returns BLEND_MODES

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

      Parameters

      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

    • 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

    • 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