WebGLRenderTarget - Verge3D User Manual - Soft8Soft
Description: Learn how to use WebGLRenderTarget in your interactive 3D apps made with Verge3D

# WebGLRenderTarget

A 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

### WebGLRenderTarget(width : Float, height : Float, options : Object)

width
  The width of the renderTarget. Default is `1`.
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 Texture. The following are valid options:
  wrapS
    Default is ClampToEdgeWrapping.
  wrapT
    Default is ClampToEdgeWrapping.
  magFilter
    Default is LinearFilter.
  minFilter
    Default is LinearFilter.
  generateMipmaps
    Default is `false`.
  format
    Default is RGBAFormat.
  type
    Default is UnsignedByteType.
  anisotropy
    Default is `1`. See Texture.anisotropy.
  encoding
    Default is LinearEncoding.
  depthBuffer
    Default is `true`.
  stencilBuffer
    Default is `false`.
  samples
    Default is `0`.

Creates a new WebGLRenderTarget.

## Properties

### # .isWebGLRenderTarget : Boolean

Read-only flag to check if a given object is of type WebGLRenderTarget.

### # .width : Float

The width of the render target.

### # .height : Float

The height of the render target.

### # .scissor : Vector4

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

### # .scissorTest : Boolean

Indicates whether the scissor test is active or not.

### # .viewport : Vector4

The viewport of this render target.

### # .texture : Texture

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

### # .depthBuffer : Boolean

Renders to the depth buffer. Default is `true`.

### # .stencilBuffer : Boolean

Renders to the stencil buffer. Default is `false`.

### # .depthTexture : DepthTexture

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

### # .samples : Integer

Defines the count of MSAA samples. Can only be used with WebGL 2. Default is `0`.

## Methods

### # .setSize(width : Float, height : Float)

Sets the size of the render target.

### # .clone() → WebGLRenderTarget

Creates a copy of this render target.

### # .copy(source : WebGLRenderTarget) → this

Adopts the settings of the given render target.

### # .dispose()

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

EventDispatcher methods are also available on this class.

## Source

For more info on how to obtain the source code of this module see this page.