{

"$schema": "http://json-schema.org/draft-07/schema",

"$defs": {

"orientation": {

"type": "object",

"anyOf": [

{

"type": "object",

"title": "Yaw/Pitch/Roll",

"properties": {

"pitch": {

"type": "number",

"title": "Pitch"

},

"yaw": {

"type": "number",

"title": "Yaw"

},

"roll": {

"type": "number",

"title": "Roll"

}

},

"required": [ "pitch", "yaw", "roll" ],

"additionalProperties": false

},

{

"type": "object",

"title": "Quaternion",

"properties": {

"x": { "type": "number" },

"y": { "type": "number" },

"z": { "type": "number" },

"w": { "type": "number" }

},

"required": [ "x", "y", "z", "w" ],

"additionalProperties": false

}

],

"title": "Quaternion"

},

"mat4": {

"type": "array",

"items": { "type": "number" },

"minItems": 16,

"maxItems": 16

},

"ivec2": {

"type": "object",

"properties": {

"x": { "type": "integer" },

"y": { "type": "integer" }

},

"required": [ "x", "y" ],

"additionalProperties": false

},

"vec2": {

"type": "object",

"properties": {

"x": { "type": "number" },

"y": { "type": "number" }

},

"required": [ "x", "y" ],

"additionalProperties": false

},

"vec3": {

"type": "object",

"properties": {

"x": { "type": "number" },

"y": { "type": "number" },

"z": { "type": "number" }

},

"required": [ "x", "y", "z" ],

"additionalProperties": false

},

"vec4": {

"type": "object",

"properties": {

"x": { "type": "number" },

"y": { "type": "number" },

"z": { "type": "number" },

"w": { "type": "number" }

},

"required": [ "x", "y", "z", "w" ],

"additionalProperties": false

},

"color": {

"type": "object",

"properties": {

"r": {

"type": "number",

"minimum": 0.0,

"maximum": 1.0

},

"g": {

"type": "number",

"minimum": 0.0,

"maximum": 1.0

},

"b": {

"type": "number",

"minimum": 0.0,

"maximum": 1.0

},

"a": {

"type": "number",

"minimum": 0.0,

"maximum": 1.0

}

},

"required": [ "r", "g", "b", "a" ],

"additionalProperties": false

},

"projectionquality": {

"type": "string",

"enum": [

"low", "256", "medium", "512", "high", "1k", "1024", "1.5k", "1536", "2k", "2048",

"4k", "4096", "8k", "8192", "16k", "16384", "32k", "32768", "64k", "65536"

],

"title": "Quality",

"description": "Determines the pixel resolution of the cube map faces that are reprojected to create the fisheye rendering. The higher resolution these cube map faces have, the better quality the resulting fisheye rendering, but at the expense of increased rendering times."

},

"spout": {

"type": "object",

"properties": {

"enabled": {

"type": "boolean",

"title": "Enabled",

"description": "Determines whether the output via Spout is enabled."

},

"name": {

"type": "string",

"minLength": 1,

"title": "Name",

"description": "The name under which Spout will share this content. If this value is not specified, a unique name will be automatically generated."

}

},

"required": [ "enabled" ],

"additionalProperties": false

},

"ndi": {

"type": "object",

"properties": {

"enabled": {

"type": "boolean",

"title": "Enabled",

"description": "Determines whether the output via NDI is enabled."

},

"name": {

"type": "string",

"minLength": 1,

"title": "Name",

"description": "The name under which NDI will share this content. If this value is not specified, a unique name will be automatically generated."

},

"group": {

"type": "string",

"minLength": 1,

"title": "Group",

"description": "A comma-separated list of NDI groups under which NDI will share the content. See the NDI documentation for more information."

}

},

"required": [ "enabled" ],

"additionalProperties": false

},

"cubemapprojection": {

"type": "object",

"properties": {

"quality": {

"$ref": "#/$defs/projectionquality",

"title": "Quality",

"description": "Determines the pixel resolution of the cube map faces that are individually rendered to create the cylindrical rendering. The higher resolution these cube map faces have, the better quality the resulting cylindrical rendering, but this comes at the expense of increased rendering times. The named values are corresponding:\n - `low`: 256\n - `medium`: 512 (the default)\n - `high`: 1024\n - `1k`: 1024\n - `1.5k`: 1536\n - `2k`: 2048\n - `4k`: 4096\n - `8k`: 8192\n - `16k`: 16384"

},

"spout": {

"$ref": "#/$defs/spout",

"title": "Spout"

},

"ndi": {

"$ref": "#/$defs/ndi",

"title": "NDI"

},

"channels": {

"type": "object",

"properties": {

"right": {

"type": "boolean",

"title": "Right",

"description": "Controls the right side of the cubemap."

},

"zleft": {

"type": "boolean",

"title": "Back",

"description": "Controls the back side of the cubemap."

},

"bottom": {

"type": "boolean",

"title": "Bottom",

"description": "Controls the bottom side of the cubemap."

},

"top": {

"type": "boolean",

"title": "Top",

"description": "Controls the top side of the cubemap."

},

"left": {

"type": "boolean",

"title": "Left",

"description": "Controls the left side of the cubemap."

},

"zright": {

"type": "boolean",

"title": "Front",

"description": "Controls the front side of the cubemap."

}

},

"required": [ "right", "zleft", "bottom", "top", "left", "zright" ],

"additionalProperties": false

},

"orientation": {

"$ref": "#/$defs/orientation",

"title": "Orientation",

"description": "Describes a fixed orientation for the virtual image plane. This can be provided either as Euler angles or as a quaternion."

}

},

"required": [ "type" ],

"additionalProperties": false,

"title": "CubemapProjection",

"description": "This projection type will and show the individual faces of a cube surrounding the camera. Individual cubemap faces can be toggled on and off and this projection also has the ability to share the individual cubemap faces."

},

"cylindricalprojection": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "CylindricalProjection",

"default": "CylindricalProjection",

"readOnly": true,

"description": "Defines the type of this projection."

},

"quality": {

"$ref": "#/$defs/projectionquality",

"title": "Quality",

"description": "Determines the pixel resolution of the cube map faces that are individually rendered to create the cylindrical rendering. The higher resolution these cube map faces have, the better quality the resulting cylindrical rendering, but this comes at the expense of increased rendering times. The named values are corresponding:\n - `low`: 256\n - `medium`: 512 (the default)\n - `high`: 1024\n - `1k`: 1024\n - `1.5k`: 1536\n - `2k`: 2048\n - `4k`: 4096\n - `8k`: 8192\n - `16k`: 16384"

},

"rotation": {

"type": "number",

"title": "Rotation",

"description": "Provides a rotation angle (in radians) around the z-axis around which the cylindrical projection is offset into the resulting image."

},

"heightoffset": {

"type": "number",

"title": "Height Offset",

"description": "Offsets the height from which the cylindrical projection is generated. This is, in general, only necessary if the user position is offset and you want to counter that offset to continue producing a \"standard\" cylindrical projection."

},

"radius": {

"type": "number",

"title": "Radius",

"description": "Sets the radius of the sphere, which is only used in the cases when stereoscopic rendering is used."

}

},

