Docsv3.4.0
Back to API Reference
Class

InlineMedia

abstract

Common entry-data base for inline-flowed media (InlineSprite, InlineObject). Carries the name and shared presentation data; the renderable payload is added by the concrete subclass.

Remarks

Pure shared data: one entry may be referenced by many components at once (e.g. through a shared UniTextSprites asset), so it holds no per-occurrence runtime state — the host InlineMediaModifier<TEntry, TWrapper> owns a wrapper pool per component. All metrics are in em units (relative to fontSize): size = (1,1) means the media is fontSize x fontSize pixels advance = 1 means the cursor moves by fontSize pixels after this media bearingOffset shifts the media relative to fontSize pivot uses normalized RectTransform coordinates and rotation uses degrees. These presentation values are the weakest layer; keyed overrides, default parameters, and tag attributes can replace them per occurrence.

Derived Types(2)

Types that inherit from InlineMedia.

C
InlineObject
Defines an inline object (UI prefab) that can be embedded within text flow.
C
InlineSprite
Defines an inline sprite that can be embedded within text flow.
public string Name{ get; set }

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

public Vector2 Size{ get; set }

Size in em units (1 = fontSize on each axis).

public Vector2 BearingOffset{ get; set }

Offset from the layout position in em units.

public Vector2 Pivot{ get; set }

Normalized rotation pivot; (0,0) is bottom-left and (1,1) is top-right.

public float Rotation{ get; set }

Z-axis rotation in degrees around Pivot.

public float Advance{ get; set }

Advance width in em units (1 = fontSize).

public float LineHeightAbove{ get; set }

Extra height reserved above lines containing this media, in em units.

public float LineHeightBelow{ get; set }

Extra height reserved below lines containing this media, in em units.

Back to API Reference