JSAPI Three API Reference
    正在准备搜索索引...

    类 EngineRendering

    渲染管理器
    该类会随Engine的初始化自动实例化，不需要开发者手动执行初始化，通过engine.rendering访问， 与渲染相关的配置和控制都在此类中实现

    engine.rendering.features.bloom.enabled = true;
    engine.rendering.enableAnimationLoop = true;
    engine.rendering.animationLoopFrameTime = 16;
    索引

    构造函数

    constructor

    方法

    dispose

    访问器

    animation animationLoopFrameTime autoOffsetRelativeCenter camera contextParameters debugMode enableAnimationLoop freezeUpdate label picking pixelRatio renderer renderState resolution scene sky stats useHighPrecisionBuffer weather

    构造函数

    • 参数

      • engine: Engine
      • overrideOptions: {
            animationLoopFrameTime: number;
            contextParameters: { preserveDrawingBuffer: boolean };
            enableAnimationLoop: boolean;
            features: {
                antialias: { enabled: boolean; method: string };
                bloom: {
                    enabled: boolean;
                    radius: number;
                    strength: number;
                    threshold: number;
                };
            };
            pixelRatio: number;
        } = {}
        • animationLoopFrameTime: number

          动画循环帧时间, 默认16

        • contextParameters: { preserveDrawingBuffer: boolean }

          webgl context参数,大部分由引擎内部设置，开发者不需要关心

          • preserveDrawingBuffer: boolean

            是否保留绘图缓冲区, 默认false,开启截图时需要设置为true

        • enableAnimationLoop: boolean

          是否开启动画循环, 默认false

        • features: {
              antialias: { enabled: boolean; method: string };
              bloom: {
                  enabled: boolean;
                  radius: number;
                  strength: number;
                  threshold: number;
              };
          }

          渲染特性配置

          • antialias: { enabled: boolean; method: string }

            抗锯齿配置

            • enabled: boolean

              是否开启抗锯齿, 默认true

            • method: string

              抗锯齿方法, 默认'smaa'

          • bloom: { enabled: boolean; radius: number; strength: number; threshold: number }

            泛光配置

            • enabled: boolean

              是否开启泛光, 默认false

            • radius: number

              泛光半径, 默认0

            • strength: number

              泛光强度, 默认0.1

            • threshold: number

              泛光阈值, 默认1

        • pixelRatio: number

          像素缩放, 默认window.devicePixelRatio

      返回 EngineRendering

    方法

    • 释放场景中的资源，停止渲染更新操作。 由engine.dispose调用

      返回 void

    访问器

    • get animationLoopFrameTime(): number

      循环渲染的事件间隔，默认为16ms

      返回 number

    • set animationLoopFrameTime(value: number): void

      设置循环渲染的事件间隔

      参数

      • value: number

      返回 void

    • get autoOffsetRelativeCenter(): boolean

      是否自动偏移相机和场景，以使worldMatrix偏移量较小

      返回 boolean

    • set autoOffsetRelativeCenter(value: boolean): void

      设置是否自动偏移相机和场景，以使worldMatrix偏移量较小

      参数

      • value: boolean

      返回 void

    • get camera(): any

      相机对象

      返回 any

    • get contextParameters(): {
          alpha: boolean;
          antialias: boolean;
          powerPreference: string;
          premultipliedAlpha: boolean;
          preserveDrawingBuffer: boolean;
          stencil: boolean;
      }

      获取当前webgl context参数

      返回 {
          alpha: boolean;
          antialias: boolean;
          powerPreference: string;
          premultipliedAlpha: boolean;
          preserveDrawingBuffer: boolean;
          stencil: boolean;
      }

    • get debugMode(): number

      渲染器的debug模式

      返回 number

    • set debugMode(value: number): void

      渲染器的debug模式，可以设置为DEBUG_MODE_NONE、DEBUG_MODE_MESH、DEBUG_MODE_MATERIAL、DEBUG_MODE_OBJECT

      参数

      • value: number

      返回 void

    • get enableAnimationLoop(): any

      是否开启循环渲染

      返回 any

    • get freezeUpdate(): boolean

      是否禁止更新

      返回 boolean

    • set freezeUpdate(freezeUpdate: boolean): void

      设置是否禁止更新

      参数

      • freezeUpdate: boolean

      返回 void

    • get pixelRatio(): number

      设备像素比，默认为window.devicePixelRatio

      返回 number

    • set pixelRatio(value: number): void

      设置设备像素比

      参数

      • value: number

      返回 void

    • get renderer(): any

      渲染器对象

      返回 any

    • get renderState(): RenderState

      用来保存渲染状态，如视图矩阵、相机的世界坐标等信息

      返回 RenderState

    • get resolution(): any

      渲染场景分辨率

      返回 any

    • get scene(): any

      场景对象

      返回 any

    • get sky(): null

      天空实例。 如果场景中有天空，则返回天空实例，否则返回null

      返回 null

    • get useHighPrecisionBuffer(): boolean

      是否使用高质量的渲染缓冲区，默认false。 该参数会影响到渲染的性能和质量，开启后会使用高质量的渲染缓冲区，关闭后会使用低质量的渲染缓冲区。 有的渲染特性需要开启该参数才能正常工作，如泛光、反射等。这些内置的渲染特性会自动开启该参数。 当您在未使用高级渲染特性，但需要使用高质量的渲染缓冲区提升画面质量时，可以手动开启该参数。

      返回 boolean

    • set useHighPrecisionBuffer(value: boolean): void

      设置是否使用高质量的渲染缓冲区

      参数

      • value: boolean

      返回 void

    • get weather(): any

      天气实例。 如果场景中有天气，则返回天气实例，否则返回null

      返回 any

    显示设置

    成员可见性

    目录

    构造函数
    方法
    访问器