OVRWindow is an Oculus SDK wrapper for Qt applications that uses the OpenGL API. The full documentation can be found here.
The OVRWindow API depends on the C API introduced in Oculus SDK 0.4 and later.
OVRWindow inherits from the QWindow and QOpenGLFunctions classes that belong to the revised Qt GUI module introduced in Qt5, meaning that prior versions of the Qt library are not supported by this API. While Qt5 provides a modern way of using the OpenGL API, it is still relatively new (as of August, 2014) and a few features that exist in prior versions of Qt are still not fully implemented. One such feature is an API that provides easy access to the native display device (required by the Oculus SDK). The current solution is to use a part of the Qt Platform Abstraction (QPA) that is strongly-coupled to the version of Qt it was built against. Consequently, this is not a portable solution but will very likely become one as the QPA API matures.
The final requirement is a C++ compiler that implements the C++11 standard, at least.
To be able to use the provided project include file, the environment variable OVRSDK must be defined as the path to a valid Oculus SDK installation.
When building a project from QtCreator, this variable and its corresponding path must be added to the current build configuration's 'Build Environment' found in project mode (CTRL+4). Make sure to remember that each build configuration has its own build environment!
When building a project from the command line, then OVRSDK needs to be exported as an environment variable.
If the name OVRSDK conflicts with your system, line #4 of ovrwindow.pri can be changed from
OVRSDK = $$(OVRSDK) to OVRSDK = $$(<CUSTOM_PATH_TO_OVR_SDK>) where <CUSTOM_PATH_TO_OVR_SDK>
is either an environment variable that contains the path to a valid installation of the Oculus SDK,
or an absolute path to the aforementioned SDK.
Before using the OVRWindow API, make sure all previous requirements are met.
The project include file src/ovrwindow.pri included with the API's source code provides a configuration that will help build the API. The first step is to simply include this file in your project file (*.pro). Next, add the locations of OVRWindow.h and OVRWindow.cpp to the HEADERS and SOURCES variables in the same project file, respectively.
Check out the sample for a working project file example.
The folders provided with this software are structured in the following manner:
- doc contains the OVRWindow API's documentation.
- sample contains a simple example on how to use OVRWindow.
- src contains the source code tree.
- tst contains unit tests.