"required": [ "type" ],

"additionalProperties": false,

"title": "CylindricalProjection",

"description": "This projection method renders the scene into a view that can be mapped on the inside or outside of a cylinder. This projection method is support by some live media curation tools. The forward-facing direction will be at the left border of the image unless changed via the rotation option."

},

"equirectangularprojection": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "EquirectangularProjection",

"default": "EquirectangularProjection",

"readOnly": true,

"description": "Defines the type of this projection."

},

"quality": {

"$ref": "#/$defs/projectionquality",

"title": "Quality",

"description": "Determines the pixel resolution of the cube map faces that are individually rendered to create the cylindrical rendering. The higher resolution these cube map faces have, the better quality the resulting cylindrical rendering, but this comes at the expense of increased rendering times. The named values are corresponding:\n - `low`: 256\n - `medium`: 512 (the default)\n - `high`: 1024\n - `1k`: 1024\n - `1.5k`: 1536\n - `2k`: 2048\n - `4k`: 4096\n - `8k`: 8192\n - `16k`: 16384"

}

},

"required": [ "type" ],

"additionalProperties": false,

"title": "EquirectangularProjection",

"description": "This projection method renders an equirectangular projection (also called lat-long projection or equidistant cylindrical projection) is a default projection method used for spherical objects or maps."

},

"fisheyeprojection": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "FisheyeProjection",

"default": "FisheyeProjection",

"readOnly": true,

"description": "Defines the type of this projection."

},

"fov": {

"type": "number",

"minimum": 0.0,

"title": "Field-of-View",

"description": "Describes the field of view that is covered by the fisheye projection in degrees. The resulting image will always be a circle, and this value determines how much of a field of view is covered by this circle. Please note specifically that this also includes field-of-view settings >180, in which a larger distortion is applied to the image. The default value is 180."

},

"quality": {

"$ref": "#/$defs/projectionquality",

"title": "Quality",

"description": "Determines the pixel resolution of the cube map faces that are individually rendered to create the fisheye rendering. The higher resolution these cube map faces have, the better quality the resulting cylindrical rendering, but this comes at the expense of increased rendering times. The named values are corresponding:\n - `low`: 256\n - `medium`: 512 (the default)\n - `high`: 1024\n - `1k`: 1024\n - `1.5k`: 1536\n - `2k`: 2048\n - `4k`: 4096\n - `8k`: 8192\n - `16k`: 16384"

},

"interpolation": {

"type": "string",

"enum": [ "linear", "cubic" ],

"title": "Interpolation",

"description": "Determines the texture interpolation method that is used by SGCT when reprojecting the cube maps into the final fisheye rendering. The default value is `\"linear\"`."

},

"tilt": {

"type": "number",

"title": "Tilt",

"description": "Determines the tilt of the \"up vector\" of the fisheye. With a tilt of `0`, the center of the fisheye image is the apex of the half-sphere that is used to reproject the cube map. A tilted fisheye rendering is useful when projecting on a tilted planetarium dome. A value of `90`, for example, would result in the forward facing direction being at the center of the fisheye circular image. The default value is `0`."

},

"diameter": {

"type": "number",

"title": "Diameter",

"description": "Sets the diameter in meters for the \"sphere\" that the fisheye is reprojected based on. This value is only used for stereoscopic rendering to compute the frustum offset using the Users `eyeseparation`. The default value is `14.8`."

},

