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 Summary)

RenderTarget<TTexture>
- WebGLRenderTarget

Index

Constructors

constructor

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

Properties

depth

depth: number

depthBuffer

depthBuffer: boolean

Default

true

height

height: number

`Readonly`isRenderTarget

isRenderTarget: true

`Readonly`isWebGLRenderTarget

isWebGLRenderTarget: true

multiview

multiview: boolean

Whether to this target is used in multiview rendering.

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

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: TTexture[]

viewport

viewport: Vector4

width

width: number

Accessors

depthTexture

get depthTexture(): DepthTexture | null
Returns DepthTexture | null
Inherited from RenderTarget.depthTexture
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/RenderTarget.d.ts:79
set depthTexture(current: DepthTexture | null): void
Parameters
- current: DepthTexture | null
Returns void
Inherited from RenderTarget.depthTexture
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/RenderTarget.d.ts:78

texture

get texture(): TTexture
Returns TTexture
Inherited from RenderTarget.texture
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/RenderTarget.d.ts:75
set texture(value: TTexture): void
Parameters
- value: TTexture
Returns void
Inherited from RenderTarget.texture
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/RenderTarget.d.ts:76

Methods

addEventListener

addEventListener<T extends "dispose">(
type: T,
listener: EventListener<{ dispose: {} }[T], T, WebGLRenderTarget<TTexture>>,
): 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/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:52

clone

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

copy

copy(source: RenderTarget): this
Parameters
- source: RenderTarget
Returns this
Inherited from RenderTarget.copy
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/RenderTarget.d.ts:83

dispatchEvent

dispatchEvent<T extends "dispose">(
event: BaseEvent<T> & { dispose: {} }[T],
): 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/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

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

hasEventListener

hasEventListener<T extends "dispose">(
type: T,
listener: EventListener<{ dispose: {} }[T], T, WebGLRenderTarget<TTexture>>,
): 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/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:62

removeEventListener

removeEventListener<T extends "dispose">(
type: T,
listener: EventListener<{ dispose: {} }[T], T, WebGLRenderTarget<TTexture>>,
): 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/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:72

setSize

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

Class WebGLRenderTarget<TTexture>

Example

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WebGLRenderTarget<TTexture>

Properties

depth

depthBuffer

Default

height

ReadonlyisRenderTarget

ReadonlyisWebGLRenderTarget

multiview

Default

resolveDepthBuffer

Default

resolveStencilBuffer

Default

samples

Default

scissor

scissorTest

Default

stencilBuffer

Default

textures

viewport

width

Accessors

depthTexture

Returns DepthTexture | null

Parameters

Returns void

texture

Returns TTexture

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`isWebGLRenderTarget