Class WebGLArrayRenderTarget

This type of render target represents an array of textures.

Hierarchy (view full)

WebGLRenderTarget
- WebGLArrayRenderTarget

Constructors

constructor

new WebGLArrayRenderTarget(width?, height?, depth?, options?): WebGLArrayRenderTarget
Creates a new WebGLArrayRenderTarget.
Parameters
- Optional width: number
  the width of the render target, in pixels. Default is 1.
- Optional height: number
  the height of the render target, in pixels. Default is 1.
- Optional depth: number
  the depth/layer count of the render target. Default is 1.
- Optional options: WebGLRenderTargetOptions
  optional object that holds texture parameters for an auto-generated target texture and depthBuffer/stencilBuffer booleans. See WebGLRenderTarget for details.
Returns WebGLArrayRenderTarget
Overrides WebGLRenderTarget.constructor
- Defined in ../node_modules/@types/three/src/renderers/WebGLArrayRenderTarget.d.ts:17

Properties

depth

depth: number

The depth of the render target.

depthBuffer

depthBuffer: boolean

Default

true

depthTexture

depthTexture: DepthTexture

Default

null

height

height: number

`Readonly` isRenderTarget

isRenderTarget: true

`Readonly` isWebGLArrayRenderTarget

isWebGLArrayRenderTarget: true

`Readonly` isWebGLRenderTarget

isWebGLRenderTarget: true

samples

samples: number

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

Default

scissor

scissor: Vector4

scissorTest

scissorTest: boolean

Default

false

stencilBuffer

stencilBuffer: boolean

Default

true

texture

texture: DataArrayTexture

The texture property is overwritten with an instance of DataArrayTexture.

viewport

viewport: Vector4

width

width: number

Methods

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, WebGLArrayRenderTarget>
  The function that gets called when the event is fired.
Returns void
Inherited from WebGLRenderTarget.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebGLArrayRenderTarget>
Returns void
Inherited from WebGLRenderTarget.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

clone

clone(): this
Returns this
Inherited from WebGLRenderTarget.clone
- Defined in ../node_modules/@types/three/src/core/RenderTarget.d.ts:77

copy

copy(source): this
Parameters
- source: RenderTarget<Texture>
Returns this
Inherited from WebGLRenderTarget.copy
- Defined in ../node_modules/@types/three/src/core/RenderTarget.d.ts:78

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
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

dispose(): void
Returns void
Inherited from WebGLRenderTarget.dispose
- Defined in ../node_modules/@types/three/src/core/RenderTarget.d.ts:79

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, WebGLArrayRenderTarget>
  The function that gets called when the event is fired.
Returns boolean
Inherited from WebGLRenderTarget.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebGLArrayRenderTarget>
Returns boolean
Inherited from WebGLRenderTarget.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

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, WebGLArrayRenderTarget>
  The listener function that gets removed.
Returns void
Inherited from WebGLRenderTarget.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebGLArrayRenderTarget>
Returns void
Inherited from WebGLRenderTarget.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

setSize

setSize(width, height, depth?): void
Parameters
- width: number
- height: number
- Optional depth: number
Returns void
Inherited from WebGLRenderTarget.setSize
- Defined in ../node_modules/@types/three/src/core/RenderTarget.d.ts:76

Class WebGLArrayRenderTarget

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebGLArrayRenderTarget

Properties

depth

depthBuffer

Default

depthTexture

Default

height

Readonly isRenderTarget

Readonly isWebGLArrayRenderTarget

Readonly isWebGLRenderTarget

samples

Default

scissor

scissorTest

Default

stencilBuffer

Default

texture

viewport

width

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

clone

Returns this

copy

Parameters

Returns this

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

setSize

Parameters

Returns void

Settings

Member Visibility

On This Page

`Readonly` isRenderTarget

`Readonly` isWebGLArrayRenderTarget

`Readonly` isWebGLRenderTarget