====================================================================
 :mod:`~psychxr.drivers.libovr` - Oculus Rift interface using LibOVR
====================================================================

.. currentmodule:: psychxr.drivers.libovr

Classes and functions for using the Oculus Rift (DK2, CV1, and S) HMD and
associated peripherals via the official runtime/SDK (LibOVRRT). Currently, only
OpenGL is supported for rendering VR scenes.

**This extension module makes use of the official Oculus PC SDK. A C/C++
interface for tracking, rendering, and VR math for Oculus products. The Oculus
PC SDK is Copyright (c) Facebook Technologies, LLC and its affiliates. All
rights reserved. You must accept the 'EULA', 'Terms of Use' and 'Privacy Policy'
associated with the Oculus PC SDK to use this module in your software,
see** `Legal Documents <https://www.oculus.com/legal/terms-of-service/>`_ **to
access those documents.**

Overview
========

Classes
~~~~~~~

.. autosummary::
    LibOVRPose
    LibOVRPoseState
    LibOVRTrackingState
    LibOVRBounds
    LibOVRHmdInfo
    LibOVRHmdColorSpace
    LibOVRTrackerInfo
    LibOVRSessionStatus
    LibOVRBoundaryTestResult
    LibOVRPerfStatsPerCompositorFrame
    LibOVRPerfStats
    LibOVRHapticsInfo
    LibOVRHapticsBuffer

Functions
~~~~~~~~~

.. autosummary::
    success
    unqualifiedSuccess
    failure
    getBool
    setBool
    getInt
    setInt
    getFloat
    setFloat
    getFloatArray
    setFloatArray
    getString
    setString
    isOculusServiceRunning
    isHmdConnected
    getHmdInfo
    initialize
    create
    checkSessionStarted
    destroyTextureSwapChain
    destroyMirrorTexture
    destroy
    shutdown
    getGraphicsLUID
    setHighQuality
    setHeadLocked
    getPixelsPerTanAngleAtCenter
    getTanAngleToRenderTargetNDC
    getPixelsPerDegree
    getDistortedViewport
    getEyeRenderFov
    setEyeRenderFov
    getEyeAspectRatio
    getEyeHorizontalFovRadians
    getEyeVerticalFovRadians
    getEyeFocalLength
    calcEyeBufferSize
    getLayerEyeFovFlags
    setLayerEyeFovFlags
    createTextureSwapChainGL
    getTextureSwapChainLengthGL
    getTextureSwapChainCurrentIndex
    getTextureSwapChainBufferGL
    setEyeColorTextureSwapChain
    createMirrorTexture
    getMirrorTexture
    getSensorSampleTime
    setSensorSampleTime
    getTrackingState
    getDevicePoses
    calcEyePoses
    getHmdToEyePose
    setHmdToEyePose
    getEyeRenderPose
    setEyeRenderPose
    getEyeRenderViewport
    setEyeRenderViewport
    getEyeProjectionMatrix
    getEyeViewMatrix
    getPredictedDisplayTime
    timeInSeconds
    waitToBeginFrame
    beginFrame
    commitTextureSwapChain
    endFrame
    getTrackingOriginType
    setTrackingOriginType
    recenterTrackingOrigin
    specifyTrackingOrigin
    clearShouldRecenterFlag
    getTrackerCount
    getTrackerInfo
    getSessionStatus
    getPerfStats
    resetPerfStats
    getLastErrorInfo
    setBoundaryColor
    resetBoundaryColor
    getBoundaryVisible
    showBoundary
    hideBoundary
    getBoundaryDimensions
    testBoundary
    getConnectedControllerTypes
    updateInputState
    getButton
    getTouch
    getThumbstickValues
    getIndexTriggerValues
    getHandTriggerValues
    setControllerVibration
    getHapticsInfo
    submitControllerVibration
    getControllerPlaybackState
    cullPose

Details
=======

Classes
~~~~~~~

.. autoclass:: LibOVRPose
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRPoseState
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRTrackingState
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRBounds
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRHmdInfo
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRHmdColorSpace
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRTrackerInfo
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRSessionStatus
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRBoundaryTestResult
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRPerfStatsPerCompositorFrame
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRPerfStats
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRHapticsInfo
    :members:
    :undoc-members:
    :inherited-members:

