小程序
  • 框架
    • XR-Frame/API/Classes/RenderSystem

    Class: RenderSystem

    查看 llm.txt

    最后一次编辑于 2026-10-22

    渲染系统，负责整个场景渲染的管理。

    Hierarchy

    Table of contents

    Constructors

    Events

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new RenderSystem()

    Inherited from

    Component.constructor

    Events

    onAdd

    ▸ onAdd(parent, data): void

    所挂载的element被挂载到场景时触发的回调。

    Parameters

    Name Type
    parent Element
    data IRenderSystemData

    Returns

    void

    Inherited from

    Component.onAdd

    onRelease

    ▸ onRelease(data): void

    从被挂载的element上被移除，或是element被销毁时，触发的回调。 一般用于释放持有的资源。

    Parameters

    Name Type
    data IRenderSystemData

    Returns

    void

    Inherited from

    Component.onRelease

    onRemove

    ▸ onRemove(parent, data): void

    所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。 一般用于消除功能的运作。 如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。

    Parameters

    Name Type
    parent Element
    data IRenderSystemData

    Returns

    void

    Inherited from

    Component.onRemove

    onTick

    ▸ onTick(): void

    渲染每帧触发的回调。

    Returns

    void

    Inherited from

    Component.onTick

    onUpdate

    ▸ onUpdate(data, preData): void

    数据更新时触发的回调。

    Parameters

    Name Type
    data IRenderSystemData
    preData IRenderSystemData

    Returns

    void

    Inherited from

    Component.onUpdate

    Properties

    priority

    • Readonly priority: number = 400

    自定义组件的更新优先级。

    Overrides

    Component.priority

    schema

    • Readonly schema: IComponentSchema

    详见RenderSystemSchema。

    Overrides

    Component.schema

    EVENTS

    ▪ Static EVENTS: string[] = []

    Inherited from

    Component.EVENTS

    Accessors

    el

    • get el(): Element

    挂载的元素。

    Returns

    Element

    renderGraph

    • get renderGraph(): default<any>

    当前正在使用的RenderGraph。

    Returns

    default<any>

    scene

    • get scene(): Scene

    当前场景。

    Returns

    Scene

    shadowColor

    • get shadowColor(): number[]

    Returns

    number[]

    version

    • get version(): number

    当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

    Returns

    number

    Methods

    changeFeatures

    ▸ changeFeatures(features): void

    修改全局渲染特性。

    Parameters

    Name Type
    features Object

    Returns

    void

    changeMacros

    ▸ changeMacros(macros): void

    修改全局宏信息。

    Parameters

    Name Type
    macros Object

    Returns

    void

    disableInstance

    ▸ disableInstance(): void

    关闭全局GPU实例化。

    Returns

    void

    enableInstance

    ▸ enableInstance(): void

    开启全局GPU实例化。

    Returns

    void

    getData

    ▸ getData<T>(key): IRenderSystemData[T]

    获取一个当前值。

    Type parameters

    Name Type
    T extends keyof IRenderSystemData

    Parameters

    Name Type
    key T

    Returns

    IRenderSystemData[T]

    Inherited from

    Component.getData

    getFeature

    ▸ getFeature(key): string | number | boolean

    获取全局渲染特性。

    Parameters

    Name Type
    key string

    Returns

    string | number | boolean

    getMacro

    ▸ getMacro(key): string | number | boolean

    获取全局宏信息。

    Parameters

    Name Type
    key string

    Returns

    string | number | boolean

    setData

    ▸ setData(data): void

    不通过xml而是直接设置data，注意值的类型需要和schema中一致。

    Parameters

    Name Type
    data Partial<IRenderSystemData>

    Returns

    void

    Inherited from

    Component.setData

    setDataOne

    ▸ setDataOne<T>(key, value): void

    设置一个数据。

    Type parameters

    Name Type
    T extends keyof IRenderSystemData

    Parameters

    Name Type
    key T
    value IRenderSystemData[T]

    Returns

    void

    Inherited from

    Component.setDataOne

    useRenderGraph

    ▸ useRenderGraph(rg): void

    使用某个RenderGraph，默认会使用内置的ForwardBaseRG。

    Parameters

    Name Type
    rg default<any>

    Returns

    void