Hilo3d API - v2.0.0-alpha.8
    Preparing search index...

    Interface StageCommonParameters

    interface StageCommonParameters {
        alpha?: boolean;
        anim?: Animation | null;
        animationId?: string;
        antialias?: boolean;
        autoUpdateChildWorldMatrix?: boolean;
        autoUpdateWorldMatrix?: boolean;
        camera?: Camera | null;
        cameras?: readonly Camera[];
        canvas?: HTMLCanvasElement;
        clearColor?: Color;
        container?: HTMLElement;
        depth?: boolean;
        failIfMajorPerformanceCaveat?: boolean;
        fog?: Fog | null;
        gameMode?: boolean;
        height?: number;
        jointName?: string;
        layer?: number;
        name?: string;
        needCallChildUpdate?: boolean;
        onlySyncQuaternion?: boolean;
        onUpdate?: ((deltaTime: number) => void) | null;
        parent?: Node | null;
        pivotX?: number;
        pivotY?: number;
        pivotZ?: number;
        pixelRatio?: number;
        pointerChildren?: boolean;
        pointerEnabled?: boolean;
        premultipliedAlpha?: boolean;
        renderingProfile?: RendererRenderingProfile;
        renderPipeline?: RenderPipelineFactory;
        rotationX?: number;
        rotationY?: number;
        rotationZ?: number;
        scaleX?: number;
        scaleY?: number;
        scaleZ?: number;
        shadowUpdateMode?: RendererShadowUpdateMode;
        sortingLayer?: number;
        stencil?: boolean;
        systems?: readonly StageSystem[];
        up?: Vector3;
        useHandCursor?: boolean;
        useInstanced?: boolean;
        useLogDepth?: boolean;
        userData?: unknown;
        visible?: boolean;
        width?: number;
        x?: number;
        y?: number;
        z?: number;
        zIndex?: number;
    }

    Hierarchy (View Summary)

    Index
    alpha? anim? animationId? antialias? autoUpdateChildWorldMatrix? autoUpdateWorldMatrix? camera? cameras? canvas? clearColor? container? depth? failIfMajorPerformanceCaveat? fog? gameMode? height? jointName? layer? name? needCallChildUpdate? onlySyncQuaternion? onUpdate? parent? pivotX? pivotY? pivotZ? pixelRatio? pointerChildren? pointerEnabled? premultipliedAlpha? renderingProfile? renderPipeline? rotationX? rotationY? rotationZ? scaleX? scaleY? scaleZ? shadowUpdateMode? sortingLayer? stencil? systems? up? useHandCursor? useInstanced? useLogDepth? userData? visible? width? x? y? z? zIndex?
    alpha?: boolean
    anim?: Animation | null
    animationId?: string
    antialias?: boolean
    autoUpdateChildWorldMatrix?: boolean
    autoUpdateWorldMatrix?: boolean
    camera?: Camera | null
    cameras?: readonly Camera[]

    Ordered cameras rendered into one Render Graph/RHI submission. Later cameras overlay earlier cameras and preserve their color unless camera.clearColor is enabled.

    canvas?: HTMLCanvasElement
    clearColor?: Color
    container?: HTMLElement
    depth?: boolean
    failIfMajorPerformanceCaveat?: boolean
    fog?: Fog | null
    gameMode?: boolean
    height?: number
    jointName?: string
    layer?: number

    Scene-layer bit mask. A node is renderable when at least one bit overlaps the active camera's visibility mask.

    name?: string
    needCallChildUpdate?: boolean
    onlySyncQuaternion?: boolean
    onUpdate?: ((deltaTime: number) => void) | null
    parent?: Node | null
    pivotX?: number
    pivotY?: number
    pivotZ?: number
    pixelRatio?: number
    pointerChildren?: boolean
    pointerEnabled?: boolean
    premultipliedAlpha?: boolean
    renderingProfile?: RendererRenderingProfile

    Renderer policy bundle. high-end enables reversed-Z and camera-relative transforms.

    renderPipeline?: RenderPipelineFactory

    Renderer-local scriptable pipeline factory snapshotted during Stage.create().

    rotationX?: number
    rotationY?: number
    rotationZ?: number
    scaleX?: number
    scaleY?: number
    scaleZ?: number
    shadowUpdateMode?: RendererShadowUpdateMode

    Shadow-atlas update policy. Use full for scenes whose shadow casters move every frame.

    sortingLayer?: number

    Coarse 2D display layer. Higher values render later.

    This is independent from layer, which is a camera-visibility bit mask.

    stencil?: boolean
    systems?: readonly StageSystem[]

    Optional Stage Systems initialized transactionally before Stage.create() resolves.

    up?: Vector3
    useHandCursor?: boolean
    useInstanced?: boolean
    useLogDepth?: boolean
    userData?: unknown
    visible?: boolean
    width?: number
    x?: number
    y?: number
    z?: number
    zIndex?: number

    Fine 2D display order within sortingLayer. Higher values render later.

    Settings
    Member Visibility

    On This Page
    Properties