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

textures isWebGLRenderTarget isRenderTarget width height depth scissor scissorTest viewport depthBuffer stencilBuffer resolveDepthBuffer resolveStencilBuffer depthTexture samples

Accessors

texture

Methods

fromEquirectangularTexture clear setSize clone copy dispose addEventListener hasEventListener removeEventListener dispatchEvent

Constructors

constructor

Properties

textures

textures: CubeTexture[]

ReadonlyisWebGLRenderTarget

isWebGLRenderTarget: true

ReadonlyisRenderTarget

isRenderTarget: true

width

width: number

height

height: number

depth

depth: number

scissor

scissor: Vector4

scissorTest

scissorTest: boolean

Default

false

viewport

viewport: Vector4

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

Default

null

samples

samples: number

Defines the count of MSAA samples. Can only be used with WebGL 2. Default is 0.

Default

0

Accessors

texture

  • get texture(): CubeTexture

  • Returns CubeTexture

  • set texture(value): void

  • Parameters

    Returns void

Methods

fromEquirectangularTexture

  • fromEquirectangularTexture(renderer, texture): this

  • Parameters

    Returns this

clear

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

  • Parameters

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

    Returns void

setSize

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

  • Parameters

    • width: number
    • height: number
    • Optionaldepth: number

    Returns void

clone

copy

dispose

addEventListener

hasEventListener

removeEventListener

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods