Schemas / I/O

rig.input.pointer

v1.0.0 · stable maturity: draft 5 fields 2 required

Fields

FieldTypeMeaning
player int optional Optional. Player index (0-based); absent = 0
x number0 – 1 required Horizontal position, 0-1 across the viewport
y number0 – 1 required Vertical position, 0-1 down the viewport
primary bool optional Optional. Primary button level; absent = false
secondary bool optional Optional. Secondary button level; absent = false

Logical pointer for one player. Format when present.

x and y are ratios of the host viewport, not scene lengths. Press and release edges stay in the host. Device mapping is rig.input.binding.

JSON Schema

Resolves at https://rig.works/schemas/rig.input.pointer.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.input.pointer.schema.json",
  "title": "rig.input.pointer",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "player": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "x": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "y": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "primary": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "secondary": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  },
  "required": [
    "x",
    "y"
  ],
  "x-rig-maturity": "draft"
}

Seen in

play-scene.json