Class WebGLRenderTarget<TTexture>

JavaScript events for custom objects

Example

// Adding events to a custom object
class Car extends EventDispatcher {
  start() {
    this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  }
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', ( event ) => {
  alert( event.message );
} );
car.start();

See

Type Parameters

TTexture extends Texture | Texture[] = Texture

Hierarchy (view full)

RenderTarget<TTexture>
- WebGLRenderTarget

Index

Constructors

constructor

new WebGLRenderTarget<TTexture>(width?, height?, options?): WebGLRenderTarget<TTexture>
Type Parameters
- TTexture extends Texture | Texture[] = Texture
Parameters
- Optionalwidth: number
- Optionalheight: number
- Optionaloptions: RenderTargetOptions
Returns WebGLRenderTarget<TTexture>
Overrides RenderTarget.constructor
- Defined in node_modules/@types/three/src/renderers/WebGLRenderTarget.d.ts:5

Properties

`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

textures

textures: TTexture[]

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: null | 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(): TTexture
Returns TTexture
Inherited from RenderTarget.texture
- Defined in node_modules/@types/three/src/core/RenderTarget.d.ts:89
set texture(value): void
Parameters
- value: TTexture
Returns void
Inherited from RenderTarget.texture
- Defined in node_modules/@types/three/src/core/RenderTarget.d.ts:90

Methods

setSize

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

clone

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

copy

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

dispose

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

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, WebGLRenderTarget<TTexture>>
  The function that gets called when the event is fired.
Returns void
Inherited from RenderTarget.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, WebGLRenderTarget<TTexture>>
Returns void
Inherited from RenderTarget.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:56

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, WebGLRenderTarget<TTexture>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from RenderTarget.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, WebGLRenderTarget<TTexture>>
Returns boolean
Inherited from RenderTarget.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, WebGLRenderTarget<TTexture>>
  The listener function that gets removed.
Returns void
Inherited from RenderTarget.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, WebGLRenderTarget<TTexture>>
Returns void
Inherited from RenderTarget.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.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 RenderTarget.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:84

Class WebGLRenderTarget<TTexture>

Example

See

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WebGLRenderTarget<TTexture>

Properties

ReadonlyisWebGLRenderTarget

ReadonlyisRenderTarget

width

height

depth

scissor

scissorTest

Default

viewport

textures

depthBuffer

Default

stencilBuffer

Default

resolveDepthBuffer

Default

resolveStencilBuffer

Default

depthTexture

Default

samples

Default

Accessors

texture

Returns TTexture

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

`Readonly`isWebGLRenderTarget

`Readonly`isRenderTarget