pixi-reels

FrameAPI

pixi-reels


pixi-reels / index / FrameAPI

Interface: FrameAPI

Defined in: core/ReelSet.ts:61

The runtime-mutable frame-builder pipeline exposed on reelSet.frame. Matches FrameBuilder.use/remove. the internal machinery that already exists; this is the ergonomic surface.

Properties#

PropertyModifierTypeDescriptionDefined in
middlewarereadonlyreadonly FrameMiddleware[]Current middleware list in registration order.core/ReelSet.ts:67

Methods#

remove()#

remove(name: string): void;

Defined in: core/ReelSet.ts:65

Remove a middleware by name. No-op if absent.

Parameters#

ParameterType
namestring

Returns#

void


use()#

use(middleware: FrameMiddleware): void;

Defined in: core/ReelSet.ts:63

Add a middleware. Sorted by priority on next frame build.

Parameters#

ParameterType
middlewareFrameMiddleware

Returns#

void