pixi.js
    Preparing search index...

    Interface BindOptionsAdvanced

    Options for binding a render surface via RenderTargetSystem.bind: the persistent BindState plus the per-call clear actions.

    interface BindOptions {
        clear?: CLEAR_OR_BOOL;
        clearColor?: RgbaArray;
        flipY?: boolean;
        frame?: Rectangle;
        layer?: number;
        mipLevel?: number;
        target: RenderSurface;
    }

    Hierarchy (View Summary)

    Index

    Properties

    clear? clearColor? flipY? frame? layer? mipLevel? target

    Properties

    clear?: CLEAR_OR_BOOL

    the clear mode to use. Can be true or a CLEAR number 'COLOR | DEPTH | STENCIL' 0b111

    true
    clearColor?: RgbaArray

    the color to clear to

    flipY?: boolean

    opt-in Y-orientation toggle. false/omitted is a no-op (the historical !isRoot behavior); true inverts the orientation, and the winding with it.

    frame?: Rectangle

    the frame to render to, in base mip (mip 0) pixel space. When omitted, a Texture target falls back to its own frame and any other target binds in full.

    layer?: number

    the array layer (or slice/face) of the render surface to render to (subresource)

    0
    mipLevel?: number

    the mip level to render to (subresource)

    0
    target: RenderSurface

    the render surface to bind: a texture, canvas, or render target

    Settings

    Member Visibility

    On This Page

    Properties