---

title: WebGLCubeRenderTarget category: Core layout: docs

WebGLCubeRenderTarget

A cube render target used in context of WebGLRenderer.

Constructor

new WebGLCubeRenderTarget( size : number, options : RenderTarget~Options )

Constructs a new cube render target.

size | The size of the render target. Default is 1.
---|---
options | The configuration object.

Properties

.isWebGLCubeRenderTarget : boolean (readonly)

This flag can be used for type testing.

Default is true.

.texture : DataArrayTexture

Overwritten with a different texture type.

Overrides: WebGLRenderTarget#texture

Methods

.clear( renderer : WebGLRenderer, color : boolean, depth : boolean, stencil : boolean )

Clears this cube render target.

renderer | The renderer.
---|---
color | Whether the color buffer should be cleared or not. Default is true.
depth | Whether the depth buffer should be cleared or not. Default is true.
stencil | Whether the stencil buffer should be cleared or not. Default is true.

.fromEquirectangularTexture( renderer : WebGLRenderer, texture : Texture ) : WebGLCubeRenderTarget

Converts the given equirectangular texture to a cube map.

renderer | The renderer.
---|---
texture | The equirectangular texture.

Returns: A reference to this cube render target.

Source

src/renderers/WebGLCubeRenderTarget.js