Class WebGL3DRenderTarget

Represents a three-dimensional render target.

Hierarchy (view full)

WebGLRenderTarget
- WebGL3DRenderTarget

Index

Constructors

constructor

new WebGL3DRenderTarget(width?, height?, depth?, options?): WebGL3DRenderTarget
Creates a new WebGL3DRenderTarget.
Parameters
- Optionalwidth: number
  the width of the render target, in pixels. Default is 1.
- Optionalheight: number
  the height of the render target, in pixels. Default is 1.
- Optionaldepth: number
  the depth of the render target. Default is 1.
- Optionaloptions: RenderTargetOptions
  optional object that holds texture parameters for an auto-generated target texture and depthBuffer/stencilBuffer booleans. See WebGLRenderTarget for details.
Returns WebGL3DRenderTarget
Overrides WebGLRenderTarget.constructor

Properties

textures

textures: Data3DTexture[]

`Readonly`isWebGL3DRenderTarget

isWebGL3DRenderTarget: true

`Readonly`isWebGLRenderTarget

isWebGLRenderTarget: true

`Readonly`isRenderTarget

isRenderTarget: true

width

width: number

height

height: number

depth

depth: number

scissor

scissor: Vector4

scissorTest

scissorTest: boolean

Default

false

viewport

viewport: Vector4

depthBuffer

depthBuffer: boolean

Default

true

stencilBuffer

stencilBuffer: boolean

Default

false

resolveDepthBuffer

resolveDepthBuffer: boolean

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

Default

true

resolveStencilBuffer

resolveStencilBuffer: boolean

Defines whether the stencil buffer should be resolved when rendering into a multisampled render target. This property has no effect when .resolveDepthBuffer is set to false.

Default

true

depthTexture

depthTexture: DepthTexture

Default

null

samples

samples: number

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

Default

Accessors

texture

get texture(): Data3DTexture
The texture property is overwritten with an instance of Data3DTexture.

Returns Data3DTexture
Overrides WebGLRenderTarget.texture
set texture(value): void
Parameters
- value: Data3DTexture
Returns void
Overrides WebGLRenderTarget.texture

Methods

setSize

setSize(width, height, depth?): void
Parameters
- width: number
- height: number
- Optionaldepth: number
Returns void
Inherited from WebGLRenderTarget.setSize

clone

clone(): this
Returns this
Inherited from WebGLRenderTarget.clone

copy

copy(source): this
Parameters
- source: RenderTarget<Texture>
Returns this
Inherited from WebGLRenderTarget.copy

dispose

dispose(): void
Returns void
Inherited from WebGLRenderTarget.dispose

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, WebGL3DRenderTarget>
  The function that gets called when the event is fired.
Returns void
Inherited from WebGLRenderTarget.addEventListener
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebGL3DRenderTarget>
Returns void
Inherited from WebGLRenderTarget.addEventListener

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, WebGL3DRenderTarget>
  The function that gets called when the event is fired.
Returns boolean
Inherited from WebGLRenderTarget.hasEventListener
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebGL3DRenderTarget>
Returns boolean
Inherited from WebGLRenderTarget.hasEventListener

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, WebGL3DRenderTarget>
  The listener function that gets removed.
Returns void
Inherited from WebGLRenderTarget.removeEventListener
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebGL3DRenderTarget>
Returns void
Inherited from WebGLRenderTarget.removeEventListener

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  The event that gets fired.
Returns void
Inherited from WebGLRenderTarget.dispatchEvent

Class WebGL3DRenderTarget

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebGL3DRenderTarget

Properties

textures

ReadonlyisWebGL3DRenderTarget

ReadonlyisWebGLRenderTarget

ReadonlyisRenderTarget

width

height

depth

scissor

scissorTest

Default

viewport

depthBuffer

Default

stencilBuffer

Default

resolveDepthBuffer

Default

resolveStencilBuffer

Default

depthTexture

Default

samples

Default

Accessors

texture

Returns Data3DTexture

Parameters

Returns void

Methods

setSize

Parameters

Returns void

clone

Returns this

copy

Parameters

Returns this

dispose

Returns void

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

Settings

On This Page

`Readonly`isWebGL3DRenderTarget

`Readonly`isWebGLRenderTarget

`Readonly`isRenderTarget