Documentation
    Preparing search index...

    Interface RenderableOptions

    Optional construction arguments of Renderable.

    interface RenderableOptions {
        castShadow?: boolean;
        clip?: boolean;
        frustumCulled?: boolean;
        receiveShadow?: boolean;
        renderLayer?: number;
        renderOrder?: number;
        scissor?: ScissorRect | null;
    }

    Hierarchy (View Summary)

    Index
    castShadow?: boolean

    Initial Renderable.castShadow; defaults to true (§69).

    clip?: boolean

    Initial Node.clip; defaults to false (§67).

    Here rather than on a Node options record because a clip is only meaningful on a node that draws — the mask is the node's own geometry — and this is the options record every drawable funnels through. It is also what gives the §79 readers one spelling for the field beside the three §49 flags above.

    frustumCulled?: boolean

    Initial Renderable.frustumCulled; defaults to true (§87).

    receiveShadow?: boolean

    Initial Renderable.receiveShadow; defaults to true (§69).

    renderLayer?: number

    Initial Renderable.renderLayer; defaults to 0.

    renderOrder?: number

    Initial Renderable.renderOrder; defaults to 0.

    scissor?: ScissorRect | null

    Initial Renderable.scissor; defaults to null (§67).

    A per-draw axis-aligned rectangle in drawing-buffer pixels. null (the default) leaves the view scissor alone, so existing scenes stay transcript-identical. See scissor.ts.