[name]

A [link:https://webglfundamentals.org/webgl/lessons/webgl-render-to-texture.html render target] is a buffer where the video card draws pixels for a scene that is being rendered in the background. It is used in different effects, such as applying postprocessing to a rendered image before displaying it on the screen.

Constructor

[name]([param:Number width], [param:Number height], [param:Object options])

[page:Float width] - The width of the renderTarget. Default is `1`.
[page:Float height] - The height of the renderTarget. Default is `1`.
options - optional object that holds texture parameters for an auto-generated target texture and depthBuffer/stencilBuffer booleans. For an explanation of the texture parameters see [page:Texture Texture]. The following are valid options:

[page:Constant wrapS] - default is [page:Textures ClampToEdgeWrapping].
[page:Constant wrapT] - default is [page:Textures ClampToEdgeWrapping].
[page:Constant magFilter] - default is [page:Textures LinearFilter].
[page:Constant minFilter] - default is [page:Textures LinearFilter].
[page:Boolean generateMipmaps] - default is `false`.
[page:Constant format] - default is [page:Textures RGBAFormat].
[page:Constant type] - default is [page:Textures UnsignedByteType].
[page:Number anisotropy] - default is `1`. See [page:Texture.anisotropy]
[page:Constant colorSpace] - default is [page:Textures NoColorSpace].
[page:String internalFormat] - default is `null`.
[page:Boolean depthBuffer] - default is `true`.
[page:Boolean stencilBuffer] - default is `false`.
[page:Boolean resolveDepthBuffer] - default is `true`.
[page:Boolean resolveStencilBuffer] - default is `true`.
[page:Number samples] - default is `0`.
[page:Number count] - default is `1`.

Creates a new [name]

Properties

[property:Boolean isWebGLRenderTarget]

Read-only flag to check if a given object is of type [name].

[property:number width]

The width of the render target.

[property:number height]

The height of the render target.

[property:Vector4 scissor]

A rectangular area inside the render target's viewport. Fragments that are outside the area will be discarded.

[property:Boolean scissorTest]

Indicates whether the scissor test is active or not.

[property:Vector4 viewport]

The viewport of this render target.

[property:Texture texture]

This texture instance holds the rendered pixels. Use it as input for further processing.

[property:Texture textures]

An array holding the [page:WebGLRenderTarget.texture texture] references of multiple render targets configured with the [page:Number count] option.

[property:Boolean depthBuffer]

Renders to the depth buffer. Default is true.

[property:Boolean stencilBuffer]

Renders to the stencil buffer. Default is false.

[property:Boolean resolveDepthBuffer]

Defines whether the depth buffer should be resolved when rendering into a multisampled render target. Default is `true`.

[property:Boolean resolveStencilBuffer]

Defines whether the stencil buffer should be resolved when rendering into a multisampled render target. This property has no effect when [page:.resolveDepthBuffer] is set to `false`. Default is `true`.

[property:DepthTexture depthTexture]

If set, the scene depth will be rendered to this texture. Default is null.

[property:Number samples]

Defines the count of MSAA samples. Default is `0`.

Methods

[method:undefined setSize]( [param:Number width], [param:Number height] )

Sets the size of the render target.

[method:WebGLRenderTarget clone]()

Creates a copy of this render target.

[method:this copy]( [param:WebGLRenderTarget source] )

Adopts the settings of the given render target.

[method:undefined dispose]()

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

[page:EventDispatcher EventDispatcher] methods are available on this class.

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]