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

    Interface MaskFilterOptions

    Options used to construct a MaskFilter.

    interface MaskFilterOptions {
        alphaOnly?: boolean;
        clipId: string;
        id?: string;
        inverted?: boolean;
        maskSprite: Sprite;
        wrapMode?: MaskWrapModeEnum;
    }
    Index

    Properties

    alphaOnly? clipId id? inverted? maskSprite wrapMode?

    Properties

    alphaOnly?: boolean

    Samples only the texture alpha. Colored sources such as text need this because their RGB channels describe the fill color rather than the mask strength.

    clipId: string
    id?: string
    inverted?: boolean

    Inverts the mask (alpha becomes 1 - alpha): the target shows where the mask is empty and is cut out where the mask is opaque.

    maskSprite: Sprite
    wrapMode?: MaskWrapModeEnum

    Settings

    Member Visibility

    On This Page

    Properties