"crop": {

"type": "object",

"properties": {

"left": {

"type": "number",

"minimum": 0,

"maximum": 1,

"title": "Left",

"description": "The ratio of the image that is cropped from the left. If the value is `0`, the image is not cropped at all from this side, if it is `1`, the entire image is cropped. However, this cropping value must not be larger than the `1 - right` cropping value as these value might not overlap. The default value is `0`."

},

"right": {

"type": "number",

"minimum": 0,

"maximum": 1,

"title": "Right",

"description": "The ratio of the image that is cropped from the right. If the value is `0`, the image is not cropped at all from this side, if it is `1`, the entire image is cropped. However, this cropping value must not be larger than the `1 - left` cropping value as these value might not overlap. The default value is `0`."

},

"bottom": {

"type": "number",

"minimum": 0,

"maximum": 1,

"title": "Bottom",

"description": "The ratio of the image that is cropped from the bottom. If the value is `0,` the image is not cropped at all from this side, if it is `1`, the entire image is cropped. However, this cropping value must not be larger than the `1 - top` cropping value as these value might not overlap. The default value is `0`."

},

"top": {

"type": "number",

"minimum": 0,

"maximum": 1,

"title": "Top",

"description": "The ratio of the image that is cropped from the top. If the value is `0`, the image is not cropped at all from this side, if it is `1`, the entire image is cropped. However, this cropping value must not be larger than the `1 - bottom` cropping value as these value might not overlap. The default value is `0`."

}

},

"required": [ "left", "right", "bottom", "top" ],

"additionalProperties": false,

"title": "Crop",

"description": "This node can be used to crop the fisheye after the post processing has been performed. This might be useful for domes running a single projector with a fisheye lens. Normally a projector has a 16:9, 16:10, or 4:3 aspect ratio, but the fiehye output has a 1:1 aspect ratio. This circle can be squared by cropping the 1:1 aspect ratio fisheye image down to the aspect ratio of the projector that is used. By default, no cropping is applied to the image, leaving it in a 1:1 aspect ratio."

},

"keepaspectratio": {

"type": "boolean",

"title": "Keep Aspect Ratio",

"description": "Determines whether the application should try to maintain the original aspect ratio when resizing the window or whether the field of view should be recalculated based on the window's new aspect ratio. The default value is `true`."

},

"offset": {

"$ref": "#/$defs/vec3",

"title": "Offset",

"description": "A linear offset in meters that is added to the virtual planes used to project the fisheye rendering. This can be used for off-axis projections. Must define three float attributes `x`, `y`, and `z`. The default values are `x=0`, `y=0`, `z=0`, meaning that no offset is applied to the center of the fisheye sphere."

},

"background": {

"$ref": "#/$defs/color",

"title": "Background",

"description": "This value determines the color that is used for the parts of the image that are not covered by the spherical fisheye image. The alpha component of this color has to be provided even if the final render target does not contain an alpha channel, in which case the alpha value is ignored. The default color is a dark gray `(0.3, 0.3, 0.3, 1.0)`."

}

},

"required": [ "type" ],

"additionalProperties": false,

"title": "FisheyeProjection",

"description": "Describes a fisheye projection that is used to render into its parent Viewport. By default, a fisheye rendering is covering 180 degrees field of view and has a 1:1 aspect ratio, though these parameters can be changed with the attributes provided in this node. This projection type counts as a non-linear projection, which requires 4-6 render passes of the application, meaning that the application might render slower when using these kind of projections than a flat projection. In either case, the application does not need to be aware of the projection as this abstract is handled internally and the applications draw method is only called multiple times per frame with different projection methods that are used to create the full fisheye projection."

},

"planarprojection": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "PlanarProjection",

"default": "PlanarProjection",

"readOnly": true,

"description": "Defines the type of this projection."

},

"fov": {

"oneOf": [

{

"type": "object",

"properties": {

"hfov": {

"type": "number",

"minimum": 0.0,

"title": "Horizontal Field-of-view",

"description": "The angle (in degrees) covered by the camera in the horizontal direction. This is a symmetric frustum around the center and provides the same result as providing the `left` and `right` values with the half-angle."

},

"vfov": {

"type": "number",

"minimum": 0.0,

"title": "Vertical Field-of-view",

"description": "The angle (in degrees) covered by the camera in the vertical direction. This is a symmetric frustum around the center and provides the same result as providing the `up` and `down` values with the half-angle."

}

},

"required": [ "hfov", "vfov" ],

"additionalProperties": false,

"title": "hFov / vFov"

},

{

"type": "object",

"properties": {

"left": {

"type": "number",

"title": "Left",

"description": "The angle (in degrees) that is covered by the camera between the central point and the left border of the viewport. The `left` and `right` angles added together are the vertical field of view of the viewport."

},

"right": {

"type": "number",

"title": "Right",

"description": "The angle (in degrees) that is covered by the camera between the central point and the right border of the viewport. The `left` and `right` angles added together are the vertical field of view of the viewport."

},

"down": {

"type": "number",

"title": "Down",

"description": "The angle (in degrees) that is covered by the camera between the central point and the bottom border of the viewport. The `down` and `up` angles added together are the vertical field of view of the viewport."

},

"up": {

"type": "number",

"title": "Up",

"description": "The angle (in degrees) that is covered by the camera between the central point and the top border of the viewport. The `down` and `up` angles added together are the vertical field of view of the viewport."

}

},

"required": [ "left", "right", "down", "up" ],

"additionalProperties": false,

"title": "left+right / down+up"

}

],

"title": "Camera Field-of-View",

"description": "This object describes the field of view used the camera in this projection. The angles for the field of view can be provided in two ways. Either by providing the `up`, `down`, `left`, and `right` angles, which enables asymmetric frustums, or alternatively providing horizontal (`hfov`) and vertical (`vfov`) angles for symmetric frustums."

},

"distance": {

"type": "number",

"title": "Distance",

"description": "The distance (in meters) at which the virtual render plane is placed. This value is only important when rendering this viewport using stereocopy as the `distance` and the User's `eyeseparation` are used to compute the change in frustum between the left and the right eyes."

},

"orientation": {

"$ref": "#/$defs/orientation",

"title": "Orientation",

"description": "Describes a fixed orientation for the virtual image plane. This can be provided either as Euler angles or as a quaternion."

},

"offset": {

"$ref": "#/$defs/vec3",

"title": "Offset",

"description": "A linear offset in meters that is added to the virtual image plane. Must define three float attributes `x`, `y`, and `z`. The default values are `x=0`, `y=0`, `z=0`, meaning that no offset is applied to the image plane."

}

},

