Wrapper around Oculus Rift Devkit 2. More...

#include <SLGLOculus.h>

Public Member Functions
	SLGLOculus (SLstring shaderDir)

	~SLGLOculus ()

void	init ()

const SLQuat4f &	orientation (SLEyeType eye)

const SLVec3f &	position (SLEyeType eye)

const SLVec3f &	viewAdjust (SLEyeType eye)

const SLMat4f &	projection (SLEyeType eye)

const SLMat4f &	orthoProjection (SLEyeType eye)

SLfloat	resolutionScale ()

void	renderResolution (SLint width, SLint height)

void	beginFrame ()

void	renderDistortion (SLint width, SLint height, SLuint tex, const SLCol4f &background)

void	lowPersistance (SLbool val)

void	timeWarp (SLbool val)

void	positionTracking (SLbool val)

void	displaySleep (SLbool val)

SLbool	isConnected ()

SLbool	isCameraConnected ()

SLbool	isPositionTracked ()

SLbool	isPositionTrackingEnabled ()

SLbool	isLowPersistanceEnabled ()

SLbool	isTimeWarpEnabled ()

Private Member Functions
void	dispose ()

void	calculateHmdValues ()
	recalculate HMD settings changed More...

Private Attributes
SLVec2i	_outputRes
	output resolution used for ortho projection More...

SLQuat4f	_orientation [2]
	eye orientation More...

SLVec3f	_position [2]
	eye position More...

SLMat4f	_projection [2]
	projection matrices for left and right eye More...

SLMat4f	_orthoProjection [2]
	projection for 2d elements More...

SLVec3f	_viewAdjust [2]
	view adjust vector More...

SLGLVertexArray	_distortionMeshVAO [2]
	distortion meshes for left and right eye More...

SLfloat	_resolutionScale
	required resolution scale for a 1.0 min pixel density More...

SLbool	_usingDebugHmd
	we're using a debug HMD More...

SLbool	_positionTrackingEnabled
	is position tracking enabled More...

SLbool	_lowPersistanceEnabled
	low persistence rendering enabled More...

SLbool	_timeWarpEnabled
	time warp correction enabled More...

SLbool	_displaySleep
	is the display of the rift currently off More...

SLbool	_isConnected
	is HMD connected More...

SLbool	_isCameraConnected
	is position tracker camera connected More...

SLbool	_isPositionTracked
	is the position tracked (false if out of range) More...

SLVec2i	_resolution
	Resolution of the HMD. More...

SLVec2i	_rtSize
	Required resolution for the render target. More...

SLbool	_hmdSettingsChanged
	settings need to be updated flag More...

SLGLProgram *	_stereoOculusDistProgram = nullptr

SLstring	_shaderFileDir

Detailed Description

Wrapper around Oculus Rift Devkit 2.

This class is depricated since the lib_ovr from Oculus completely changed The lib_ovr that connects the Oculus hardware was removed since it only worked for devkit2 under windows.

Definition at line 36 of file SLGLOculus.h.

Constructor & Destructor Documentation

◆ SLGLOculus()

SLGLOculus::SLGLOculus ( SLstring shaderDir )

Constructor initializing with default values

Definition at line 19 of file SLGLOculus.cpp.

   : _usingDebugHmd(false),
     _positionTrackingEnabled(false),
     _lowPersistanceEnabled(false),
     _timeWarpEnabled(false),
     _displaySleep(false),
     _isConnected(false),
     _isCameraConnected(false),
     _isPositionTracked(false),
     _shaderFileDir(shaderDir)
 {
 }

◆ ~SLGLOculus()

SLGLOculus::~SLGLOculus ( )

Destructor calling dispose

Definition at line 34 of file SLGLOculus.cpp.

 {
     dispose();
  
     if (_stereoOculusDistProgram)
     {
         delete _stereoOculusDistProgram;
         _stereoOculusDistProgram = nullptr;
     }
 }

Member Function Documentation

◆ beginFrame()

void SLGLOculus::beginFrame ( )

Updates rift status and collects data for timewarp

Definition at line 195 of file SLGLOculus.cpp.

 {
     // update changed settings
     if (_hmdSettingsChanged)
         calculateHmdValues();
 }

◆ calculateHmdValues()

void SLGLOculus::calculateHmdValues ( )

private

recalculate HMD settings changed

Recalculates values such as projection or render target size This function gets called whenever some settings changed.

