three.js WebGLRenderer

WebGL Render 用WebGL渲染出你精心制作的场景。

构造器

WebGLRenderer( parameters : Object )

parameters - (可选) 该对象的属性定义了渲染器的行为。也可以完全不传参数。在所有情况下，当缺少参数时，它将采用合理的默认值。 以下是合法参数：

canvas - 一个供渲染器绘制其输出的canvas 它和下面的domElement属性对应。 如果没有传这个参数，会创建一个新canvas
context - 可用于将渲染器附加到已有的渲染环境(RenderingContext)中。默认值是null
precision - 着色器精度. 可以是 "highp", "mediump" 或者 "lowp". 如果设备支持，默认为"highp" .
alpha - 控制默认的透明 alpha 值。当设置为 true 时，值为 0。否则为 1。默认值为 false。

premultipliedAlpha - renderer是否假设颜色有 premultiplied alpha. 默认为true
antialias - 是否执行抗锯齿。默认为false.
stencil - 绘图缓存是否有一个至少8位的模板缓存(stencil buffer)。默认为true
preserveDrawingBuffer -是否保留缓直到手动清除或被覆盖。 默认false.
powerPreference - 提示用户代理怎样的配置更适用于当前WebGL环境。 可能是"high-performance", "low-power" 或 "default"。默认是"default". 
failIfMajorPerformanceCaveat - 检测渲染器是否会因性能过差而创建失败。默认为false。
depth - 绘图缓存是否有一个至少6位的深度缓存(depth buffer )。 默认是true.
logarithmicDepthBuffer - 是否使用对数深度缓存。如果要在单个场景中处理巨大的比例差异，就有必要使用。 请注意，此设置使用 gl_FragDepth（如果可用），它会禁用早期片段测试优化并可能导致性能下降。 默认是false。

属性

.autoClear : Boolean

定义渲染器是否在渲染每一帧之前自动清除其输出。

.autoClearColor : Boolean

如果autoClear为true, 定义renderer是否清除颜色缓存。 默认是true

.autoClearDepth : Boolean

如果autoClear是true, 定义renderer是否清除深度缓存。 默认是true

.autoClearStencil : Boolean

如果autoClear是true, 定义renderer是否清除模板缓存. 默认是true

.debug : Object

- checkShaderErrors: 如果为true，定义是否检查材质着色器程序 编译和链接过程中的错误。 禁用此检查生产以获得性能增益可能很有用。 强烈建议在开发期间保持启用这些检查。 如果着色器没有编译和链接 - 它将无法工作，并且相关材料将不会呈现。 默认是true

.capabilities : Object

一个包含当前渲染环境(RenderingContext)的功能细节的对象。

- floatFragmentTextures: 环境是否支持OES_texture_float扩展
- floatVertexTextures: 如果floatFragmentTextures和vertexTextures都是true， 则此值为true
- getMaxAnisotropy(): 返回最大可用各向异性。
- getMaxPrecision(): 返回顶点着色器和片元着色器的最大可用精度。
- isWebGL2: 如果使用的上下文是 WebGL2RenderingContext 对象，则为true。

- logarithmicDepthBuffer: 如果logarithmicDepthBuffer在构造器中被设为true且 环境支持EXT_frag_depth扩展，则此值为true
- maxAttributes: gl.MAX_VERTEX_ATTRIBS的值
- maxCubemapSize: gl.MAX_CUBE_MAP_TEXTURE_SIZE 的值，着色器可使用的立方体贴图纹理的最大宽度*高度
- maxFragmentUniforms: gl.MAX_FRAGMENT_UNIFORM_VECTORS的值，片元着色器可使用的全局变量(uniforms)数量
- maxSamples: gl.MAX_SAMPLES 的值。多重采样抗锯齿 (MSAA) 上下文中的最大采样数。

- maxTextureSize: gl.MAX_TEXTURE_SIZE的值，着色器可使用纹理的最大宽度*高度
- maxTextures: gl.MAX_TEXTURE_IMAGE_UNITS的值，着色器可使用的纹理数量
- maxVaryings: gl.MAX_VARYING_VECTORS的值，着色器可使用矢量的数量
- maxVertexTextures: gl.MAX_VERTEX_TEXTURE_IMAGE_UNITS的值，顶点着色器可使用的纹理数量。
- maxVertexUniforms: gl.MAX_VERTEX_UNIFORM_VECTORS的值，顶点着色器可使用的全局变量(uniforms)数量
- precision: 渲染器当前使用的着色器的精度
- vertexTextures: 如果 .maxVertexTextures : Integer大于0，此值为true (即可以使用顶点纹理)

.clippingPlanes : Array

用户自定义的剪裁平面，在世界空间中被指定为THREE.Plane对象。 这些平面全局使用。空间中与该平面点积为负的点将被切掉。 默认值是[]

