Loading an Umbrafied Scene into Unity

In Unity, begin by clicking Umbra from the top menu and select Create New Umbra Scene from the drop-down menu. This will create a new Umbra Runtime object, containing an Umbra Scene inside. This component allows the loading selected Umbra scenes into your Unity project.


Add an Umbrafied scene to the Umbra Runtime object by clicking Add Scene.


Select your input type, and provide the required information. Input types are expanded on below.

Multiple scenes can be loaded to a single Umbra Runtime object using the Add Scene button. All scenes will be rendered with the same settings as defined in the parent Umbra Runtime object.

Umbra Runtime


Transform provides standard Unity parameters for scaling and positioning the umbrafied models at Runtime.


Runtime (Script)


Opaque Shader & Transparent Shader

Set the shader used to render the umbrafied geometry.

Generally, you won't have to touch this variable. When switching to the HoloLens platform, or a mobile platform, you will notice that this setting will change to a less demanding shader.

Add Scene

Add an Umbrafied model as a scene

LOD Settings


Size Limit and Unit

Defines how much memory will be made available for Umbra at Runtime

File cache Size Limit and Unit

Defines the size of the local 3D asset cache. Previously loaded assets are stored in the cache and decrease load times for frequently viewed assets.


Controls the amount of acceptable geometric error due to LOD switches

(parameter value is used as a factor in the LOD switch distance calculation).

Setting this to 1 will force the Umbra to load only the highest level of detail (not recommended due to high memory consumption) while setting this to 0 will have the opposite effect.

The parameter will automatically decrease in application runtime if the desired level of detail cannot fit into the device memory.

All scenes within the same Umbra Runtime object will use these settings.

Umbra Scene

Scene Data (Script)



Input Type

Select between input types of Locator, Public link, Scene list or Local file. Further input fields will depend on the input type.


Enter your API key here. Your key is found in your umbra.io account.


Enter a scene locator string here. An API key is required. The locator is printed in the Unity console output, or in the command line output at umbrafication.


Public link

Enter a public html scene link here. An API key is not required. A public link can be created in the project view panel in your umbra.io account.


Scene list

Select from a list of umbrafied scenes from your account. An API key is required.


Local File

Enter the filepath for a locally stored input file here.