Definition at line 151 of file SLGLOculus.cpp.

 {
     for (SLint i = 0; i < 2; ++i)
     {
         _position[i].set(0, 0, 0);
         _orientation[i].set(0, 0, 0, 1);
         _viewAdjust[i].set((i * 2 - 1) * 0.03f, 0, 0); //[-0.03, 0.03]m
  
         ovrFovPort fov;
         fov.DownTan    = 1.329f;
         fov.UpTan      = 1.329f;
         fov.LeftTan    = 1.058f;
         fov.RightTan   = 1.092f;
         _projection[i] = CreateProjection(true, fov, 0.01f, 10000.0f);
  
         _orthoProjection[i] = ovrMatrix4f_OrthoSubProjection(_projection[i],
                                                              SLVec2f(1.0f / (549.618286f * ((SLfloat)_outputRes.x / _resolution.x)),
                                                                      1.0f / (549.618286f * ((SLfloat)_outputRes.x / _resolution.x))),
                                                              0.8f,
                                                              _viewAdjust[i].x);
  
         SLMat4f flipY(1.0f, 0.0f, 0.0f, 0.0f, 0.0f, -1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f);
         _orthoProjection[i] = flipY * _orthoProjection[i];
     }
  
     // done
     _hmdSettingsChanged = false;
 }

◆ displaySleep()

void SLGLOculus::displaySleep ( SLbool val )

enable or disable position tracking

Definition at line 258 of file SLGLOculus.cpp.

 {
     if (val == _displaySleep)
         return;
  
     _displaySleep       = val;
     _hmdSettingsChanged = true;
 }

◆ dispose()

void SLGLOculus::dispose ( )

private

Deletes the buffer object

Definition at line 47 of file SLGLOculus.cpp.

48 {

49 }

◆ init()

void SLGLOculus::init ( )

Initialization of the Oculus Rift SDK and the device recognition.

Definition at line 53 of file SLGLOculus.cpp.

 {
     _stereoOculusDistProgram = new SLGLProgramGeneric(nullptr,
                                                       _shaderFileDir + "StereoOculusDistortionMesh.vert",
                                                       _shaderFileDir + "StereoOculusDistortionMesh.frag");
     _resolutionScale         = 1.25f;
     _resolution.set(1920, 1080);
     renderResolution(1920, 1080);
  
     for (SLint i = 0; i < 2; ++i)
     {
         _position[i].set(0, 0, 0);
         _orientation[i].set(0, 0, 0, 1);
         _viewAdjust[i].set((i * 2 - 1) * 0.03f, 0, 0); //[-0.03, 0.03]m
  
         // not 100% correct projections but it just has to look somewhat right
         _projection[i].perspective(125.0f, 0.88f, 0.1f, 1000.0f);
         _projection[i].translate(-_viewAdjust[i]);
     }
  
     createSLDistortionMesh(_stereoOculusDistProgram, ET_left, _distortionMeshVAO[0]);
     createSLDistortionMesh(_stereoOculusDistProgram, ET_right, _distortionMeshVAO[1]);
 }

◆ isCameraConnected()

SLbool SLGLOculus::isCameraConnected ( )

inline

Definition at line 66 of file SLGLOculus.h.

66 { return _isCameraConnected; }

◆ isConnected()

SLbool SLGLOculus::isConnected ( )

inline

Definition at line 65 of file SLGLOculus.h.

65 { return _isConnected; }

◆ isLowPersistanceEnabled()

SLbool SLGLOculus::isLowPersistanceEnabled ( )

inline

Definition at line 70 of file SLGLOculus.h.

70 { return _lowPersistanceEnabled; }

◆ isPositionTracked()

SLbool SLGLOculus::isPositionTracked ( )

inline

Definition at line 67 of file SLGLOculus.h.

67 { return _isPositionTracked; }

◆ isPositionTrackingEnabled()

SLbool SLGLOculus::isPositionTrackingEnabled ( )

inline

Definition at line 69 of file SLGLOculus.h.

69 { return _positionTrackingEnabled; }

◆ isTimeWarpEnabled()

SLbool SLGLOculus::isTimeWarpEnabled ( )

inline

Definition at line 71 of file SLGLOculus.h.

71 { return _timeWarpEnabled; }

◆ lowPersistance()

void SLGLOculus::lowPersistance ( SLbool val )

enable or disable low persistance

Definition at line 225 of file SLGLOculus.cpp.

 {
     if (val == _lowPersistanceEnabled)
         return;
  
     _lowPersistanceEnabled = val;
     _hmdSettingsChanged    = true;
 }

◆ orientation()

const SLQuat4f & SLGLOculus::orientation ( SLEyeType eye )

Returns the Oculus orientation as quaternion. If no Oculus Rift is recognized it returns a unit quaternion.

