Class WebGLCubeRenderTarget

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

Hierarchy (view full)

Constructors

constructor

Properties

depth depthBuffer depthTexture height isRenderTarget isWebGLRenderTarget samples scissor scissorTest stencilBuffer texture viewport width

Methods

addEventListener clear clone copy dispatchEvent dispose fromEquirectangularTexture hasEventListener removeEventListener setSize

Constructors

constructor

Properties

depth

depth: number

depthBuffer

depthBuffer: boolean

Default

true

depthTexture

depthTexture: DepthTexture

Default

null

height

height: number

Readonly isRenderTarget

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

0

scissor

scissor: Vector4

scissorTest

scissorTest: boolean

Default

false

stencilBuffer

stencilBuffer: boolean

Default

true

texture

texture: CubeTexture

viewport

viewport: Vector4

width

width: number

Methods

addEventListener

clear

  • clear(renderer, color, depth, stencil): void

  • Parameters

    • renderer: WebGLRenderer
    • color: boolean
    • depth: boolean
    • stencil: boolean

    Returns void

clone

  • clone(): this

  • Returns this

copy

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

dispose

  • dispose(): void

  • Returns void

fromEquirectangularTexture

  • fromEquirectangularTexture(renderer, texture): this

  • Parameters

    Returns this

hasEventListener

  • hasEventListener<T>(type, listener): boolean

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    Returns boolean

  • hasEventListener<T>(type, listener): boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

removeEventListener

setSize

  • setSize(width, height, depth?): void

  • Parameters

    • width: number
    • height: number
    • Optional depth: number

    Returns void

Settings

Member Visibility

On This Page

constructordepthdepthBufferdepthTextureheightisRenderTargetisWebGLRenderTargetsamplesscissorscissorTeststencilBuffertextureviewportwidthaddEventListenerclearclonecopydispatchEventdisposefromEquirectangularTexturehasEventListenerremoveEventListenersetSize