Schemas / Pixel / raster

rig.pixel.mask_path

v0.31.0 · draft 4 fields 0 required

Fields

FieldTypeMeaning
strokeWidth float optional Optional. Canvas-px stroke; absent = 16
closed bool optional Optional. Absent = true
filled bool optional Optional. Absent = true
xy array<float> optional Packed x,y pairs in canvas pixels

Polygon used as a compositor mask.

Prefer composing rig.geometry.path when the contour is a real command stream. This schema is the host bag when the polygon is still a packed xy[].

Compose rig.meta.named for the label.

JSON Schema

Resolves at https://rig.works/schemas/rig.pixel.mask_path.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.pixel.mask_path.schema.json",
  "title": "rig.pixel.mask_path",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "strokeWidth": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "closed": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "filled": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "xy": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/float"
      }
    }
  }
}