v1.2.21 Installation Instructions

Requires Unity 2019.3+

Unity’s HDRP is not currently fully supported by this plugin. Please get in touch for more information on its limitations

This guide will walk you through adding the required components to a scene to enable your Unity project for Igloo compatibility.

Learn by example, included in the package is the DemoScene located in IglooToolkit\Resources\Scenes.

Refer to the Reference for a more in-depth look at the components that make up the Igloo camera toolkit, and how it can be customised for certain use cases.

If you are new to Unity, we recommend exploring some of Unity's interactive tutorials to familiarise yourself with the Unity interface and concepts before continuing. More information on Unity can be found at their Learn Site.

Pages within this section

Project Setup

Package Import

It is recommended that you first import the camera package into a new Unity project, this helps eliminate potential issues during installation. To import the camera package from within the Unity Editor go to Assets > Import Package > Custom Package and open the file with the ‘.unitypackage’ extension, included in the zip folder.

Input Settings

The Igloo camera package requires some custom Input settings to be compatible with an Xbox controller. This can be done one of two ways;

Note - The next step is important, you will encounter errors in play mode if you do not apply the following settings.

The IglooPlayer system requires two custom Input Axes, a custom tag, and 2 custom layers to be defined in the Unity project settings.

These can be appended to your existing settings automatically by selecting Igloo > Apply InputManager Settings from the Unity Editor.

This will also add two packages to your scoped Registry if you are using Editor version 2021.1 or older. These are to succesfully use the Klak NDI package, which is included as part of the Igloo Plugin. for 2021.2+ this is supported within Unity without external packages.

You will see this popup after it has finished loading, just click ‘okay’

If this fails, or you get this message in the console, and you have Klak Error relating to Span:

You will need to add to your existing package manifest scoped registry; the following:

{ "scopedRegistries": 
  [
    { 
      "name": "Unity NuGet", 
      "url": "https://unitynuget-registry.azurewebsites.net", 
      "scopes": [ "org.nuget" ] 
    } 
  ], 
  "dependencies": 
  { 
    "org.nuget.system.memory": "4.5.3",

Universal Rendering Pipeline (Toolkit Version 1.0 - 1.21)

If using URP a custom scripting define IGLOO_URP must be added to your player settings.

Universal Rendering Pipeline (Toolkit Version 1.21-1+)

When using URP in the later toolkit version, it is not necessary to add scripting defines. This is handled automatically by the Igloo Assembly Reference within the Toolkit’s root folder. More information regarding this file, and what it means for extending the Igloo Toolkit can be found HERE.

You will, however, need to add a render feature to any renderers you intend to use in your project.

Find the renderer you intend to use, in my case it’s a default forward renderer
Select the Add Render Feature button, and click Blit Material Feature

Leave the Name as NewBlitMaterialFeature as it helps our script locate it.
Set the values within the feature to the following:
Material - URPCameraBlend
Material Pass Index - 0
Render Event - After Rendering
Now this is complete, when you use the Warp & Blend and Window features, the Universal Render Pipeline will successfully create an external window using the Igloo Warper warps grids.