Schemas / Media

rig.media.text

v0.31.0 · draft 6 fields 1 required

Fields

FieldTypeMeaning
text string required Content
font entity optional Optional. rig.media.asset_ref with kind font; absent = host default face
fontSize float optional Optional. Point or pixel size as the host documents; absent = host default
axes array<object> optional Optional. OpenType variable-font axis values; absent = font defaults
features string optional Optional. Comma-separated OpenType feature tags (e.g. liga,ss01); absent = host default
useKerning bool optional Optional. Apply kerning; absent = true

Scene / canvas text run. Format when present.

Editorial copy (named styles, paragraphs, runs, tables) is rig.story.flow, not this schema. Do not flatten a story into canvas runs.

An editable UFO source face is rig.font.face - do not put outlines, kern pairs, or glyph names on this schema. font here is a compiled rig.media.asset_ref.

Appearance: rig.paint.fill_stroke or rig.paint.fill on the same entity - do not re-declare colour here. Absent paint means host default (typically black).

Axis

Face handles, glyph caches, and GPU atlases stay in the host.

JSON Schema

Resolves at https://rig.works/schemas/rig.media.text.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.media.text.schema.json",
  "title": "rig.media.text",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "text": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "font": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "fontSize": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "axes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "tag",
          "value"
        ],
        "properties": {
          "tag": {
            "$ref": "./_defs.schema.json#/$defs/uint32"
          },
          "value": {
            "$ref": "./_defs.schema.json#/$defs/float"
          }
        }
      }
    },
    "features": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "useKerning": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  },
  "required": [
    "text"
  ]
}