GlyphQuad

A specialized Quad that represents a single rendered glyph (character) in text rendering.

GlyphQuad extends Quad to add text-specific metadata and tracking information. Each instance represents one visible character in a Text display, containing both the visual representation (texture from the font atlas) and metadata about the character's position within the text.

This class is primarily used internally by the Text class for efficient glyph management, pooling, and event handling. Each glyph can be individually positioned, styled, and tracked.

// Typically created internally by Text, but can be accessed:
text.onGlyphQuadsChange(this, (glyphQuads) -> {
    for (quad in glyphQuads) {
        trace('Character ${quad.char} at position ${quad.index}');
        trace('Line ${quad.line}, position in line: ${quad.posInLine}');
    }
});

Instance Members #

The character string this quad represents.

Usually a single character, but can be multiple characters for ligatures or composed characters. Null if the quad is not active.

Reference to the bitmap font character data.

Contains texture coordinates, metrics, and other rendering information for this specific glyph from the font atlas.

The absolute character index in the source text.

This is the position of the character in the original text string, starting from 0. Useful for mapping glyphs back to text positions. Set to -1 when the quad is not active.

The character's position within its line.

Zero-based index indicating this character's position on the current line of text. Resets to 0 at the start of each new line. Set to -1 when the quad is not active.

The line number this character appears on.

Zero-based line index for multi-line text. Increments with each line break in the rendered text. Set to -1 when the quad is not active.

The Unicode code point of the character.

The numeric representation of the character (e.g., 65 for 'A'). Useful for character-specific logic or debugging. Set to -1 when the quad is not active.

The x-coordinate where this glyph starts in text layout.

This is the horizontal position where the glyph begins, before applying any character-specific offsets. In the text's local coordinate space. Set to -1 when the quad is not active.

The y-coordinate where this glyph starts in text layout.

This is the vertical position (baseline) where the glyph is placed, before applying any character-specific offsets. In the text's local coordinate space. Set to -1 when the quad is not active.

The horizontal advance width for this glyph.

The distance to advance the cursor after rendering this character, including the character width and spacing. Does not include kerning with the next character. Set to -1 when the quad is not active.

Clears this glyph quad and prepares it for reuse.

Emits the clear event before calling the parent clear method, allowing listeners to perform cleanup. This is typically called when the quad is returned to a pool or when text content changes.

Private Members #

Event triggered when this glyph quad is cleared or recycled.

This event fires before the quad is returned to the pool or destroyed, allowing cleanup of any references or custom data attached to the glyph.

Returns a string representation of this GlyphQuad for debugging.

Includes the character, index, line number, and position information in a compact format suitable for logging or debugging text layout issues.

Metadata #