Docsv2.2.5
Back to API Reference
Class

InlineMedia

abstract

Common entry-data base for inline-flowed media (InlineSprite, InlineObject). Carries the name and layout metrics that both shape (advance, bearing) and rendering (width, height) need; the renderable payload is added by the concrete subclass.

Remarks

All metrics are in em units (relative to fontSize): width=1, height=1 means the media is fontSize x fontSize pixels advance=1 means the cursor moves by fontSize pixels after this media bearingX/bearingY are offsets relative to fontSize
public void UpdateInstances()

Trims excess wrappers when fewer occurrences are active than instances exist, then runs Setup on every remaining instance to apply pending transform/content updates. Called per frame after the mesh rebuild.

public string name

Lookup name used in the tag parameter (e.g. jump in <sprite=jump>). Case-insensitive.

public float width

Width in em units (1 = fontSize).

public float height

Height in em units (1 = fontSize).

public float bearingX

Horizontal offset in em units.

public float bearingY

Vertical offset in em units.

public float advance

Advance width in em units (1 = fontSize).

public int activeCount

Number of on-screen occurrences claimed in the current rebuild pass; reset to 0 on every rebuild start.

Back to API Reference