"title": "Planar Projection",

"required": [ "type", "fov" ],

"additionalProperties": false,

"description": "Describes a projection for the Viewport that is a flat projection described by simple frustum, which may be asymmetric. If you are building a new configuration file and do not know which projection type you should use, this type is probably the right one."

},

"projectionplane": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "ProjectionPlane",

"default": "ProjectionPlane",

"readOnly": true,

"description": "Defines the type of this projection."

},

"lowerleft": {

"$ref": "#/$defs/vec3",

"title": "Lower Left Corner",

"description": "The position of the lower left corner of the projection plane relative to the User's position. The units for these values are arbitrary."

},

"upperleft": {

"$ref": "#/$defs/vec3",

"title": "Upper Left Corner",

"description": "The position of the upper left corner of the projection plane relative to the User's position. The units for these values are arbitrary."

},

"upperright": {

"$ref": "#/$defs/vec3",

"title": "Upper Right Corner",

"description": "The position of the upper right corner of the projection plane relative to the User's position. The units for these values are arbitrary."

}

},

"required": [ "type", "lowerleft", "upperleft", "upperright" ],

"additionalProperties": false,

"title": "Projection Plane",

"description": "This projection method is based on providing three corner points that are used to construct a virtual image plane. The units of the positions are all relative to the user's position so are ultimately arbitrary."

},

"sphericalmirrorprojection": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "SphericalMirrorProjection",

"default": "SphericalMirrorProjection",

"readOnly": true,

"description": "Defines the type of this projection."

},

"quality": {

"$ref": "#/$defs/projectionquality",

"title": "Quality",

"description": "Determines the pixel resolution of the cube map faces that are individually rendered to create the cylindrical rendering. The higher resolution these cube map faces have, the better quality the resulting cylindrical rendering, but this comes at the expense of increased rendering times. The named values are corresponding:\n - `low`: 256\n - `medium`: 512 (the default)\n - `high`: 1024\n - `1k`: 1024\n - `1.5k`: 1536\n - `2k`: 2048\n - `4k`: 4096\n - `8k`: 8192\n - `16k`: 16384"

},

"tilt": {

"type": "number",

"title": "Tilt",

"description": "Determines the tilt of the \"up vector\" of the spherical mirror projection. With a tilt of 0, the center of the spherical mirror image is the apex of the half-sphere that is used to reproject the cube map. The default value is 0."

},

"background": {

"$ref": "#/$defs/color",

"title": "Background",

"description": "This value determines the color that is used for the parts of the image that are not covered by the spherical mirror image. The alpha component of this color has to be provided even if the final render target does not contain an alpha channel, in which case the alpha value is ignored. All attributes r, g, b, and a must be defined and be between 0 and 1. The default color is a dark gray (0.3, 0.3, 0.3, 1.0)."

},

"geometry": {

"type": "object",

"properties": {

"bottom": {

"type": "string",

"title": "Bottom",

"description": "The path to the warping mesh that is loaded for the bottom part of the spherical mirror projection."

},

"left": {

"type": "string",

"title": "Left",

"description": "The path to the warping mesh that is loaded for the bottom part of the spherical mirror projection."

},

"right": {

"type": "string",

"title": "Right",

"description": "The path to the warping mesh that is loaded for the bottom part of the spherical mirror projection."

},

"top": {

"type": "string",

"title": "Top",

"description": "The path to the warping mesh that is loaded for the bottom part of the spherical mirror projection."

}

},

"title": "Geometry",

"required": [ "bottom", "left", "right", "top" ],

"additionalProperties": false,

"description": "Describes the warping meshes used for the spherical mirror projection. All four warping meshes have to be present."

}

},

"required": [ "type", "geometry" ],

"title": "Spherical Mirror Projection",

"description": "Used to create a projection used for Paul Bourke's spherical mirror setup (see here), which makes it possible to use an off-the-shelf projector to create a planetarium-like environment by bouncing the image of a shiny metal mirror. Please note that this is not the only way to produce these kind of images. Depending on your setup and availability of warping meshes, it might suffice to use the FisheyeProjection node type instead and add a single mesh to the parent Viewport instead. The config folder in SGCT contains an example of this using a default 16x9 warping mesh. This projection type specifically deals with the case where you have four different meshes, one for the bottom, top, left, and right parts of the distorted image."

},

