RenderTarget3D

Render Target that render to 3d texture.

Constructor

new RenderTarget3D(width, height, depth)

Parameters:
NameTypeDescription
widthnumber

The width of the render target.

heightnumber

The height of the render target.

depthnumber

The depth of the render target.

Extends

Members

activeLayer :number

Specifies the layer. This is only available in WebGL2.

Type:
  • number
Default Value
  • 0

activeMipmapLevel :number

Specifies the active mipmap level. This is only available in WebGL2.

Type:
  • number
Default Value
  • 0

height :number

The height of the render target.

Type:
  • number

(readonly) isRenderTarget :boolean

Type:
  • boolean
Default Value
  • true

(readonly) isRenderTarget3D :boolean

Type:
  • boolean
Default Value
  • true

width :number

The width of the render target.

Type:
  • number

Methods

addEventListener(type, listener)

Adds a listener to an event type.

Parameters:
NameTypeDescription
typestring

The type of event to listen to.

listenerfunction

The function that gets called when the event is fired.

attach(target, attachmentopt)

Attach a texture(RTT) or renderbuffer to the framebuffer. Notice: For now, dynamic Attachment during rendering is not supported.

Parameters:
NameTypeAttributesDefaultDescription
targetTexture3D | RenderBuffer
attachmentATTACHMENT<optional>
ATTACHMENT.COLOR_ATTACHMENT0

detach(attachmentopt)

Detach a texture(RTT) or renderbuffer.

Parameters:
NameTypeAttributesDefaultDescription
attachmentATTACHMENT<optional>
ATTACHMENT.COLOR_ATTACHMENT0

dispatchEvent(event)

Fire an event.

Parameters:
NameTypeDescription
eventobject

The event that gets fired.

dispose(disposeAttachmentsopt)

Dispose the render target.

Parameters:
NameTypeAttributesDefaultDescription
disposeAttachmentsboolean<optional>
true

whether to dispose textures and render buffers attached on this render target.

removeEventListener(type, listener)

Removes a listener from an event type.

Parameters:
NameTypeDescription
typestring

The type of the listener that gets removed.

listenerfunction

The listener function that gets removed.

resize(width, height, depth) → {boolean}

Resize the render target.

Parameters:
NameTypeDescription
widthnumber

The width of the render target.

heightnumber

The height of the render target.

depthnumber

The depth of the render target.

Returns:
  • If size changed.
Type: 
boolean