.domElement : DOMElement

一个canvas，渲染器在其上绘制输出。

渲染器的构造函数会自动创建(如果没有传入canvas参数);你需要做的仅仅是像下面这样将它加页面里去:

document.body.appendChild( renderer.domElement );

.extensions : Object

- get( extensionName : String ): 用于检查是否支持各种扩展，并返回一个对象，其中包含扩展的详细信息。 该方法检查以下扩展：

• WEBGL_depth_texture
• EXT_texture_filter_anisotropic
• WEBGL_compressed_texture_s3tc
• WEBGL_compressed_texture_pvrtc
• WEBGL_compressed_texture_etc1

.outputEncoding : number

定义渲染器的输出编码。默认为THREE.LinearEncoding

如果渲染目标已经使用 .setRenderTarget、之后将直接使用renderTarget.texture.encoding

.info : Object

一个对象，包含有关图形板内存和渲染过程的一系列统计信息。这些信息可用于调试或仅仅满足下好奇心。该对象包含以下字段:

• memory:
  • geometries
  • textures
• render:
  • calls
  • triangles
  • points
  • lines
  • frame
• programs

默认情况下，这些字段在每次渲染调用时都会重置，但是当每帧有多个渲染通道时（例如，使用后处理时），最好使用自定义模式重置。先将 autoReset 设置为 false.

renderer.info.autoReset = false;

然后在单个帧时渲染完成后调用 reset().

renderer.info.reset();

.localClippingEnabled : Boolean

定义渲染器是否考虑对象级剪切平面。 默认为false.

.physicallyCorrectLights : Boolean

是否使用物理上正确的光照模式。 默认是false。 示例：lights / physical

.properties : Object

渲染器内部使用，以跟踪各种子对象属性。

.renderLists : WebGLRenderLists

在内部用于处理场景渲染对象的排序。

.shadowMap : WebGLShadowMap

如果使用，它包含阴影贴图的引用。

- enabled: 如果设置开启，允许在场景中使用阴影贴图。默认是 false。
- autoUpdate: 启用场景中的阴影自动更新。默认是true
如果不需要动态光照/阴影, 则可以在实例化渲染器时将之设为false
- needsUpdate: 当被设为true, 场景中的阴影贴图会在下次render调用时刷新。默认是false
如果你已经禁用了阴影贴图的自动更新(shadowMap.autoUpdate = false), 那么想要在下一次渲染时更新阴影的话就需要将此值设为true
- type: 定义阴影贴图类型 (未过滤, 关闭部分过滤, 关闭部分双线性过滤), 可选值有:

• THREE.BasicShadowMap
• THREE.PCFShadowMap (默认)
• THREE.PCFSoftShadowMap
• THREE.VSMShadowMap

.sortObjects : Boolean

定义渲染器是否应对对象进行排序。默认是true.

说明: 排序用于尝试正确渲染出具有一定透明度的对象。根据定义，排序可能不总是有用。根据应用的需求，可能需要关闭排序并使其他方法来处理透明度的渲染，例如， 手动确定每个对象的渲染顺序。

.state : Object

包含设置WebGLRenderer.context状态的各种属性的函数。

.toneMapping : Constant

默认是NoToneMapping。

.toneMappingExposure : Number

色调映射的曝光级别。默认是1

.xr : WebXRManager

提供对渲染器的 WebXR 相关接口的访问。

方法

.clear ( color : Boolean, depth : Boolean, stencil : Boolean ) : undefined

告诉渲染器清除颜色、深度或模板缓存. 此方法将颜色缓存初始化为当前颜色。参数们默认都是true

.clearColor ( ) : undefined

清除颜色缓存。 相当于调用.clear( true, false, false )

.clearDepth ( ) : undefined

清除深度缓存。相当于调用.clear( false, true, false )

.clearStencil ( ) : undefined

清除模板缓存。相当于调用.clear( false, false, true )

.compile ( scene : Object3D, camera : Camera ) : undefined

使用相机编译场景中的所有材质。这对于在首次渲染之前预编译着色器很有用。

.copyFramebufferToTexture ( position : Vector2, texture : FramebufferTexture, level : Number ) : undefined

将当前WebGLFramebuffer中的像素复制到2D纹理中。

.copyTextureToTexture ( position : Vector2, srcTexture : Texture, dstTexture : Texture, level : Number ) : undefined

将纹理的所有像素复制到一个已有的从给定位置开始的纹理中。

.dispose ( ) : undefined

处理当前的渲染环境

.forceContextLoss () : undefined

模拟WebGL环境的丢失。需要支持 WEBGL_lose_context 扩展才能用。

.forceContextRestore ( ) : undefined

模拟WebGL环境的恢复。需要支持 WEBGL_lose_context 扩展才能用。

