Skip to content

Documentation / scene / IRenderable

Interface: IRenderable ​

Defined in: libs/scene/src/app/engine.ts:38

Interface for objects that can be rendered.

Extends ​

  • IDisposable

Properties ​

[EventMapType]? ​

readonly optional [EventMapType]?: object

Defined in: libs/base/dist/index.d.ts:585

Type-only event map marker.

dispose ​

dispose: []

Inherited from ​

IDisposable.[EventMapType]


disposed ​

readonly disposed: boolean

Defined in: libs/base/dist/index.d.ts:6096

Inherited from ​

IDisposable.disposed

Methods ​

on() ​

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:592

Sets up a function that will be called whenever the specified event is delivered to the target

Type Parameters ​

K ​

K extends "dispose"

Parameters ​

type ​

K

The event type to listen for

listener ​

EventListener<{ dispose: []; }, K>

The callback function

context? ​

unknown

Context object of the listener function

Returns ​

void

Inherited from ​

IDisposable.on


once() ​

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:599

Sets up a function that will be called only once when the specified event is delivered to the target

Type Parameters ​

K ​

K extends "dispose"

Parameters ​

type ​

K

The event type to listen for

listener ​

EventListener<{ dispose: []; }, K>

The callback function

context? ​

unknown

Context object of the listener function

Returns ​

void

Inherited from ​

IDisposable.once


off() ​

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:605

Removes an event listener function previously registered.

Type Parameters ​

K ​

K extends "dispose"

Parameters ​

type ​

K

The event type for which to remove an event listener

listener? ​

EventListener<{ dispose: []; }>

The callback function to be removed

context? ​

unknown

Returns ​

void

Inherited from ​

IDisposable.off


dispatchEvent() ​

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:611

Synchronously invoke the affected event listeners with an event object

Type Parameters ​

K ​

K extends "dispose"

Parameters ​

type ​

K

args ​

...object[K]

Returns ​

void

false if the event was canceled, otherwise true

Inherited from ​

IDisposable.dispatchEvent


dispose() ​

dispose(): void

Defined in: libs/base/dist/index.d.ts:6095

Returns ​

void

Inherited from ​

IDisposable.dispose


render() ​

render(): void

Defined in: libs/scene/src/app/engine.ts:39

Returns ​

void

Released under the MIT License.