pixi.js
    Preparing search index...

    Interface ClearOptionsAdvanced

    The options for clearing the render target.

    interface ClearOptions {
        clear?: CLEAR_OR_BOOL;
        clearColor?: ColorSource;
        layer?: number;
        mipLevel?: number;
        target?: RenderSurface;
    }

    Hierarchy (View Summary)

    Index

    The clear mode to use.

    clearColor?: ColorSource

    The color to clear with.

    layer?: number

    Layer to render/clear to when the target has layers: an array layer of a 2D array (arrayLayerCount > 1), a face of a cube map, or a depth slice of a 3D texture (depth).

    This maps to WebGPU's GPUTextureViewDescriptor.baseArrayLayer for arrays and cube faces, and to GPURenderPassColorAttachment.depthSlice for 3D textures.

    0
    @advanced
    mipLevel?: number

    Mip level to render/clear to when the target is a texture-backed render surface.

    0

    Note: When rendering to a Texture target, Pixi renders into the underlying TextureSource (via an internal RenderTarget). The texture's frame is interpreted in mip 0 space and is scaled/clamped to the requested mip level.

    target?: RenderSurface

    The render target to render. if this target is a canvas and you are using the WebGL renderer, please ensure you have set multiView to true on renderer.