Schemas / Geometry / paint

rig.paint.mask

v1.0.0 · stable maturity: stable 2 fields 1 required

Fields

FieldTypeMeaning
source entity required Path, group, or image used as the mask
channel enumluminance · alpha optional Optional. luminance or alpha. Absent = luminance

Mask a drawable with another graphic. Format when present.

Compose on the drawable. The source stays on its own entity. A path clip (hard inside / outside) is rig.paint.clip.

JSON Schema

Resolves at https://rig.works/schemas/rig.paint.mask.schema.json — raw file. 

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.paint.mask.schema.json",
  "title": "rig.paint.mask",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "source": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "channel": {
      "type": "string",
      "enum": [
        "luminance",
        "alpha"
      ]
    }
  },
  "required": [
    "source"
  ],
  "x-rig-maturity": "stable"
}