Documentation / @ripl/core / Renderer
Class: Renderer ​
Defined in: packages/core/src/core/renderer.ts:185
Drives the animation loop via requestAnimationFrame, managing per-element transitions and rendering the scene each frame.
Extends ​
Constructors ​
Constructor ​
new Renderer(
scene,options?):Renderer
Defined in: packages/core/src/core/renderer.ts:234
Parameters ​
| Parameter | Type |
|---|---|
scene | Scene |
options? | RendererOptions |
Returns ​
Renderer
Overrides ​
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:200 |
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:202 |
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:107 |
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 ​
$events ​
Get Signature ​
get $events(): keyof
RendererEventMap[]
Defined in: packages/core/src/core/renderer.ts:210
The event types a renderer can emit. See EventBus.$events.
Returns ​
keyof RendererEventMap[]
Overrides ​
debug ​
Get Signature ​
get debug():
Required<RendererDebugOptions>
Defined in: packages/core/src/core/renderer.ts:225
The resolved debug overlay options currently in effect. Assigning a new value (true for all overlays, false for none, or a partial RendererDebugOptions object) replaces the full set; unspecified flags reset to their defaults, matching the constructor's debug option semantics.
Returns ​
Required<RendererDebugOptions>
Set Signature ​
set debug(
value):void
Defined in: packages/core/src/core/renderer.ts:229
Parameters ​
| Parameter | Type |
|---|---|
value | boolean | RendererDebugOptions |
Returns ​
void
isBusy ​
Get Signature ​
get isBusy():
boolean
Defined in: packages/core/src/core/renderer.ts:205
Whether there are any active transitions in progress.
Returns ​
boolean
Methods ​
destroy() ​
destroy():
void
Defined in: packages/core/src/core/renderer.ts:643
Stops the renderer and destroys all event subscriptions.
Returns ​
void
Overrides ​
dispose() ​
protecteddispose(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 ​
emit() ​
Call Signature ​
emit<
TEvent>(event):TEvent
Defined in: packages/core/src/core/event-bus.ts:185
Emits an event, invoking all matching handlers and bubbling to the parent if applicable. Handlers for the event's own type run first, then EVENT_WILDCARD subscriptions.
Type Parameters ​
| Type Parameter | Default type |
|---|---|
TEvent extends Event<undefined> | Event<undefined> |
Parameters ​
| Parameter | Type |
|---|---|
event | TEvent |
Returns ​
TEvent
Inherited from ​
Call Signature ​
emit<
TEvent>(type,data):Event<RendererEventMap[TEvent]>
Defined in: packages/core/src/core/event-bus.ts:186
Emits an event, invoking all matching handlers and bubbling to the parent if applicable. Handlers for the event's own type run first, then EVENT_WILDCARD subscriptions.
Type Parameters ​
| Type Parameter |
|---|
TEvent extends keyof RendererEventMap |
Parameters ​
| Parameter | Type |
|---|---|
type | TEvent |
data | RendererEventMap[TEvent] |
Returns ​
Event<RendererEventMap[TEvent]>
Inherited from ​
has() ​
has(
type):boolean
Defined in: packages/core/src/core/event-bus.ts:123
Returns whether there are any listeners registered for the given event type. Wildcard subscriptions (EVENT_WILDCARD) are not listeners for any concrete type, so a bus observed only through the wildcard still reports false here.
Parameters ​
| Parameter | Type |
|---|---|
type | keyof RendererEventMap |
Returns ​
boolean
Inherited from ​
off() ​
off<
TEvent>(type,handler):void
Defined in: packages/core/src/core/event-bus.ts:144
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 ​
on() ​
on<
TEvent>(type,handler,options?):Disposable
Defined in: packages/core/src/core/event-bus.ts:131
Subscribes a handler to the given event type and returns a disposable for cleanup. Pass EVENT_WILDCARD to receive every event emitted on the bus regardless of type.
Type Parameters ​
| Type Parameter |
|---|
TEvent extends keyof RendererEventMap |
Parameters ​
| Parameter | Type |
|---|---|
type | TEvent |
handler | EventHandler<RendererEventMap[TEvent]> |
options? | EventSubscriptionOptions |
Returns ​
Inherited from ​
once() ​
once<
TEvent>(type,handler,options?):Disposable
Defined in: packages/core/src/core/event-bus.ts:159
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 ​
Inherited from ​
retain() ​
protectedretain(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 ​
start() ​
start():
void
Defined in: packages/core/src/core/renderer.ts:453
Starts the animation loop if it is not already running.
Returns ​
void
stop() ​
stop():
void
Defined in: packages/core/src/core/renderer.ts:470
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:495
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> |