API reference
Preparing search index…

FontEffectCallbacks

Synchronous native Rml::FontEffect virtual overrides.

interface FontEffectCallbacks {
    generateGlyphTexture(
        destination: Uint8Array,
        dimensions: VariantVector2,
        stride: number,
        glyph: FontGlyph,
    ): void;
    getGlyphMetrics(
        glyph: FontGlyph,
        origin: VariantVector2,
        dimensions: VariantVector2,
    ): FontGlyphMetrics;
    hasUniqueTexture(): boolean;
}
Source & inheritance
Member directory3

Methods

Methods

  • Rml::FontEffect::GenerateGlyphTexture; omitted callbacks do nothing.

    Parameters

    destination
    Uint8Array

    Writable premultiplied RGBA scratch view.

    dimensions

    Destination glyph dimensions.

    stride
    number

    Original row stride in bytes.

    glyph

    Owned source snapshot.

    Returns

    void

    The buffer is native-owned scratch storage. Only RGBA row pixels are committed on successful return; padding is isolated and initialized to zero. Retained views never reference the destination or the font atlas.

    Source & inheritance
  • Rml::FontEffect::HasUniqueTexture; omitted callbacks return false.

    Returns

    boolean

    Whether to generate a separate glyph texture.

    Source & inheritance

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