"texturemappedprojection": {

"type": "object",

"properties": {

"type": {

"type": "string",

"const": "TextureMappedProjection",

"default": "TextureMappedProjection",

"readOnly": true,

"description": "Defines the type of this projection."

},

"fov": {

"oneOf": [

{

"type": "object",

"properties": {

"hfov": {

"type": "number",

"minimum": 0.0,

"title": "Horizontal Field-of-view",

"description": "The angle (in degrees) covered by the camera in the horizontal direction. This is a symmetric frustum around the center and provides the same result as providing the `left` and `right` values with the half-angle."

},

"vfov": {

"type": "number",

"minimum": 0.0,

"title": "Vertical Field-of-view",

"description": "The angle (in degrees) covered by the camera in the vertical direction. This is a symmetric frustum around the center and provides the same result as providing the `up` and `down` values with the half-angle."

}

},

"required": [ "hfov", "vfov" ],

"additionalProperties": false,

"title": "hFov / vFov"

},

{

"type": "object",

"properties": {

"left": {

"type": "number",

"title": "Left",

"description": "The angle (in degrees) that is covered by the camera between the central point and the left border of the viewport. The `left` and `right` angles added together are the vertical field of view of the viewport."

},

"right": {

"type": "number",

"title": "Right",

"description": "The angle (in degrees) that is covered by the camera between the central point and the right border of the viewport. The `left` and `right` angles added together are the vertical field of view of the viewport."

},

"down": {

"type": "number",

"title": "Down",

"description": "The angle (in degrees) that is covered by the camera between the central point and the bottom border of the viewport. The `down` and `up` angles added together are the vertical field of view of the viewport."

},

"up": {

"type": "number",

"title": "Up",

"description": "The angle (in degrees) that is covered by the camera between the central point and the top border of the viewport. The `down` and `up` angles added together are the vertical field of view of the viewport."

}

},

"required": [ "left", "right", "down", "up" ],

"additionalProperties": false,

"title": "left+right / down+up"

}

],

"title": "Camera Field-of-View",

"description": "This element describes the field of view used the camera in this planar projection."

},

"distance": {

"type": "number",

"title": "Distance",

"description": "The distance (in meters) at which the virtual render plane is placed. This value is only important when rendering this viewport using stereoscopy as the distance and the Users eyeSeparation are used to compute the change in frustum between the left and the right eyes."

},

"orientation": {

"$ref": "#/$defs/orientation",

"title": "Orientation",

"description": "Describes a fixed orientation for the virtual image plane. This can be provided either as Euler angles or as a quaternion."

},

"offset": {

"$ref": "#/$defs/vec3",

"title": "Offset",

"description": "A linear offset in meters that is added to the virtual image plane. Must define three float attributes x, y, and z. The default values are x=0, y=0, z=0, meaning that no offset is applied to the image plane."

}

},

"required": [ "type", "fov" ],

"additionalProperties": false,

"title": "Texture Mapped Projection",

"description": "Describes a projection for the Viewport that is a flat projection described by simple frustum, which may be asymmetric."

},

"viewport": {

"type": "object",

"properties": {

"pos": {

"$ref": "#/$defs/vec2",

"title": "Position",

"description": "Specifies the position of the viewport inside its parent Window. The coordinates for `x` and `y`, which must both be specified in this node, are usually between 0 and 1, but are not restricted. Parts of the viewport that are outside this range would lie outside the bounds of the window and are clipped. Viewports are free to overlap and the viewports are rendered top to bottom into the window and can overwrite previous results."

},

"size": {

"$ref": "#/$defs/vec2",

"title": "Size",

"description": "Specifies the size of this viewport inside its parent Window. The coordinate for `x` and `y`, which must both be specified in this node, are between 0 and 1, but are not restricted. Parts of the viewport that are outside this range would lie outside the bounds of the window and are clipped. Viewports are free to overlap and the viewports are rendered top to bottom into the window and can overwrite previous results."

},

"projection": {

"oneOf": [

{

"$ref": "#/$defs/cubemapprojection",

"title": "Cubemap Projection"

},

{

"$ref": "#/$defs/cylindricalprojection",

"title": "Cylindrical Projection"

},

{

"$ref": "#/$defs/equirectangularprojection",

"title": "Equirectangular Projection"

},

{

"$ref": "#/$defs/fisheyeprojection",

"title": "Fisheye Projection"

},

{

"$ref": "#/$defs/planarprojection",

"title": "Planar Projection"

},

{

"$ref": "#/$defs/projectionplane",

"title": "Projection Plane"

},

{

"$ref": "#/$defs/sphericalmirrorprojection",

"title": "Spherical Mirror Projection"

},

{

"$ref": "#/$defs/texturemappedprojection",

"title": "Texture-Mapped Projection"

}

],

"title": "Projection"

},

"overlay": {

"type": "string",

"title": "Overlay",

"description": "This attribute is a path to an overlay texture that is rendered on top of the viewport after the applications rendering is finished. This can be used to add logos or other static assets on top of an application. The default is that no overlay is rendered."

},

"blendmask": {

"type": "string",

"title": "Blend Mask",

"description": "This value is a path to a texture that is used as a mask to remove parts of the rendered image. The image that is provided in this should be a binary black-white image which is applied by SGCT after the application loading is finished. All parts where the `blendmask` image is black will be removed. The default is that no mask is applied."

},

"blacklevelmask": {

"type": "string",

"title": "Blacklevel Mask",

"description": "The file referenced in this attribute is used as a postprocessing step for this viewport. The image should be a grayscale image, where each pixel will be multiplied with the resulting image from the application in order to perform a black level adaptation. If a pixel is completely white, the resulting pixel is the same as the applications output, if a pixel is black, the resulting pixel will be back, if it is 50% grey, the resolution pixel will be half brightness. The default is that no black level mask is applied."

},

"mesh": {

"type": "string",

"title": "Mesh",

"description": "Determines a warping mesh file that is used to warp the resulting image. The application's rendering will always be rendered into a rectangular framebuffer, which is then mapped as a texture to the geometry provided by this file. This makes it possible to create non-linear or curved output geometries from a regular projection by providing the proper geometry of the surface that you want to project on. The reader for the warping mesh is determined by the file extension of the file that is provided in this attribute. The default is that no warping mesh is applied.\n\n Supported geometry mesh formats:\n 1. SCISS Mesh (`sgc` extension).:A mesh format that was introduced by SCISS for the Uniview software. SCISS created two versions for this file format, one for 2D warping meshes and a second for 3D cubemap lookups. SGCT only supports the first version of the file format, however.\n 2. Scalable Mesh (`ol` extension): A mesh format created by scalable.\n 3. Dome Projection (`csv` extension)\n 4. Paul Bourke Mesh (`data` extension): A file format created by Paul Bourke, his webpage also contains more information abuot the individual steps of the warping.\n 5. Waveform OBJ (`obj` extension): The well known textual mesh format.\n 6. SimCAD (`simcad` extension)."

},

"tracked": {

"type": "boolean",

"title": "Tracked",

"description": "Determines whether the field-of-view frustum used for this viewport should be tracking changes to the window configuration. If this value is set to `false`, the field of view set in the beginning will stay unchanged."

},

"eye": {

"type": "string",

"enum": [ "center", "left", "right" ],

"title": "Eye",

"description": "Forces this viewport to be rendered with a specific eye, using the corresponding Users eye separation to compute the correct frustum. If this value is not set, the viewport will be rendered according to the parent Window's stereo attribute."

},

"user": {

"type": "string",

"title": "User",

"description": "The name of the User that this viewport should be linked to. If a viewport is linked to a user that has a sensor, the positions of the sensor will be automatically reflected in the user position that is used to render this viewport. The default is that no user is linked with this viewport."

}

},

"title": "Viewport",

"description": "Describes a single viewport inside a Window. Every window can contain an arbitrary number of viewports that are all rendered independently. The viewports are positioned inside the window using a normalized coordinate system."

},