Definition at line 205 of file SLGLOculus.cpp.

 {
     if (eye == ET_left)
         return _orientation[0];
     else
         return _orientation[1];
 }

◆ orthoProjection()

const SLMat4f & SLGLOculus::orthoProjection ( SLEyeType eye )

Returns an orthogonal projection matrix for the specified eye

Definition at line 140 of file SLGLOculus.cpp.

 {
     if (eye == ET_left)
         return _orthoProjection[0];
     else
         return _orthoProjection[1];
 }

◆ position()

const SLVec3f & SLGLOculus::position ( SLEyeType eye )

Returns the Oculus position.

Definition at line 215 of file SLGLOculus.cpp.

 {
     if (eye == ET_left)
         return _position[0];
     else
         return _position[1];
 }

◆ positionTracking()

void SLGLOculus::positionTracking ( SLbool val )

enable or disable position tracking

Definition at line 247 of file SLGLOculus.cpp.

 {
     if (val == _positionTrackingEnabled)
         return;
  
     _positionTrackingEnabled = val;
     _hmdSettingsChanged      = true;
 }

◆ projection()

const SLMat4f & SLGLOculus::projection ( SLEyeType eye )

Returns an perspective projection matrix for the specified eye

Definition at line 129 of file SLGLOculus.cpp.

 {
     if (eye == ET_left)
         return _projection[0];
     else
         return _projection[1];
 }

◆ renderDistortion()

void SLGLOculus::renderDistortion	(	SLint	width,
		SLint	height,
		SLuint	tex,
		const SLCol4f &	background
	)

Renders the distortion mesh with time warp and chromatic abberation

Definition at line 79 of file SLGLOculus.cpp.

 {
     assert(_stereoOculusDistProgram && "SLGLOculus::renderDistortion: shader program not set");
     SLGLProgram* sp = _stereoOculusDistProgram;
  
     glViewport(0, 0, width, height);
     glBindFramebuffer(GL_FRAMEBUFFER, 0);
     glClearColor(0, 0, 0, 1);
     glClear(GL_COLOR_BUFFER_BIT);
     glDisable(GL_DEPTH_TEST);
     glDisable(GL_CULL_FACE);
     glActiveTexture(GL_TEXTURE0);
     glBindTexture(GL_TEXTURE_2D, tex);
  
     sp->beginUse(nullptr, nullptr, nullptr);
  
     for (auto& eye : _distortionMeshVAO)
     {
         sp->uniform1i("u_texture", 0);
         sp->uniform2f("u_eyeToSourceUVScale", 0.232f, -0.376f);
         sp->uniform2f("u_eyeToSourceUVOffset", 0.246f, 0.5f);
         SLMat4f identity;
  
         sp->uniformMatrix4fv("u_eyeRotationStart", 1, identity.m());
         sp->uniformMatrix4fv("u_eyeRotationEnd", 1, identity.m());
         eye.drawElementsAs(PT_triangles);
     }
  
     sp->endUse();
  
     glEnable(GL_DEPTH_TEST);
     glEnable(GL_CULL_FACE);
 }

◆ renderResolution()

void SLGLOculus::renderResolution	(	SLint	width,
		SLint	height
	)

Specify the final output resolution for this rift

Definition at line 182 of file SLGLOculus.cpp.

 {
     if (width == _outputRes.x && height == _outputRes.y)
         return;
  
     _outputRes.x = width;
     _outputRes.y = height;
  
     _hmdSettingsChanged = true;
 }

◆ resolutionScale()

SLfloat SLGLOculus::resolutionScale ( )

inline

Definition at line 51 of file SLGLOculus.h.

51 { return _resolutionScale; }

◆ timeWarp()

void SLGLOculus::timeWarp ( SLbool val )

enable or disable timewarp

Definition at line 236 of file SLGLOculus.cpp.

 {
     if (val == _timeWarpEnabled)
         return;
  
     _timeWarpEnabled    = val;
     _hmdSettingsChanged = true;
 }

◆ viewAdjust()

const SLVec3f & SLGLOculus::viewAdjust ( SLEyeType eye )

Returns the view adjust vector as reported by the HMD for the specified eye

Definition at line 118 of file SLGLOculus.cpp.

 {
     if (eye == ET_left)
         return _viewAdjust[0];
     else
         return _viewAdjust[1];
 }

Member Data Documentation

◆ _displaySleep

SLbool SLGLOculus::_displaySleep

private

is the display of the rift currently off

Definition at line 94 of file SLGLOculus.h.

◆ _distortionMeshVAO

