Oculus Rift Output with AppOculus Plugin
An AppOculus plugin is used to support the Oculus Rift head-mounted display. For the correct work of the plugin Oculus Rift PC Runtime is required. Note that your customers must have runtime installed as well. The plugin supports all HMD types supported by the latest Oculus Rift PC Runtime (including Oculus Rift CV1 (Consumer Version).
The AppOculus plugin provides the VR mode that allows for rendering to both the Oculus Rift head-mounted display and the PC display. When the VR mode is disabled, the image is rendered only to the PC display. The mode can be toggled by using the engine.oculus.setEnabled() function.
Both the windowed and the full screen modes are supported. On the PC display the image is rendered as follows:
See Also
- engine.oculus functions
- app_oculus_00 sample for additional details
- OVR_CAPI.h File Reference
- The Oculus Best Practices document and the Oculus Developer Guide document that can be downloaded from the official web site.
To run the plugin sample from the Unigine SDK Browser, go to the Samples tab, choose UnigineScript -> App and run the app_oculus_00 sample.
Implementing Unigine Application with Oculus Support
To use the Oculus Rift virtual display with Unigine, perform the following:
- Get and set up the latest Oculus Rift PC Runtime.
- Create a new project with AppOculus support via Unigine SDK Browser: click Video Output Options, check the Oculus support (AppOculus plugin) option in the form that opens and clickOk.
NoticeTo add Oculus support to an existing project, in Unigine SDK Browser, click Other Actions ->Configure Project -> Video Output Options -> Oculus support (AppOculus plugin) -> Ok.
- Implement the application logic by using functions of the AppOculus plugin API. You can also change the plugin API functions or add new ones and then recompile the plugin.
- Plug in the Oculus Rift virtual display.
- Launch the AppOculus plugin on the application start-up.
Launching AppOculus
To launch the plugin, specify the extern_plugin command line option on the application start-up:
main_x86d -extern_plugin "AppOculus"If you run the application via Unigine SDK Browser, set the Stereo 3D option to Oculus Rift in the Options tab and click Apply:
AppOculus Options
The following CLI options can be specified on the application start-up:
- oculus_density - the render target pixel density. In other words, this is the ratio of the number of render target pixels to display pixels at the center of distortion. The default value is 1.0 (the render target pixel density matches the display surface at the point on the display).
- oculus_scale - the world scale. The default value is 1.0.
main_x86d -extern_plugin "AppOculus" -oculus_density 1.0 -oculus_scale 8.0Compiling AppOculus
Plugin compilation is required if you change its source code (for example, add new API functions).
In addition to Oculus Rift PC Runtime, full Oculus SDK sources are required for recompiling the AppOculus plugin:
- Get the Oculus Rift SDK.
NoticeThe 1.4 version is required.
- Set the path to the <Oculus Rift SDK>/LibOVR folder in the OCULUSROOT environment variable:
Shell commands
OCULUSROOT=<Oculus Rift SDK>/LibOVR - Compile the plugin in one of the following ways:
- By using the build script:
Shell commands
C:\UnigineSDK\utils>build.py --plugin AppOculus - Manually with Scons: go to the <UnigineSDK>\source\plugins\App\AppOculus via the command line, type sconsand pressENTER:
Shell commands
C:\UnigineSDK\source\plugins\App\AppOculus>scons - Via Microsoft Visual Studio: go to the <UnigineSDK>\source\plugins\App\AppOculus, open the appoculus_vs2013.vcxproj or appoculus_vs2015.vcxproj project and build it.
- By using the build script: