Custom Data ABI v1
Behavior and constraints
Manifest v5 only, with customData.abiVersion=1. Variable id/type/frequency/default/onError/expression is explicit; applicable unit/space must agree with inputs. Types are bool, int, uint, float, vec2/3/4 and mat3/4. Floating lanes must be finite. int/uint retain exact 32-bit words without a float conversion. bool uses 0/1 and matrices use 9/16 column-major float32 lanes.
The full Schema expands seven expression forms: typed literal, ref, input/version, option/as/map, materialProperty/material, call/args and select/whenTrue/whenFalse. Use published input IDs and function names/arities from Catalog. References must be acyclic with compatible types, units, spaces and frequencies. generation/frame/view cannot be slower than their dependencies. Implicit casts, component multiplication and matrixMultiply are different operations.
All branches and unused variables participate in raw AST, reference-depth and budget validation before constant folding. Limits include 256 variables, 4096 AST nodes, depth 64 and 128 custom bindings per command. Weighted operations are generation 32768 and frame/view 8192 each. Materials additionally limits definitions to 4096, properties to 32, tags to 64, groups to 1024 and mappings to 4096. Pack configuration cannot enlarge host budgets.
onError v1 supports useDefault only, requiring a finite, exactly typed default. customBindings symbol/variable connects a declared variable. required=false only permits driver optimization of the declaration; it does not permit type errors, arrays or cross-owner symbol/location collisions. Offline runtimeEvaluated=false describes analysis rather than actual evaluation.
The pinned completion registers 23 version-one inputs. The older guide's list of 11 is incomplete. Logical projection_matrix differs from actual render_projection_matrix; previous_* comes from successful commits of the same main view. history_valid does not replace GPU-history validity. Unavailable differs from available-but-invalid. Render delta is valid only up to 0.25 seconds and must be paired with its valid flag; that older delta contract differs from full temporal history. The machine temporal document retains an early runtimeReady=false, while the current completion and later integration documentation include Providers. Interpret their dates and evidence domains separately.
Temporal extent and jitter use physical pixels, with zero jitter before opt-in. Positions use world blocks; matrix source/target spaces are listed individually. Auxiliary cameras, split-screen and VR do not share this main-view timeline. These references add no temporal game or performance acceptance claim.
Generated v5 structure
Required applies to the displayed object/branch. Absence of a Schema default does not establish a runtime default. Conditional rules remain in the complete definition below; Loader validation also resolves IDs, ownership, budgets and device limits.
customData · v5
| Field / branch | Presence in this object | Structural constraints |
|---|---|---|
abiVersion | required | const=1 |
variables | optional here | type="array"; maxItems=256; items=#/$defs/customVariable |
Full structural rule: #/$defs/customData
{
"additionalProperties": false,
"properties": {
"abiVersion": {
"const": 1
},
"variables": {
"items": {
"$ref": "#/$defs/customVariable"
},
"maxItems": 256,
"type": "array"
}
},
"required": [
"abiVersion"
],
"type": "object"
}customVariable · v5
| Field / branch | Presence in this object | Structural constraints |
|---|---|---|
default | required | — |
expression | required | $ref="#/$defs/dataExpression" |
frequency | required | enum=["generation","frame","view"] |
id | required | $ref="#/$defs/dataId" |
onError | required | const="useDefault" |
space | optional here | $ref="#/$defs/nonEmptyString" |
type | required | enum=["bool","int","uint","float","vec2","vec3","vec4","mat3","mat4"] |
unit | optional here | $ref="#/$defs/nonEmptyString" |
Full structural rule: #/$defs/customVariable
{
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "bool"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "int"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "uint"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "float"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "vec2"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "vec3"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "vec4"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "mat3"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 9,
"minItems": 9,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "mat4"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
}
}
}
}
],
"properties": {
"default": {},
"expression": {
"$ref": "#/$defs/dataExpression"
},
"frequency": {
"enum": [
"generation",
"frame",
"view"
]
},
"id": {
"$ref": "#/$defs/dataId"
},
"onError": {
"const": "useDefault"
},
"space": {
"$ref": "#/$defs/nonEmptyString"
},
"type": {
"enum": [
"bool",
"int",
"uint",
"float",
"vec2",
"vec3",
"vec4",
"mat3",
"mat4"
]
},
"unit": {
"$ref": "#/$defs/nonEmptyString"
}
},
"required": [
"id",
"type",
"frequency",
"default",
"onError",
"expression"
],
"type": "object"
}dataExpression · v5
| Field / branch | Presence in this object | Structural constraints |
|---|---|---|
oneOf[0].literal | required | — |
oneOf[0].type | required | enum=["bool","int","uint","float","vec2","vec3","vec4","mat3","mat4"] |
oneOf[1].ref | required | $ref="#/$defs/dataId" |
oneOf[2].as | required | enum=["bool","int","uint","float"] |
oneOf[2].map | optional here | type="object" |
oneOf[2].option | required | $ref="#/$defs/dataId" |
oneOf[3].input | required | $ref="#/$defs/dataId" |
oneOf[3].version | required | $ref="#/$defs/positiveVersion" |
oneOf[4].material | required | $ref="#/$defs/dataId" |
oneOf[4].materialProperty | required | $ref="#/$defs/dataId" |
oneOf[5].args | required | type="array"; maxItems=16; items=#/$defs/dataExpression |
oneOf[5].call | required | enum=["length","vec3","greaterEqual","cos","float","mat3","safeNormalize","sin","less","equal","vec4","bool","clamp","matrixMultiply","greater","uint","vec2","div","int","notEqual","sub","or","componentMultiply","sqrt","min","abs","lessEqual","mix","and","add","mat4","dot","not","max","mul"] |
oneOf[6].select | required | $ref="#/$defs/dataExpression" |
oneOf[6].whenFalse | required | $ref="#/$defs/dataExpression" |
oneOf[6].whenTrue | required | $ref="#/$defs/dataExpression" |
Full structural rule: #/$defs/dataExpression
{
"oneOf": [
{
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "bool"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "int"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "uint"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "float"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "vec2"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "vec3"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "vec4"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "mat3"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 9,
"minItems": 9,
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "mat4"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"literal": {
"items": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
}
}
}
}
],
"properties": {
"literal": {},
"type": {
"enum": [
"bool",
"int",
"uint",
"float",
"vec2",
"vec3",
"vec4",
"mat3",
"mat4"
]
}
},
"required": [
"literal",
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"ref": {
"$ref": "#/$defs/dataId"
}
},
"required": [
"ref"
],
"type": "object"
},
{
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"as": {
"const": "bool"
}
},
"required": [
"as"
]
},
"then": {
"properties": {
"map": {
"additionalProperties": {
"type": "boolean"
}
}
}
}
},
{
"if": {
"properties": {
"as": {
"const": "int"
}
},
"required": [
"as"
]
},
"then": {
"properties": {
"map": {
"additionalProperties": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
}
}
}
}
},
{
"if": {
"properties": {
"as": {
"const": "uint"
}
},
"required": [
"as"
]
},
"then": {
"properties": {
"map": {
"additionalProperties": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
}
}
}
},
{
"if": {
"properties": {
"as": {
"const": "float"
}
},
"required": [
"as"
]
},
"then": {
"properties": {
"map": {
"additionalProperties": {
"maximum": 3.4028234663852886e+38,
"minimum": -3.4028234663852886e+38,
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"as": {
"const": "uint"
}
},
"required": [
"as"
]
},
"then": {
"required": [
"map"
]
}
}
],
"properties": {
"as": {
"enum": [
"bool",
"int",
"uint",
"float"
]
},
"map": {
"maxProperties": 256,
"minProperties": 1,
"type": "object"
},
"option": {
"$ref": "#/$defs/dataId"
}
},
"required": [
"option",
"as"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"input": {
"$ref": "#/$defs/dataId"
},
"version": {
"$ref": "#/$defs/positiveVersion"
}
},
"required": [
"input",
"version"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"material": {
"$ref": "#/$defs/dataId"
},
"materialProperty": {
"$ref": "#/$defs/dataId"
}
},
"required": [
"materialProperty",
"material"
],
"type": "object"
},
{
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"call": {
"const": "length"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "vec3"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 3,
"minItems": 3
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "greaterEqual"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "cos"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "float"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "mat3"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 9,
"minItems": 9
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "safeNormalize"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "sin"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "less"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "equal"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "vec4"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 4,
"minItems": 4
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "bool"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "clamp"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 3,
"minItems": 3
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "matrixMultiply"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "greater"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "uint"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "vec2"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "div"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "int"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "notEqual"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "sub"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "or"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "componentMultiply"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "sqrt"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "min"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "abs"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "lessEqual"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "mix"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 3,
"minItems": 3
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "and"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "add"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "mat4"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 16,
"minItems": 16
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "dot"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "not"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 1,
"minItems": 1
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "max"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
},
{
"if": {
"properties": {
"call": {
"const": "mul"
}
},
"required": [
"call"
]
},
"then": {
"properties": {
"args": {
"maxItems": 2,
"minItems": 2
}
}
}
}
],
"properties": {
"args": {
"items": {
"$ref": "#/$defs/dataExpression"
},
"maxItems": 16,
"type": "array"
},
"call": {
"enum": [
"length",
"vec3",
"greaterEqual",
"cos",
"float",
"mat3",
"safeNormalize",
"sin",
"less",
"equal",
"vec4",
"bool",
"clamp",
"matrixMultiply",
"greater",
"uint",
"vec2",
"div",
"int",
"notEqual",
"sub",
"or",
"componentMultiply",
"sqrt",
"min",
"abs",
"lessEqual",
"mix",
"and",
"add",
"mat4",
"dot",
"not",
"max",
"mul"
]
}
},
"required": [
"call",
"args"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"select": {
"$ref": "#/$defs/dataExpression"
},
"whenFalse": {
"$ref": "#/$defs/dataExpression"
},
"whenTrue": {
"$ref": "#/$defs/dataExpression"
}
},
"required": [
"select",
"whenTrue",
"whenFalse"
],
"type": "object"
}
]
}dataId · v5
type="string"; maxLength=512; pattern="^[a-z0-9][a-z0-9_.-]*:[a-z0-9][a-z0-9_./-]*$"
Full structural rule: #/$defs/dataId
{
"maxLength": 512,
"pattern": "^[a-z0-9][a-z0-9_.-]*:[a-z0-9][a-z0-9_./-]*$",
"type": "string"
}Complete examples
Sources and machine records
Coverage inventory · Schema v5 · Catalog v2 · Completion v2
schema-v3 · schema-v4 · schema-v5 · completion-v1 · completion-v2 · temporal · settings-guide ·