.getClearAlpha () : Float

返回一个表示当前alpha值的float，范围0到1

.getClearColor ( target : Color ) : Color

返回一个表示当前颜色值的THREE.Color实例

.getContext () : WebGL2RenderingContext

返回当前WebGL环境

.getContextAttributes () : WebGLContextAttributes

返回一个对象，这个对象中存有在WebGL环境在创建的时候所设置的属性

.getActiveCubeFace () : Integer

返回当前活动的立方体面。

.getActiveMipmapLevel () : Integer

返回当前活动的 mipmap 级别。

.getRenderTarget () : RenderTarget

如果当前存在RenderTarget，则返回该值；否则返回null。

.getCurrentViewport () : RenderTarget

返回当前视口

.getDrawingBufferSize () : Object

返回一个包含渲染器绘图缓存宽度和高度(单位像素)的对象。

.getPixelRatio () : number

返回当前使用设备像素比

.getSize ( target : Vector2 ) : Vector2

返回包含渲染器输出canvas的宽度和高度(单位像素)的对象。

.initTexture ( texture : Texture ) : undefined

初始化给定的纹理。用于预加载纹理而不是等到第一次渲染（可能会由于解码和 GPU 上传的开销而导致明显的延迟）.

.resetGLState ( ) : undefined

将GL状态重置为默认值。WebGL环境丢失时会内部调用

.readRenderTargetPixels ( renderTarget : WebGLRenderTarget, x : Float, y : Float, width : Float, height : Float, buffer : TypedArray, activeCubeFaceIndex : Integer ) : undefined

buffer - Uint8Array 是唯一在所有情况下都受支持的目标类型，其他类型取决于 renderTarget 和平台。

将renderTarget中的像素数据读取到传入的缓冲区中。这是WebGLRenderingContext.readPixels()的包装器

示例：interactive / cubes / gpu

要读取 WebGLCubeRenderTarget，请使用可选参数 activeCubeFaceIndex 来确定应读取哪个面。

.render ( scene : Object3D, camera : Camera ) : undefined

用相机(camera)渲染一个场景(scene)或是其它类型的object。
渲染一般是在canvas上完成的，或者是renderTarget(如果有指定)
如果forceClear值是true，那么颜色、深度及模板缓存将会在渲染之前清除，即使渲染器的autoClear属性值是false
即便forceClear设为true, 也可以通过将autoClearColor、autoClearStencil或autoClearDepth属性的值设为false来阻止对应缓存被清除。

.resetState () : undefined

可用于重置内部 WebGL 状态。此方法主要与跨多个 WebGL 库共享单个 WebGL 上下文的应用程序相关。

.setAnimationLoop ( callback : Function ) : undefined

callback — 每个可用帧都会调用的函数。 如果传入‘null’,所有正在进行的动画都会停止。

可用来代替requestAnimationFrame的内置函数. 对于WebXR项目，必须使用此函数。

.setClearAlpha ( alpha : Float ) : undefined

设置alpha。合法参数是一个0.0到 1.0之间的浮点数

.setClearColor ( color : Color, alpha : Float ) : undefined

设置颜色及其透明度

.setPixelRatio ( value : number ) : undefined

设置设备像素比。通常用于避免HiDPI设备上绘图模糊

.setRenderTarget ( renderTarget : WebGLRenderTarget, activeCubeFace : Integer, activeMipmapLevel : Integer ) : undefined

renderTarget -- 需要被激活的renderTarget(可选)。若此参数为空，则将canvas设置成活跃render target。
activeCubeFace -- 指定 WebGLCubeRenderTarget 的活动立方体面（PX 0、NX 1、PY 2、NY 3、PZ 4、NZ 5）。传递 WebGLArrayRenderTarget 或 WebGL3DRenderTarget 时，这表示要渲染到的 z 层（可选）。

activeMipmapLevel -- 指定活动的 mipmap 级别（可选）。

该方法设置活跃rendertarget。

.setScissor ( x : Integer, y : Integer, width : Integer, height : Integer ) : undefined

将剪裁区域设为(x, y)到(x + width, y + height) Sets the scissor area from

.setScissorTest ( boolean : Boolean ) : undefined

启用或禁用剪裁检测. 若启用，则只有在所定义的裁剪区域内的像素才会受之后的渲染器影响。

.setSize ( width : Integer, height : Integer, updateStyle : Boolean ) : undefined

将输出canvas的大小调整为(width, height)并考虑设备像素比，且将视口从(0, 0)开始调整到适合大小 将updateStyle设置为false以阻止对canvas的样式做任何改变。

.setViewport ( x : Integer, y : Integer, width : Integer, height : Integer ) : undefined

将视口大小设置为(x, y)到 (x + width, y + height).

源码

src/renderers/WebGLRenderer.js