This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Varjo Output with Varjo Plugin

The Varjo plugin supports Varjo head-mounted displays. It is assumed that you already have Varjo Base and SteamVR installed.

Notice
  • The plugin is available only for Windows due to the system requirements for the Varjo devices.
  • This plugin cannot be used in a Qt-based application.

Both the windowed and the full screen modes are supported. By default, on the PC display the image is rendered in mono mode (image from the left eye). Use setViewportMode() to change the mode to stereo (both eyes) as follows:

Supported Devices#

The following Varjo device models are supported:

  • Varjo VR-2
  • Varjo VR-2 Pro
  • Varjo XR-3

Supported Features#

The table lists all Varjo native features with an indication which of them are supported in the Varjo plugin:

Features Varjo Plugin
Supported graphics APIs DX11
Human-eye resolution Supported
Eye tracking Supported
Eye tracking parameters Supported
Eye camera datastream Not supported
Mixed reality (MR) Supported
MR environment reflections Supported
MR post-process shaders Not supported
MR datastream Supported
Chroma keying Supported
Varjo Markers Supported
Depth buffer submission Supported
Velocity buffer submission Supported
Multi-app support Not supported
Support for multiple layers Supported
Occlusion mask Not supported
Instanced rendering Not supported
Foveated rendering Supported
SLI-compatible Not supported

See Also

Implementing Unigine Application with Varjo Support#

To use the Varjo virtual display with Unigine, perform the following:

  1. Download Varjo SDK and perform all required steps.
  2. Create a new project with Varjo support via UNIGINE SDK Browser: click Plugins, check the Varjo support (Varjo plugin) option in the form that opens and click OK.

    Notice
    To add Varjo support to an existing project, in UNIGINE SDK Browser, click Other Actions -> Configure Project -> Plugins -> Varjo support (Varjo plugin) -> OK.

  3. Implement the application logic by using functions of the Varjo plugin API.
  4. Plug in the Varjo virtual display.
  5. Launch the Varjo plugin on the application start-up.

Launching Varjo#

To launch the plugin, specify the extern_plugin command line option on the application start-up:

Shell commands
main_x64.exe -extern_plugin "Varjo"

If you run the application via UNIGINE SDK Browser, set the Stereo 3D option to Varjo in the Options tab and click Apply.

Console Commands#

The following console commands can be run for the Varjo plugin.

Name Description Arguments
varjo_set_focus_supersampling_factor
  • Command. Sets the additional supersampling factor for the Varjo focus viewport.
  • Variable. Print the value setting the additional supersampling factor for the Varjo focus viewport.

Additional supersampling factor, a float value greater than 0

(1.0 by default)

varjo_get_focus_supersampling_factor
  • Command. Returns the additional supersampling factor for the Varjo focus viewport.
Last update: 2022-10-04
Build: ()