API reference
Preparing search index…

ElementUtilities

Checked static Rml::ElementUtilities operations.

Source & inheritance
Member directory13

Methods

Methods

  • Construct data views/controllers from attributes under an active model.

    Parameters

    element

    Target.

    Returns

    boolean

    True if constructed; false when no model or binding applies.

    Source & inheritance
  • Build an owned box snapshot without setting the target's box.

    Parameters

    containingBlock

    Finite nonnegative containing dimensions.

    element

    Target.

    inlineElement
    boolean = false

    Use native inline sizing; default false.

    Returns

    Independent mutable box.

    Source & inheritance
  • Generate the native scissor and optional owned mask snapshots.

    Parameters

    element

    Target; mask output requires an attached context.

    includeClipMask
    boolean = false

    Request masks; defaults to false.

    forceClipSelf
    boolean = false

    Include the target's border area; default false.

    Returns

    Region and masks; geometry stays valid until release or shutdown.

    Source & inheritance
  • Search descendants breadth-first; stop-tag nodes are still checked.

    Parameters

    root

    Root excluded from matching.

    tag
    string

    Exact tag.

    stopTag
    string = ''

    Do not enter its descendants; defaults to empty.

    Returns

    Snapshot of live wrappers.

    Source & inheritance
  • Measure UTF-8 text with the element's font and shaping context.

    Parameters

    element

    Font source.

    text
    string

    Text to measure.

    priorCharacter
    number = 0

    Preceding Unicode scalar for kerning; default 0.

    Returns

    number

    Integer pixel width; zero when no native font is selected.

    Source & inheritance
  • Submit clipping from the element and its ancestors to the render manager.

    Parameters

    element

    Target.

    forceClipSelf
    boolean = false

    Include target border area; default false.

    Returns

    boolean

    Native visibility result; false without a context.

    Source & inheritance

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