.. autoclass:: LibOVRHapticsBuffer
    :members:
    :undoc-members:
    :inherited-members:

Functions
~~~~~~~~~

.. autofunction:: success
.. autofunction:: failure
.. autofunction:: getBool
.. autofunction:: setBool
.. autofunction:: getInt
.. autofunction:: setInt
.. autofunction:: getFloat
.. autofunction:: setFloat
.. autofunction:: getFloatArray
.. autofunction:: setFloatArray
.. autofunction:: getString
.. autofunction:: setString
.. autofunction:: isOculusServiceRunning
.. autofunction:: isHmdConnected
.. autofunction:: getHmdInfo
.. autofunction:: getHmdColorSpace
.. autofunction:: setClientColorSpace
.. autofunction:: initialize
.. autofunction:: create
.. autofunction:: checkSessionStarted
.. autofunction:: destroyTextureSwapChain
.. autofunction:: destroyMirrorTexture
.. autofunction:: destroy
.. autofunction:: shutdown
.. autofunction:: getGraphicsLUID
.. autofunction:: setHighQuality
.. autofunction:: setHeadLocked
.. autofunction:: getPixelsPerTanAngleAtCenter
.. autofunction:: getTanAngleToRenderTargetNDC
.. autofunction:: getPixelsPerDegree
.. autofunction:: getDistortedViewport
.. autofunction:: getEyeRenderFov
.. autofunction:: setEyeRenderFov
.. autofunction:: getEyeAspectRatio
.. autofunction:: getEyeHorizontalFovRadians
.. autofunction:: getEyeVerticalFovRadians
.. autofunction:: getEyeFocalLength
.. autofunction:: calcEyeBufferSize
.. autofunction:: getLayerEyeFovFlags
.. autofunction:: setLayerEyeFovFlags
.. autofunction:: createTextureSwapChainGL
.. autofunction:: getTextureSwapChainLengthGL
.. autofunction:: getTextureSwapChainCurrentIndex
.. autofunction:: getTextureSwapChainBufferGL
.. autofunction:: setEyeColorTextureSwapChain
.. autofunction:: createMirrorTexture
.. autofunction:: getMirrorTexture
.. autofunction:: getSensorSampleTime
.. autofunction:: setSensorSampleTime
.. autofunction:: getTrackingState
.. autofunction:: getDevicePoses
.. autofunction:: calcEyePoses
.. autofunction:: getHmdToEyePose
.. autofunction:: setHmdToEyePose
.. autofunction:: getEyeRenderPose
.. autofunction:: setEyeRenderPose
.. autofunction:: getEyeRenderViewport
.. autofunction:: setEyeRenderViewport
.. autofunction:: getEyeProjectionMatrix
.. autofunction:: getEyeViewMatrix
.. autofunction:: getPredictedDisplayTime
.. autofunction:: timeInSeconds
.. autofunction:: waitToBeginFrame
.. autofunction:: beginFrame
.. autofunction:: commitTextureSwapChain
.. autofunction:: endFrame
.. autofunction:: getTrackingOriginType
.. autofunction:: setTrackingOriginType
.. autofunction:: recenterTrackingOrigin
.. autofunction:: specifyTrackingOrigin
.. autofunction:: clearShouldRecenterFlag
.. autofunction:: getTrackerCount
.. autofunction:: getTrackerInfo
.. autofunction:: getSessionStatus
.. autofunction:: getPerfStats
.. autofunction:: resetPerfStats
.. autofunction:: getLastErrorInfo
.. autofunction:: setBoundaryColor
.. autofunction:: resetBoundaryColor
.. autofunction:: getBoundaryVisible
.. autofunction:: showBoundary
.. autofunction:: hideBoundary
.. autofunction:: getBoundaryDimensions
.. autofunction:: testBoundary
.. autofunction:: getConnectedControllerTypes
.. autofunction:: updateInputState
.. autofunction:: getButton
.. autofunction:: getTouch
.. autofunction:: getThumbstickValues
.. autofunction:: getIndexTriggerValues
.. autofunction:: getHandTriggerValues
.. autofunction:: setControllerVibration
.. autofunction:: submitControllerVibration
.. autofunction:: cullPose