Documentation / @ripl/core / Renderer

Class: Renderer

Defined in: packages/core/src/core/renderer.ts:177

Drives the animation loop via requestAnimationFrame, managing per-element transitions and rendering the scene each frame.

Extends

• EventBus<RendererEventMap>

Constructors

Constructor

new Renderer(scene, options?): Renderer

Defined in: packages/core/src/core/renderer.ts:201

Parameters

Parameter	Type
scene	Scene
options?	RendererOptions

Returns

Renderer

Overrides

EventBus.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
autoStart	public	boolean	true	Whether the renderer starts its animation loop automatically on construction.	-	packages/core/src/core/renderer.ts:192
autoStop	public	boolean	true	Whether the renderer stops the loop when idle — no active transitions and the pointer has left.	-	packages/core/src/core/renderer.ts:194
parent?	public	EventBus<RendererEventMap>	undefined	The parent event bus that emitted events bubble up to, if any.	EventBus.parent	packages/core/src/core/event-bus.ts:89
defaultKey	readonly	typeof defaultKey	undefined	The key under which resources are retained when no explicit key is provided.	EventBus.defaultKey	packages/core/src/core/disposer.ts:11

Accessors

isBusy

Get Signature

get isBusy(): boolean

Defined in: packages/core/src/core/renderer.ts:197

Whether there are any active transitions in progress.

Returns

boolean

Methods

destroy()

destroy(): void

Defined in: packages/core/src/core/renderer.ts:589

Stops the renderer and destroys all event subscriptions.

Returns

void

Overrides

EventBus.destroy

---

dispose()

protected dispose(key?): void

Defined in: packages/core/src/core/disposer.ts:25

Disposes all resources under the given key, or all resources if no key is provided.

Parameters

Parameter	Type
key?	PropertyKey

Returns

void

Inherited from

EventBus.dispose

---

emit()

Call Signature

emit<TEvent>(event): TEvent

Defined in: packages/core/src/core/event-bus.ts:137

Emits an event, invoking all matching handlers and bubbling to the parent if applicable.

Type Parameters

Type Parameter	Default type
TEvent extends Event<undefined>	Event<undefined>

Parameters

Parameter	Type
event	TEvent

Returns

TEvent

Inherited from

EventBus.emit

Call Signature

emit<TEvent>(type, data): Event<RendererEventMap[TEvent]>

Defined in: packages/core/src/core/event-bus.ts:138

Emits an event, invoking all matching handlers and bubbling to the parent if applicable.

Type Parameters

Type Parameter
TEvent extends keyof RendererEventMap

Parameters

Parameter	Type
type	TEvent
data	RendererEventMap[TEvent]

Returns

Event<RendererEventMap[TEvent]>

Inherited from

EventBus.emit

---

has()

has(type): boolean

Defined in: packages/core/src/core/event-bus.ts:94

Returns whether there are any listeners registered for the given event type.

Parameters

Parameter	Type
type	keyof RendererEventMap

Returns

boolean

Inherited from

EventBus.has

---

off()

off<TEvent>(type, handler): void

Defined in: packages/core/src/core/event-bus.ts:112

Removes a previously registered handler for the given event type.

Type Parameters

Type Parameter
TEvent extends keyof RendererEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<RendererEventMap[TEvent]>

Returns

void

Inherited from

EventBus.off

---

on()

on<TEvent>(type, handler, options?): Disposable

Defined in: packages/core/src/core/event-bus.ts:99

Subscribes a handler to the given event type and returns a disposable for cleanup.

Type Parameters

Type Parameter
TEvent extends keyof RendererEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<RendererEventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

EventBus.on

---

once()

once<TEvent>(type, handler, options?): Disposable

Defined in: packages/core/src/core/event-bus.ts:127

Subscribes a handler that is automatically removed after it fires once.

Type Parameters

Type Parameter
TEvent extends keyof RendererEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<RendererEventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

EventBus.once

---

retain()

protected retain(value, key?): void

Defined in: packages/core/src/core/disposer.ts:14

Registers a disposable resource under an optional key for later cleanup.

Parameters

Parameter	Type	Default value
value	Disposable	undefined
key	PropertyKey	Disposer.defaultKey

Returns

void

Inherited from

EventBus.retain

---

start()

start(): void

Defined in: packages/core/src/core/renderer.ts:398

Starts the animation loop if it is not already running.

Returns

void

---

stop()

stop(): void

Defined in: packages/core/src/core/renderer.ts:415

Stops the animation loop, cancels pending frames, and clears all transitions.

Returns

void

---

transition()

transition<TElement>(element, options?): Transition

Defined in: packages/core/src/core/renderer.ts:440

Schedules an animated transition for one or more elements, returning a Transition that resolves when all complete.

Type Parameters

Type Parameter
TElement extends Element<Partial<BaseState>, ElementEventMap>

Parameters

Parameter	Type
element	OneOrMore<TElement>
options?	RendererTransitionOptionsArg<TElement>

Returns

Transition