Top Level Prefabs

Background

Usage You can choose to use texture:

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

Or blur of the real background:

{
    "background": {
        "blur": 0.5
    }
}

Or transparency:

{
    "background": {
        "transparency": 0.5
    }
}

Enable virtual background.

Parameter	Description	Optional	Default Value
transparency	Sets the background transparency from 0 to 1.		0.0
texture	Sets the file (image or video) as the background texture. For better perfomance, formats must be used: .jpeg, .jpg, .png, .mp4 (H.264 and aac only). Formats such as .heic, .webp, .webm can be used also, but performance may vary depending on the device used. More info can be find here image formats and video formats		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 or a video to the whole screen.

{
    "foreground": {
        "filename": "path/to/texture/file",
        "rotation": 0
    }
}

Parameter	Description	Optional	Default Value
filename	Path to a texture or a video file. Texture must have reasonable alpha channel or, as in the case of video, it will hide the underlying drawings. Information about supported formats can be find here image formats and video formats	+	+
rotation	Rotates the foreground clockwise in degrees.		0.0

lut

Usage Apply a color filter (aka LUT).

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

Parameter	Description	Optional	Default 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. NOTE that GLTF model is mandatory.

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

Parameter	Description	Optional	Default 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.	+	+

msaa

Usage Apply multisample anti-aliasing to effect. MSAA makes the picture look cleaner by smoothing out jagged edges.

{
    "msaa": {
        "samples_count": 4
    }
}

Parameter	Description	Optional	Default Value
samples_count	MSAA strength. Value must be 1, 2, 4 or 8. If strength is 1 - msaa is turned off.	+	+