Schemas / Meta / render

`rig.render.sprite`

v1.0.0 · stable maturity: draft 7 fields 1 required

Fields

Field	Type		Meaning
`texture`	entity	required	`rig.media.asset_ref`
`tiling`	vec2	optional	Optional. Texture repeats across the quad; absent = 1, 1
`flipX`	bool	optional	Optional. Mirror in local X; absent = false
`flipY`	bool	optional	Optional. Mirror in local Y; absent = false
`frame`	uint	optional	Optional. Frame index in a sheet; absent = 0
`columns`	uint	optional	Optional. Sheet columns. Required when `rows` is set
`rows`	uint	optional	Optional. Sheet rows. Required when `columns` is set

A textured quad in the entity's plane. Format when present. Colour is paint on the same entity (rig.paint.fill or rig.paint.fill_stroke), not a second colour here.

Pose and size are rig.spatial.transform. A single tiling factor writes the same number in both components of tiling. Sheet frames are columns by rows, row-major, index frame.

JSON Schema

Resolves at https://rig.works/schemas/rig.render.sprite.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.render.sprite.schema.json",
  "title": "rig.render.sprite",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "texture": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "tiling": {
      "$ref": "./_defs.schema.json#/$defs/vec2"
    },
    "flipX": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "flipY": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "frame": {
      "$ref": "./_defs.schema.json#/$defs/uint"
    },
    "columns": {
      "$ref": "./_defs.schema.json#/$defs/uint"
    },
    "rows": {
      "$ref": "./_defs.schema.json#/$defs/uint"
    }
  },
  "required": [
    "texture"
  ],
  "x-rig-maturity": "draft"
}

Seen in

play-scene.json