Interface RendererClassEntry<P>

Renderer entry that provides a class to be instantiated by the layer. The layer passes its own width and height to the constructor, so the renderer's buffers always match the frame it will process.

Prefer the rendererEntry helper over a raw object literal — it infers P from the class so the compiler can catch excess / wrong-type params.

interface RendererClassEntry<P> {
    id: string;
    rendererClass: (new (width, height, params?) => LayerRenderer<never>);
    params?: P;
    active?: boolean;
}

Type Parameters

  • P = unknown

Properties

id rendererClass params? active?

Properties

id

id: string

Unique identifier for this renderer within the layer.

rendererClass

rendererClass: (new (width, height, params?) => LayerRenderer<never>)

The renderer class to instantiate.

Type declaration

Optional params

params?: P

Optional params forwarded to the renderer constructor.

Optional active

active?: boolean

Whether the renderer is initially active in the render queue. Default: true.

Settings

Member Visibility

Theme

On This Page

idrendererClassparamsactive