"window": {

"type": "object",

"properties": {

"pos": {

"$ref": "#/$defs/ivec2",

"title": "Position",

"description": "Sets the position of the window on the overall desktop space provided by the operating system. This node must have `x` and `y` floating point attributes that specify the x-y location of the window. Please note that these values also can be negative on some operating systems. On Windows, for example, the top left corner of the primary monitor is `(0,0)` in this coordinate system, but there can be additional monitors to the left or the top of the primary monitor, which would require negative numbers. The default values are `x=0` and `y=0`."

},

"size": {

"$ref": "#/$defs/ivec2",

"title": "Size",

"description": "Sets the size of the window in pixels. This node must have `x` and `y` floating point attributes that determine that size of the window."

},

"res": {

"$ref": "#/$defs/ivec2",

"title": "Resolution",

"description": "Sets the size of the internal framebuffer that is used to render the contents of the window. In a lot of cases, this resolution is the same resolution as the size of the window, but it is a useful tool when creating images that are larger than a window would be support on an operating system. Some operating systems restrict windows to be no larger than what can fit on a specific monitor. This node must have `x` and `y` values that determine that size of the window. By default the resolution of the framebuffer is equal to the size of the window."

},

"viewports": {

"type": "array",

"items": { "$ref": "#/$defs/viewport" },

"title": "Viewports"

},

"id": {

"type": "integer",

"minimum": 0,

"title": "Identifier",

"description": "The numerical identifier of this window. By default windows are given numerical value equal to their position in Window's node list, meaning that the first window of a node will have the id `0`, the second window the id `1`, etc. This value can be used to overwrite this behavior. It is not allowed to give the same ID to two different windows."

},

"name": {

"type": "string",

"minLength": 1,

"title": "Name",

"description": "The name of the window. This is also used as the title of the window if window decorations are enabled. The default name for a window if this value is not specified is \"SGCT node: %1 (%2)\" with `%1` the address of this node and `%s` either \"server\" or \"client\", depending on whether the current node is the server or a client in the cluster."

},

"tags": {

"type": "array",

"items": {

"type": "string"

},

"title": "Tags",

"description": "A comma-separated list of tags that are associated with this window. The tags themselves don't have any meaning inside of SGCT, but can be used by the application code as a filter. One common use-case is to tag one of the windows as a \"GUI\" window, to restrict input to only that window, for example."

},

"bufferbitdepth": {

"type": "string",

"enum": [ "8", "16", "16f", "32f", "16i", "32i", "16ui", "32ui" ],

"title": "Buffer Bit Depth",

"description": "Sets the bit depth and format of the color texture that is used as the render backend for this entire window. The parameters passed into this attribute are converted to the following OpenGL parameters (internal color format and data type) to the texture creation:\n - `8`: `GL_RGBA8`, `GL_UNSIGNED_BYTE`. This is the default value if nothing else is specified.\n - `16`: `GL_RGBA16`, `GL_UNSIGNED_SHORT`\n - `16f`: `GL_RGBA16F`, `GL_HALF_FLOAT`\n - `32f`: `GL_RGBA32F`, `GL_FLOAT`\n - `16i`: `GL_RGBA16I`, `GL_SHORT`\n - `32i`: `GL_RGBA32I`, `GL_INT`\n - `16ui`: `GL_RGBA16UI`, `GL_UNSIGNED_SHORT`\n - `32ui`: `GL_RGBA32UI`, `GL_UNSIGNED_INT`"

},

"fullscreen": {

"type": "boolean",

"title": "Full Screen",

"description": "Determines whether the window should be created in an exclusive fullscreen mode. The `size` of this window will be used to set the screen resolution if this value is `true`. See also the `monitor` attribute to determine which monitor should be used as the target for the fullscreen window. The default value is `false`."

},

"autoiconify": {

"type": "boolean",

"title": "Auto-Iconify",

"description": "Determines whether an exclusive fullscreen window will be automatically iconified if it loses focus. This value will be ignored if the `fullscreen` value is not set or if it is `false`. The default value for this setting is `false`."

},

"hidemousecursor": {

"type": "boolean",

"title": "Hide Mouse Cursor",

"description": "If this value is set to `true`, the mouse cursor will never be visible above this window. The default value for this setting is `false`."

},

"floating": {

"type": "boolean",

"title": "Floating",

"description": "Indicates whether the window is floating, meaning that it is rendered by the operating system always on top of other windows. The default value is `false`."

},

"alwaysrender": {

"type": "boolean",

"title": "Always Render",

"description": "Determines whether the content of the window should continue to render even if the window is not visible on screen. Normally, the operating system will not invalidate a window when it is hidden (see `hidden` attribute) and this attribute can be used to overwrite that behavior. The default behavior is `false`."

},

"hidden": {

"type": "boolean",

"title": "Hidden",

"description": "Determines whether this window should be visible on screen or used as an offscreen rendering target. If a window is hidden, you should also set `alwaysrender` to `true`, or otherwise the rendering might not occur as expected. The default for this attribute is `false`."

},

"takescreenshot": {

"type": "boolean",

"title": "Take Screenshot",

"description": "If this value is `false`, this window will not participate in taking screenshots even if commanded so by the user. This can be useful to prevent auxiliary windows to create screenshots in a production environment."

},

"alpha": {

"type": "boolean",

"title": "Alpha",

"description": "Determines whether screenshots created from this window should include an alpha channel or not. If this value is false, the resulting image type is RGB, otherwise RGBA. The default is false."

},

"msaa": {

"type": "integer",

"minimum": 0,

"maximum": 255,

"title": "MSAA",

"description": "Determines whether multisample antialiasing is used for the window and how many subsamples should be used for the antialiasing. If the value is set to `0`, MSAA is disabled. MSAA operates by rendering the scene at a higher resolution using multiple samples per pixel and combining these samples to reduce aliasing. It produces good-looking results, but it increases the rendering time for the scene. The maximum number of samples depends on the GPU that is used to start the application, but is usually around 32. This value should not be used at the same time as `fxaa`. The default is `0`, disabling MSAA."

},

"fxaa": {

"type": "boolean",

"title": "FXAA",

"description": "Determines whether fast approximate antialiasing is used for the contents of this window. This antialiasing is a postprocessing that does not significantly increase rendering time, but the results are not as good as `msaa`. This value should not be used at the same time as `msaa`. The default is `false`."

},

"border": {

"type": "boolean",

"title": "Border",

"description": "Enables or disables the window decorations. Window decorations are the title bar that contains the name of the window and buttons to close, maximize or minimize a window. On some operating systems, the window decorations also include a border around a window and potentially shadow effects and the ability to resize the window by dragging the border, all of which can be disabled with this attribute. The default is `true`."

},

"resizable": {

"type": "boolean",

"title": "Border",

"description": "Enables or disables the ability of the user to change the size of the window. The default is `true`."

},

"draw2d": {

"type": "boolean",

"title": "Draw 2D",

"description": "Determines whether the `draw2D` callback should be called for viewports in this window. In many applications this corresponds to user interface elements that are traditionally rendered in this step. The default value is `true`."

},

"draw3d": {

"type": "boolean",

"title": "Draw 3D",

"description": "Determines whether the `draw` callback should be called for viewports in this window. In many applications, this is the rendering step that creates the 3D scene and renders it to the screen. The default value is `true`."

},

"noerror": {

"type": "boolean",

"title": "No Error Checking",

"description": "If this value is set to `false` the graphics API will not perform any error checking. This means that any application will run slightly faster but will behave in an undefined manner in case any rendering error do occur."

},

"blitwindowid": {

"type": "integer",

"minimum": -1,

"title": "Blit Window ID",

"description": "If this value is specified, the 3D contents of a different window are blitted (=copied) into this window before calling its own rendering. A common use-case for this are GUI windows that want to show the 3D rendering but not take the performance impact of rendering an expensive scene twice. Instead of rendering the 3D scene, a GUI window would set `draw3D` to `false` and this attribute to the `id` of the main window, meaning that the contents of that other window are copied and then the 2D UI will be rendered on top of the blitted content. Unless specified otherwise, a Window's id is the position of the window within a node, starting at `0`. So the first window of a node will have the id `0`, the second `1`, etc. The default value is `-1` which means that not blitting is performed."

},

"mirrorx": {

"type": "boolean",

"title": "Mirror X",

"description": "If this value is set to `true`, the resulting image of the window will be horizontally mirrored. The default value if it is not specified is `false`."

},

"mirrory": {

"type": "boolean",

"title": "Mirror Y",

"description": "If this value is set to `true`, the resulting image of the window will be vertically mirrored. The default value if it is not specified is `false`."

},

"monitor": {

"type": "integer",

"minimum": -1,

"title": "Monitor",

"description": "Determines which monitor should be used for the exclusive fullscreen in case `fullscreen` is set to `true`. The list of monitors on the system are zero-based and range between `0` and the \"number of monitors\" - 1. For this attribute, the special value `-1` can be used to denote that the primary monitor as defined by the operating system should be used, regardless of its index. The default value is `-1`."

},

"stereo": {

"type": "string",

"enum": [

"none", "no_stereo",

"active", "quadbuffer",

"checkerboard",

"checkerboard_inverted",

"anaglyph_red_cyan",

"anaglyph_amber_blue",

"anaglyph_wimmer",

"vertical_interlaced",

"vertical_interlaced_inverted",

"test", "dummy",

"side_by_side",

"side_by_side_inverted",

"top_bottom",

"top_bottom_inverted"

],

"title": "Stereo",

"description": "Determines whether the contents of this window should be rendered stereoscopically and which stereoscopic rendering method should be used. The only allowed attribute for this node is the type, which determines the type of stereo rendering. It has to be one of: \n 1. `none`: No stereo rendering is performed. This is the same as if this entire node was not specified. This is the default value if no other is specified.\n 2. `active`: Using active stereo using quad buffering. This is only a valid option for systems that support quad buffering.\n 3. `checkerboard`: Using a checkerboard pattern for stereoscopy in which left and right eyes are rendered on interleaved checkerboard patterns.\n 4. `checkerboard_inverted`: Using the same pattern as `checkerboard`, but with the left and right eyes inverted.\n 5. `anaglyph_red_cyan`: Applying color filters to the rendering for the left and right eyes such that red-cyan anaglyph glasses can be used to view the stereo content.\n 6. `anaglyph_amber_blue`: Applying color filters to the rendering for the left and right eyes such that amber-blue anaglyph glasses can be used to view the stereo content.\n 7. `anaglyph_wimmer`: Anaglyph method by Peter Wimmer.\n 8. `vertical_interlaced`: A stereo format in which the left and right eye images are interlaced vertically, meaning that each row of the final image is either left or right, switching each row.\n 9. `vertical_interlaced_inverted`: The same as `vertical_interlaced`, but with the left and right eye flipped.\n 10. `dummy`: A dummy stereo mode to test streoscopic rendering without needing extra equipment. In this stereo mode, the left and the right eye images are rendered on top of each other without any other processing. This option is available to verify that stereo rendering is working for a specific application.\n 11. `side_by_side`: The resolution of the window is split into a left half and a right half, with each eye being rendered into its half. This is a common stereo format for 3D TVs.\n 12. `side_by_side_inverted`: The same as `side_by_side`, but the left and right images are flipped.\n 13. `top_bottom`: The same as side_by_side, but instead of separating the window horizontally, the window is split vertically, with the left eye being rendered in the top half of the window and the right image being rendered in the bottom half.\n 14. `top_bottom_inverted`: The same as `top_bottom`, but with the left and right eyes flipped."

},

"spout": {

"$ref": "#/$defs/spout",

"title": "Spout"

},

"ndi": {

"$ref": "#/$defs/ndi",

"title": "NDI"

},

"scalablemesh": {

"type": "string",

"title": "Scalable Mesh",

"description": "If this value is specified, a configuration file from Scalable Mesh will be used to fill in many of the values of this window instead, such as the window resolution, location, state of full screen etc. See the specific documentation for Scalable Meshes for more information."

}

},

"required": ["size"],

"additionalProperties": false,

"title": "Window",

"description": "This type specifies a single window that is used to render content into. There can be an arbitrary(-ish) number of windows for each node and they all will be created and initialized at start time. Each window has at least one Viewport that specifies exactly where in the window the rendering occurs with which parameters."

},