SLGLVertexArray SLGLOculus::_distortionMeshVAO[2]

private

distortion meshes for left and right eye

Definition at line 85 of file SLGLOculus.h.

◆ _hmdSettingsChanged

SLbool SLGLOculus::_hmdSettingsChanged

private

settings need to be updated flag

Definition at line 103 of file SLGLOculus.h.

◆ _isCameraConnected

SLbool SLGLOculus::_isCameraConnected

private

is position tracker camera connected

Definition at line 97 of file SLGLOculus.h.

◆ _isConnected

SLbool SLGLOculus::_isConnected

private

is HMD connected

Definition at line 96 of file SLGLOculus.h.

◆ _isPositionTracked

SLbool SLGLOculus::_isPositionTracked

private

is the position tracked (false if out of range)

Definition at line 98 of file SLGLOculus.h.

◆ _lowPersistanceEnabled

SLbool SLGLOculus::_lowPersistanceEnabled

private

low persistence rendering enabled

Definition at line 92 of file SLGLOculus.h.

◆ _orientation

SLQuat4f SLGLOculus::_orientation[2]

private

eye orientation

Definition at line 80 of file SLGLOculus.h.

◆ _orthoProjection

SLMat4f SLGLOculus::_orthoProjection[2]

private

projection for 2d elements

Definition at line 83 of file SLGLOculus.h.

◆ _outputRes

SLVec2i SLGLOculus::_outputRes

private

output resolution used for ortho projection

Definition at line 78 of file SLGLOculus.h.

◆ _position

SLVec3f SLGLOculus::_position[2]

private

eye position

Definition at line 81 of file SLGLOculus.h.

◆ _positionTrackingEnabled

SLbool SLGLOculus::_positionTrackingEnabled

private

is position tracking enabled

Definition at line 91 of file SLGLOculus.h.

◆ _projection

SLMat4f SLGLOculus::_projection[2]

private

projection matrices for left and right eye

Definition at line 82 of file SLGLOculus.h.

◆ _resolution

SLVec2i SLGLOculus::_resolution

private

Resolution of the HMD.

Definition at line 100 of file SLGLOculus.h.

◆ _resolutionScale

SLfloat SLGLOculus::_resolutionScale

private

required resolution scale for a 1.0 min pixel density

Definition at line 87 of file SLGLOculus.h.

◆ _rtSize

SLVec2i SLGLOculus::_rtSize

private

Required resolution for the render target.

Definition at line 101 of file SLGLOculus.h.

◆ _shaderFileDir

SLstring SLGLOculus::_shaderFileDir

private

Definition at line 107 of file SLGLOculus.h.

◆ _stereoOculusDistProgram

SLGLProgram* SLGLOculus::_stereoOculusDistProgram = nullptr

private

Definition at line 105 of file SLGLOculus.h.

◆ _timeWarpEnabled

SLbool SLGLOculus::_timeWarpEnabled

private

time warp correction enabled

Definition at line 93 of file SLGLOculus.h.

◆ _usingDebugHmd

SLbool SLGLOculus::_usingDebugHmd

private

we're using a debug HMD

Definition at line 90 of file SLGLOculus.h.

◆ _viewAdjust

SLVec3f SLGLOculus::_viewAdjust[2]

private

view adjust vector

Definition at line 84 of file SLGLOculus.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SLGLOculus()

◆ ~SLGLOculus()

Member Function Documentation

◆ beginFrame()

◆ calculateHmdValues()

◆ displaySleep()

◆ dispose()

◆ init()

◆ isCameraConnected()

◆ isConnected()

◆ isLowPersistanceEnabled()

◆ isPositionTracked()

◆ isPositionTrackingEnabled()

◆ isTimeWarpEnabled()

◆ lowPersistance()

◆ orientation()

◆ orthoProjection()

◆ position()

◆ positionTracking()

◆ projection()

◆ renderDistortion()

◆ renderResolution()

◆ resolutionScale()

◆ timeWarp()

◆ viewAdjust()

Member Data Documentation

◆ _displaySleep

◆ _distortionMeshVAO

◆ _hmdSettingsChanged

◆ _isCameraConnected

◆ _isConnected

◆ _isPositionTracked

◆ _lowPersistanceEnabled

◆ _orientation

◆ _orthoProjection

◆ _outputRes

◆ _position

◆ _positionTrackingEnabled

◆ _projection

◆ _resolution

◆ _resolutionScale

◆ _rtSize

◆ _shaderFileDir

◆ _stereoOculusDistProgram

◆ _timeWarpEnabled

◆ _usingDebugHmd

◆ _viewAdjust