API reference
Preparing search index…

DecoratorCallbacks<Data>

Synchronous Rml::Decorator virtual functions with host-owned element data.

interface DecoratorCallbacks<Data extends object = object> {
    generateElementData(element: Element, paintArea: BoxArea): null | Data;
    releaseElementData(data: Data): void;
    renderElement(element: Element, data: Data): void;
}

Type Parameters

  • Data extends object = object

    Per-element data object shared by the callbacks.

Source & inheritance
Member directory3

Methods

Methods

  • Create data for one decorated element; null disables its rendering.

    Parameters

    element

    Element receiving this decorator.

    paintArea

    Concrete native paint area.

    Returns

    null | Data

    Data object, or null for INVALID_DECORATORDATAHANDLE.

    Source & inheritance
  • Release per-element resources at a safe runtime boundary.

    Parameters

    data

    Original data; the element may already have been destroyed.

    Returns

    void

    Explicit release guarantees the callback. GC queues release until the next runtime call, and skips callbacks whose data or closures were collected. Explicit release is required for deterministic cleanup.

    Source & inheritance
  • Render using the unchanged object returned by generateElementData.

    Parameters

    element

    Element being rendered.

    data

    Original per-element object.

    Returns

    void
    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0