Skip to main content

Top Level Prefabs

Background

Usage

{
"background": {
"transparency": 0,
"texture": "capy.jpeg",
"rotation": 0,
"scale": 1,
"content_mode": "scale_to_fill",
"blur": 0.5,
"clear_color": "1 0 0 1"
}
}

Enable virtual background.

ParameterDescriptionOptionalDefault Value

transparency

Sets the background transparency from 0 to 1.

0.0

texture

Sets the file (image or video) as background texture.

null

rotation

Rotates the background texture clockwise in degrees.

0.0

scale

Scales the background texture.

1.0

content_mode

Fits the background texture inside frame. Possible values are: scale_to_fill, fill, fit.

"scale_to_fill"

blur

Sets the background blur radius. Radius in [0, 1] range.

0.0

clear_color

Specifies the color of the area not covered by background texture (e.g. content_mode fit). Black by default. Transparency (the last) is a conventional value only and currently ignored (use 1 for it).

"0 0 0 0"

Preview

Drag

foreground

Usage Apply a texture to the whole screen.

{
"foreground": {
"filename": "path/to/texture/file"
}
}
ParameterDescriptionOptionalDefault Value

filename

Path to a PNG texture file. It must have reasonable alpha channel or it will hide the underlying drawings.

++

lut

Usage Apply a color filter (aka LUT).

{
"lut": {
"filename": "path/to/lut/file",
"strength": 0.9
}
}
ParameterDescriptionOptionalDefault Value

filename

Path to the LUT file (usually PNG).

++

strength

LUT strength. Value in [0, 1].

1.0

Preview

Drag

lights

Usage Add up to 4 directional light sources to GLTF models in addition to IBL textures.

{
"lights": {
"radiance": [
"10 0 0 0",
"0 0 10 0"
],
"direction": [
"-1 0 0",
"1 0 0"
]
}
}
ParameterDescriptionOptionalDefault Value

radiance

Array (or a single value for 1 light) of light sources radiances in R, G, B components and light wrap around factor in 4th component.

++

direction

Array (or a single value for 1 light) of light sources directions in X, Y, Z.

++