Schemas / Other

rig.vr.eye

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

Fields

FieldTypeMeaning
side enumleft · right required left, right
headset entity optional Optional. rig.vr.headset. Absent = the player's only headset

One eye of a stereo view. Format when present.

Projection is rig.spatial.camera. Pose is rig.spatial.transform, parented to the head rig.vr.tracker with rig.spatial.relationship. Off-axis frustums use the camera's leftDegrees / rightDegrees / upDegrees / downDegrees.

Left is −X from the head in the 3D axes (document.md). The eye looks along local −Z.

A depth image on this view is rig.sensor.depth on the same entity. The depth buffer stays in the host.

JSON Schema

Resolves at https://rig.works/schemas/rig.vr.eye.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.vr.eye.schema.json",
  "title": "rig.vr.eye",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "side": {
      "type": "string",
      "enum": [
        "left",
        "right"
      ]
    },
    "headset": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "side"
  ],
  "x-rig-maturity": "draft"
}

Seen in

vr-room.json