Class RenderTexture

Render texture

Export

RenderTexture

Date

2024.1.7

Author

yisky

Hierarchy (view full)

EventDispatcher
- RenderTexture

Index

Constructors

Accessors

depthTexture texture

Methods

dispose emit off on once reset

Constructors

constructor

new RenderTexture(options): RenderTexture
Parameters
- options: RenderTextureOptions
Returns RenderTexture
Overrides EventDispatcher.constructor

Accessors

depthTexture

get depthTexture(): Readonly<DepthTexture>
Get render depth texture

Returns Readonly<DepthTexture>
Memberof
RenderTexture

texture

get texture(): Readonly<Texture>
Get render texture

Returns Readonly<Texture>
Memberof
RenderTexture

Methods

dispose

dispose(): void
Dispose render texture

Returns void
Memberof
RenderTexture

Overrides EventDispatcher.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from EventDispatcher.emit

off

off(type, callback?): void
Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.
Parameters
- type: string
- Optionalcallback: SubscriberCallbackFn
  subscriber callback
Returns void
Memberof
EventDispatcher

Inherited from EventDispatcher.off

on

on(type, callback, options?): void
Subscribe a event
Parameters
- type: string
  event type
- callback: SubscriberCallbackFn
  callback functions
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  } = {}
  options
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from EventDispatcher.on

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- options: {
  priority?: Priority;
  target?: any;
  } = {}
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from EventDispatcher.once

reset

reset(): void
Reset

Returns void
Memberof
RenderTexture