Class SceneRenderer

场景渲染器

Export

Date

2022.3.22

Author

lyx

Hierarchy

Constructors

constructor

Properties

_engine activeCamera activeScene renderer viewport

Accessors

engine renderPipeline

Methods

addEventListener compile dispatchEvent dispose removeAllEventListeners removeEventListener removeEventListenerByEventId renderOneFrame renderScene resize screenSnapshot setAnimationLoop transition

Constructors

constructor

Properties

Protected _engine

_engine: Engine

activeCamera

activeCamera: Entity = null

当前激活的相机

Memberof

SceneRenderer

activeScene

activeScene: Entity = null

当前激活的场景实体

Memberof

SceneRenderer

Readonly renderer

renderer: WebGLRenderer

场景渲染器

Memberof

SceneRenderer

Readonly viewport

viewport: HTMLElement

渲染窗口

Memberof

SceneRenderer

Accessors

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

renderPipeline

  • get renderPipeline(): Readonly<RenderPipeline>

  • 获取渲染管线

    Returns Readonly<RenderPipeline>

    Memberof

    SceneRenderer

  • set renderPipeline(value): void

  • 设置渲染管线

    Parameters

    Returns void

    Memberof

    SceneRenderer

Methods

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      } = {}

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

compile

  • 预编译场景材质

    Parameters

    Returns void

    Memberof

    SceneRenderer

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放渲染器

    Returns void

    Memberof

    SceneRenderer

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

renderOneFrame

  • 渲染一帧

    Parameters

    • timeSinceLastFrame: number

      距离上一帧的更新时长（单位：毫秒）

    • Optional timeStamp: number

      时间戳

    • Optional frame: XRFrame

      XR帧

    Returns void

    Memberof

    SceneRenderer

renderScene

  • 渲染标准场景（即非XR场景）

    Parameters

    • timeSinceLastFrame: number

      距离上一帧的更新时长（单位：毫秒）

    • Optional renderTarget: WebGLRenderTarget<Texture>

      渲染目标

    Returns void

    Memberof

    SceneRenderer

resize

  • 渲染窗口‘resize’

    Parameters

    • width: number
    • height: number

    Returns void

    Memberof

    SceneRenderer

screenSnapshot

  • 场景快照

    Parameters

    • Optional width: number = 512

      快照宽度（单位：像素）

    • Optional height: number = 512

      快照高度（单位：像素）

    Returns string

    Memberof

    SceneRenderer

setAnimationLoop

  • 设置动画循环

    Parameters

    • callback: any

    Returns void

    Memberof

    SceneRenderer

transition

  • 场景转场

    Parameters

    Returns void

    Memberof

    SceneRenderer

Settings

Member Visibility

Theme

On This Page