Schemas / Pixel / raster

`rig.pixel.layer`

v0.31.0 · draft 9 fields 1 required

Fields

Field	Type		Meaning
`kind`	enumvector · overlay-image · solid · group	required	vector, overlay-image, solid, group
`image`	entity	optional	Overlay `rig.media.asset_ref` when kind needs it
`rgba`	rgba	optional	Solid fill; required when `kind=solid`
`maskSource`	enumnone · luma · alpha · path	optional	Optional. none, luma, alpha, path; absent = none
`maskAsset`	entity	optional	Luma image asset when `maskSource=luma`
`maskLayer`	entity	optional	Alpha source layer when `maskSource=alpha`
`maskPathEntity`	entity	optional	Path entity when `maskSource=path`
`invertMask`	bool	optional	Optional. Invert mask; absent = false
`groupParent`	entity	optional	Optional. Compositor group parent; absent or none = root

Compositor stack entry. Format when present.

Chrome (order, locked, tint, label) lives on rig.spatial.layer + rig.meta.named on the same entity. Show/hide is rig.render.visibility. Blend and opacity are rig.render.blend. Do not duplicate those fields here.

groupParent is not parent on rig.spatial.relationship - different graph.

Rasters: raster.md.

JSON Schema

Resolves at https://rig.works/schemas/rig.pixel.layer.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.pixel.layer.schema.json",
  "title": "rig.pixel.layer",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "vector",
        "overlay-image",
        "solid",
        "group"
      ]
    },
    "image": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "rgba": {
      "$ref": "./_defs.schema.json#/$defs/rgba"
    },
    "maskSource": {
      "type": "string",
      "enum": [
        "none",
        "luma",
        "alpha",
        "path"
      ]
    },
    "maskAsset": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "maskLayer": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "maskPathEntity": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "invertMask": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "groupParent": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "kind"
  ]
}