Class RenderTarget<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)

EventDispatcher<{
dispose: {};
}>
- RenderTarget
  - WebGLRenderTarget

Index

Constructors

constructor

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

Properties

depth

depth: number

depthBuffer

depthBuffer: boolean

Default

true

depthTexture

depthTexture: DepthTexture

Default

null

height

height: number

`Readonly`isRenderTarget

isRenderTarget

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

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

clone

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

copy

copy(source): this
Parameters
- source: RenderTarget<Texture>
Returns this
- 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 EventDispatcher.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

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

setSize

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

Class RenderTarget<TTexture>

Example

See

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RenderTarget<TTexture>

Properties

depth

depthBuffer

Default

depthTexture

Default

height

ReadonlyisRenderTarget

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

On This Page

`Readonly`isRenderTarget