"node": {

"type": "object",

"properties": {

"address": {

"type": "string",

"minLength": 1,

"title": "Address",

"description": "The IP address or the DNS name of the node. If the address is a DNS name, the name resolution is delegated to the operating system and might include additional network traffic to the DNS host. If the node ought to be the local machine either `127.0.0.x` with x from 0 to 255, or localhost (which corresponds to `127.0.0.1`) can be used."

},

"port": {

"type": "integer",

"minimum": 0,

"maximum": 65535,

"title": "Port",

"description": "The port at which this node is available at to the server. Please note that operating systems have restricted behavior when trying to open ports lower than a fixed limt. For example, Unix does not allow non-elevated users to open ports < 1024. As a convention, SGCT usually uses ports staring at 20400, but this is an arbitrary convention without a specific reason."

},

"datatransferport": {

"type": "integer",

"minimum": 0,

"maximum": 65535,

"title": "Data Transfer Port",

"description": "If this value is set, a socket connection is opened at the provided port that can be used by the application to transmit data between the server and the clients using the `dataTransfer*` callbacks and `transferData` function of the `NetworkManager`. If no value is specified this function will not work and the callbacks will never be called. Please note that operating systems have restricted behavior when trying to open ports lower than a fixed limt. For example, Unix does not allow non-priviledged users to open ports < 1024."

},

"swaplock": {

"type": "boolean",

"title": "Swap Lock",

"description": "Determines whether this node should be part of an Nvidia swap group and should use the swap barrier. Please note that this feature only works on Windows and requires Nvidia Quadro cards + G-Sync synchronization cards. For more information on swap groups, see https://www.nvidia.com/content/dam/en-zz/Solutions/design-visualization/quadro-product-literature/Quadro_GSync_install_guide_v4.pdf. The default value is false."

},

"windows": {

"type": "array",

"items": { "$ref": "#/$defs/window" },

"title": "Windows",

"description": "Specifies windows that are used to render content into. There can be an arbitrary(-ish) number of windows for each node and they all will be created and initialized at start time. Each window has at least one Viewport that specifies exactly where in the window the rendering occurs with which parameters."

}

},

"required": [ "address", "port" ],

"additionalProperties": false,

"title": "Node",

"description": "Defines a single computing node that is contained in the described cluster. In general this corresponds to a single computer, but it is also possible to create multiple nodes on a local machine by using the `127.0.0.x` IP address with x from `1` to `255`. It is not possible to create multiple nodes on the same remote computer, however."

},

"user": {

"type": "object",

"properties": {

"name": {

"type": "string",

"title": "Name",

"minLength": 1,

"description": "Specifies the name of this user. Each user needs to have a unique name, but there also has to be exactly one user present that has an empty name (or without a `name` attribute) which is used as the default user."

},

"eyeseparation": {

"type": "number",

"exclusiveMinimum": 0.0,

"title": "Eye Separation",

"description": "Determines the eye separation used for stereoscopic viewports. If no viewports in the configuration are using stereo, this setting is ignored."

},

"pos": {

"$ref": "#/$defs/vec3",

"title": "Position",

"description": "A linear offset of the user position. Must define three float attributes `x`, `y`, and `z`. The default values are `x=0`, `y=0`, `z=0`, meaning that no linear offset is applied to the user's position."

},

"matrix": {

"$ref": "#/$defs/mat4",

"title": "Matrix",

"description": "A generic transformation matrix that is applied to the orientation of this user."

},