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
- 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/layer count 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 WebGLArrayRenderTarget
Overrides WebGLRenderTarget.constructor
- Defined in ../node_modules/@types/three/src/renderers/WebGLArrayRenderTarget.d.ts:18

Properties

depth

depth: number

depthBuffer

depthBuffer: boolean

Default

true

depthTexture

depthTexture: null | DepthTexture

Default

null

height

height: number

`Readonly`isRenderTarget

isRenderTarget

`Readonly`isWebGLArrayRenderTarget

isWebGLArrayRenderTarget

`Readonly`isWebGLRenderTarget

isWebGLRenderTarget

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

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

false

textures

textures: DataArrayTexture[]

viewport

viewport: Vector4

width

width: number

Accessors

texture

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

Returns DataArrayTexture
Overrides WebGLRenderTarget.texture
- Defined in ../node_modules/@types/three/src/renderers/WebGLArrayRenderTarget.d.ts:25
set texture(value): void
Parameters
- value: DataArrayTexture
Returns void
Overrides WebGLRenderTarget.texture
- Defined in ../node_modules/@types/three/src/renderers/WebGLArrayRenderTarget.d.ts:26

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

clone

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

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:93

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:81

dispose

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

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:62

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:72

setSize

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

Class WebGLArrayRenderTarget

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebGLArrayRenderTarget

Properties

depth

depthBuffer

Default

depthTexture

Default

height

ReadonlyisRenderTarget

ReadonlyisWebGLArrayRenderTarget

ReadonlyisWebGLRenderTarget

resolveDepthBuffer

Default

resolveStencilBuffer

Default

samples

Default

scissor

scissorTest

Default

stencilBuffer

Default

textures

viewport

width

Accessors

texture

Returns DataArrayTexture

Parameters

Returns void

Methods

addEventListener

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

removeEventListener

Type Parameters

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Readonly`isRenderTarget

`Readonly`isWebGLArrayRenderTarget

`Readonly`isWebGLRenderTarget