Schemas / Meta / render

rig.render.environment

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

Fields

FieldTypeMeaning
hdri entity required rig.media.asset_ref of the lat-long radiance image
intensity float optional Optional. Scale; absent = 1

Image-based light for the scene. One entity is enough. Format when present.

The lat-long image is a rig.media.asset_ref (kind image). Do not store a path on this component.

Decode and the spherical-harmonic projection stay fulfillment. Coefficients are a host cache.

JSON Schema

Resolves at https://rig.works/schemas/rig.render.environment.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.render.environment.schema.json",
  "title": "rig.render.environment",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "hdri": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "intensity": {
      "$ref": "./_defs.schema.json#/$defs/float"
    }
  },
  "required": [
    "hdri"
  ],
  "x-rig-maturity": "stable"
}

Seen in

environment.json