Varjo XR Plugin provides provides display, input and mixed reality feature support for Varjo HMDs. This fork adds support for the Varjo Layers API by hooking the Varjo Unity XR runtime.
The display subsystem provides stereo rendering support for the XR Plugin.
The input subsystem provides tracking for the HMD and hand controllers, button inputs from the HMD and contollers and eye tracking.
The session subsystem provides information about mixed reality feature availability.
The camera subsystem allows controlling video see-through cameras and accessing the camera streams.
The occlusion subsystem allows controlling the environment depth occlusion.
- Create or open a Unity project. See Unity XR SDK Compatibility page for compatible Unity editor and render pipeline versions.
- Open Window -> Package Manager.
- Click the '+' icon in the top left corner, select 'Add Package from git URL' and input the URL to the Varjo XR package repository: https://github.com/varjocom/VarjoUnityXRPlugin.git. Alternatively, if you want to install the package from a local copy, you can select 'Add package from disk' and navigate to the package.json file inside the Varjo XR package.
- In 'Project Settings' -> 'XR Plug-in Management', Select 'Varjo' from the list of Plug-in providers.
- To set up tracking, select 'GameObject' -> 'XR' -> 'Convert Main Camera To XR Rig' from Unity’s main menu. For more information on how to migrate an existing Unity scene, see Configuring your Unity Project for XR.
The Varjo Unity XR runtime creates a default layer, called the application base layer in the context of the layer support library. The application base layer renders from the XR camera that is created as described above. Layers are coupled with Unity's layers to selectively render content.
- Define a new user layer in Unity ('Project Settings' -> 'Tags and Layers' -> 'Layers').
- Remove the new layer from the XR rig's main camera culling mask.
- Add a new camera to the scene and remove the Audio Listener.
- Set the culling mask to the user layer you just created.
- Set the background type to 'Color' and set the background color alpha to '0'.
- Under 'Rendering' disable temporal anti-aliasing.
- Under 'Output', disable 'XR Rendering'.
- Make sure to set the color buffer and post-processing buffer formats of the HDRP asset in use ('Project Settings' -> 'Graphics' -> 'Scriptable Render Pipeline Settings') to
R16G16B16A16. - Create an empty game object and add a
VarjoLayerRendererto it.- Assign the main camera from the XR rig and the view camera from above to the renderer.
- Set the layer flags to whatever you want (see the Varjo Layers API documentation for more information).
- Select an order: negative values are rendered behind, positive in front of the application layer.
- To activate the layered rendering, call
VarjoLayersSupport.SetEnabled(true)from any script'sStartmethod. - Call
VarjoLayersSupport.SetApplicationBaseLayer()with the appropriate layer flags for the base layer from any script'sStartmethod to set the base layer blending behavior.
The MixedReality sample scene demonstrates a sample use of the layers API. It draws the HMD models through the base layer that's always visible and masks the spheres though a custom chroma-keying layer.
The following settings are available for Varjo XR Plugin in 'Project Settings' -> 'XR Plug-in Management' -> 'Varjo'.
At runtime these settings can be changed using the functions in Varjo.XR.VarjoRendering.
Selects the rendering mode:
The scene is rendered in 4 separate passes, one for each view (left context, right context, left focus, right focus).
The scene is rendered in 2 passes: one 2-wide instanced stereo rendering pass for context displays and another for the focus displays.
The scene is rendered in one two-wide instanced stereo rendering pass for the context displays. Focus views are not rendered and foveated rendering is disabled.
If this is selected, Unity will perform an extra culling pass for the focus displays. Otherwise the culling results for the context displays will be reused for focus displays (this is the default, and is typically recommended).
If selected, foveated rendering is enabled for the application.
A scaling factor that can be used to reduce the rendering resolution of the context display surfaces.
A scaling factor that can be used to reduce the rendering resolution of the focus display surfaces.
This checkbox can be used to tell the Varjo Compositor that the submitted surfaces are meant to be opaque and that the compositor should not perform any alpha blending against possible background applications when rendering the surfaces.
If selected, the compositor disables warping for the layer. Use only if the camera is face-locked.
If selected, the rendering results will be flipped upside down before submitting them to the compositor. Select this if your scene appears upside down in the HMD.
If selected, the occlusion mesh is enabled.
This priority value is used when multiple clients are running at the same time. Sessions with higher priority render on top of lower ones.
If selected, the application will pass depth surfaces to the compositor (alongside the color surfaces). This allows the compositor to use positional timewarp to improve rendering quality.
This checkbox can be used to tell the Varjo Compositor that the application wants its contents to participate in per-pixel depth sorting: If other applications (or the Video See-Through view in XR headsets) have pixels closer to the camera than this application, they will get displayed instead of the pixels from this application. 'Submit Depth' should be enabled when using this option.
If selected, the depth test range is enabled. Use Depth Test Near Z and Far Z to control the range inside which the depth test will be evaluated.
Minimum depth included in the depth test range.
Maximum depth included in the depth test range.
For more information about the Varjo XR Plugin visit developer.varjo.com.