API reference
Preparing search index…

Native-owned Rml::Box value with writable shared numerical fields.

Element queries copy the box. Changes take effect on an element only through setBox or addBox. Views retain this value, never an element or runtime. Use finite values; native queries and element setters reject non-finite shared fields. Negative margins retain their upstream meaning.

Source & inheritance
Member directory16

Constructors

Properties

Accessors

Methods

Constructors

Properties

numAreas: number = native.boxNumAreas

Rml::Box::num_areas: three outer areas, excluding content.

Source & inheritance
numEdges: number = native.boxNumEdges

Rml::Box::num_edges: four edges per area.

Source & inheritance

Accessors

  • get content(): Float32Array

    Shared content size in x, y order.

    Returns

    Float32Array

    Writable native view, retained independently of this wrapper.

    Source & inheritance
  • get edges(): Float32Array

    Shared edges: Margin, Border, Padding; each Top, Right, Bottom, Left.

    Returns

    Float32Array

    Twelve writable floats; index is area * 4 + edge.

    Source & inheritance

Methods

  • Native Rml::Box equality, including exact edge bits.

    Parameters

    other

    Box to compare.

    Returns

    boolean

    Native operator== result.

    Source & inheritance
  • Sum edges from Margin inward through area, using GetCumulativeEdge.

    Parameters

    area

    Last included area; Content includes through Padding.

    edge

    Side to sum.

    Returns

    number

    Cumulative edge size.

    Source & inheritance
  • Rml::Box::GetSizeAcross over an inclusive range of areas.

    Parameters

    direction

    Horizontal or vertical axis.

    area

    Outermost included area.

    areaEnd
    BoxArea = BoxArea.Content

    Innermost included area; defaults to Content.

    Returns

    number

    Size along the selected axis.

    Source & inheritance
  • Native Rml::Box inequality.

    Parameters

    other

    Box to compare.

    Returns

    boolean

    Native operator!= result.

    Source & inheritance

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