API reference
Preparing search index…

Rml::MeshUtilities with Native geometry generation and batch submission.

Operations append in order. Native reserves storage once per batch, retaining previous exported views in old storage. Without retained views, append reuses the mesh and grows capacity geometrically.

Source & inheritance
Member directory7

Properties

Methods

Properties

commandStride: 40 = commandStride

Number of float32 fields per command, including reserved fields.

Source & inheritance

Methods

  • Allocate zeroed Native-owned records for direct shared writes.

    Parameters

    count
    number

    Command capacity.

    Returns

    Float32Array

    Writable records, retained independently of runtime lifetime.

    Source & inheritance
  • Submit command records once; validation precedes all geometry writes.

    Parameters

    mesh

    Owned mesh receiving appended geometry.

    commands
    Float32Array

    Complete command records.

    countOptional
    number

    Prefix to execute; defaults to all records.

    Returns

    void

    Each record contains 40 floats. Field 0 selects quad=0, line=1, background=2 or background-border=3. Quad/line fields 1–4 are x,y,width, height; 5–8 are premultiplied RGBA. Quad fields 9–12 are u0,v0,u1,v1. Background fields 1–12 are fill x/y, border offset x/y, four widths and four radii in RenderBox order; 13–16 are background RGBA. Border fields 17–32 contain four RGBA colours in top/right/bottom/left order. Remaining fields are reserved and ignored. Buffers cannot be detached or backed by concurrently shared memory.

    Source & inheritance
  • Append a native quad with optional texture coordinates.

    Parameters

    mesh

    Destination mesh.

    origin

    Quad origin.

    dimensions

    Quad size.

    colour

    Premultiplied RGBA bytes.

    topLeftTexcoord
    { x: number; y: number } = ...

    Top-left UV, default (0,0).

    • x: number

      U texture coordinate at the top-left corner.

    • y: number

      V texture coordinate at the top-left corner.

    bottomRightTexcoord
    { x: number; y: number } = ...

    Bottom-right UV, default (1,1).

    • x: number

      U texture coordinate at the bottom-right corner.

    • y: number

      V texture coordinate at the bottom-right corner.

    Returns

    void
    Source & inheritance

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