StereoDevice (JOGL, NativeWindow and NEWT APIs)

```
public interface StereoDevice
```
Interface describing a native stereoscopic device

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEBUG`
`static boolean`	`DUMP_DATA`
`static int`	`SENSOR_ORIENTATION` Sensor Bit: Orientation tracking
`static int`	`SENSOR_POSITION` Sensor Bit: Positional tracking
`static int`	`SENSOR_YAW_CORRECTION` Sensor Bit: Yaw correction

Method Summary

Methods
Modifier and Type	Method and Description
`StereoDeviceRenderer`	`createRenderer(int distortionBits, int textureCount, float[] eyePositionOffset, FovHVHalves[] eyeFov, float pixelsPerDisplayPixel, int textureUnit)` Create a new `StereoDeviceRenderer` instance.
`void`	`dispose()` Disposes this `StereoDevice`, if `valid`.
`float[]`	`getDefaultEyePositionOffset()` Return the device default eye position offset for `#createRenderer(int, int, float[], FovHVHalves[], float)`.
`FovHVHalves[]`	`getDefaultFOV()` Returns the device default `FovHVHalves` for all supported eyes in natural order, i.e.
`int`	`getEnabledSensorBits()` Returns the actual used sensor capability bits, e.g.
`int[]`	`getEyeRenderOrder()` Returns an array of the preferred eye rendering order.
`StereoDeviceFactory`	`getFactory()` Return the factory used to create this device.
`LocationSensorParameter`	`getLocationSensorParams()` Returns the `LocationSensorParameter` of the device if `SENSOR_POSITION` is `supported`, otherwise returns `null`.
`int`	`getMinimumDistortionBits()` Returns the minimum distortion compensation bits as required by the `StereoDeviceRenderer`, e.g.
`PointImmutable`	`getPosition()` If operation within a device spanning virtual desktop, returns the device position.
`int`	`getRecommendedDistortionBits()` Returns the recommended distortion compensation bits for the `StereoDeviceRenderer`, e.g.
`int`	`getRequiredRotation()` Returns the CCW rotation as required by this display device.
`boolean`	`getSensorsStarted()` Return true if sensors have been started, false otherwise.
`int`	`getSupportedDistortionBits()` Returns the supported distortion compensation of the `StereoDeviceRenderer`, e.g.
`int`	`getSupportedSensorBits()` Returns the supported sensor capability bits, e.g.
`DimensionImmutable`	`getSurfaceSize()` Returns the required surface size in pixel in target space.
`boolean`	`isValid()` Returns `true`, if instance is created and not `disposed`, otherwise returns `false`.
`void`	`resetLocationSensorOrigin()` Sets the location sensor's origin of this device to the current position.
`boolean`	`startSensors(int desiredSensorBits, int requiredSensorBits)` Start desired and required sensors.
`boolean`	`stopSensors()` Stop sensors.

- Field Detail
  - DEBUG
```
static final boolean DEBUG
```
  - DUMP_DATA
```
static final boolean DUMP_DATA
```
  - SENSOR_ORIENTATION
```
static final int SENSOR_ORIENTATION
```
    Sensor Bit: Orientation tracking
    
    See Also:
    Constant Field Values
  - SENSOR_YAW_CORRECTION
```
static final int SENSOR_YAW_CORRECTION
```
    Sensor Bit: Yaw correction
    
    See Also:
    Constant Field Values
  - SENSOR_POSITION
```
static final int SENSOR_POSITION
```
    Sensor Bit: Positional tracking
    
    See Also:
    Constant Field Values
- Method Detail
  - getFactory
```
StereoDeviceFactory getFactory()
```
    Return the factory used to create this device.
  - dispose
```
void dispose()
```
    Disposes this StereoDevice, if valid.
    Implementation shall stop sensors and free all resources.
  - isValid
```
boolean isValid()
```
    Returns true, if instance is created and not disposed, otherwise returns false.
  - getPosition
```
PointImmutable getPosition()
```
    If operation within a device spanning virtual desktop, returns the device position.
    Otherwise simply 0/0.
  - getSurfaceSize
```
DimensionImmutable getSurfaceSize()
```
    Returns the required surface size in pixel in target space.
  - getRequiredRotation
```
int getRequiredRotation()
```
    Returns the CCW rotation as required by this display device.
  - getDefaultEyePositionOffset
```
float[] getDefaultEyePositionOffset()
```
    Return the device default eye position offset for #createRenderer(int, int, float[], FovHVHalves[], float).
    Result is an array of float values for
    - right (positive)
    - up (positive)
    - forward (negative)
    Returns:
  - getDefaultFOV
```
FovHVHalves[] getDefaultFOV()
```
    Returns the device default FovHVHalves for all supported eyes in natural order, i.e. left and right if supported.
    Monoscopic devices return an array length of one, without the value for the right-eye!
  - getLocationSensorParams
```
LocationSensorParameter getLocationSensorParams()
```
    Returns the LocationSensorParameter of the device if SENSOR_POSITION is supported, otherwise returns null.
  - resetLocationSensorOrigin
```
void resetLocationSensorOrigin()
```
    Sets the location sensor's origin of this device to the current position.
    In case SENSOR_POSITION is not supported, this method is a no-op.
  - startSensors
```
boolean startSensors(int desiredSensorBits,
                   int requiredSensorBits)
```
    Start desired and required sensors. Returns true if action was successful, otherwise false.
    Method fails if required sensors are not supported.
    
    Parameters:
    desiredSensorBits - the desired optional sensors
    requiredSensorBits - the required sensors
    See Also:
    stopSensors(), getSensorsStarted(), getSupportedSensorBits(), getEnabledSensorBits()
  - stopSensors
```
boolean stopSensors()
```
    Stop sensors. Returns true if action was successful, otherwise false.
    
    See Also:
    startSensors(int, int), getSensorsStarted(), getSupportedSensorBits(), getEnabledSensorBits()
  - getSensorsStarted
```
boolean getSensorsStarted()
```
    Return true if sensors have been started, false otherwise.
    
    See Also:
    startSensors(int, int), stopSensors(), getSupportedSensorBits(), getEnabledSensorBits()
  - getSupportedSensorBits
```
int getSupportedSensorBits()
```
    Returns the supported sensor capability bits, e.g. SENSOR_ORIENTATION, SENSOR_POSITION of the StereoDevice.
    
    See Also:
    startSensors(int, int), stopSensors(), getSensorsStarted(), getEnabledSensorBits()
  - getEnabledSensorBits
```
int getEnabledSensorBits()
```
    Returns the actual used sensor capability bits, e.g. SENSOR_ORIENTATION, SENSOR_POSITION in case the device supports them and if they are enabled.
    
    See Also:
    startSensors(int, int), stopSensors(), getSensorsStarted(), getSupportedSensorBits()
  - getEyeRenderOrder
```
int[] getEyeRenderOrder()
```
    Returns an array of the preferred eye rendering order. The array length reflects the supported eye count.
    Monoscopic devices only support one eye, where stereoscopic device two eyes.
  - getSupportedDistortionBits
```
int getSupportedDistortionBits()
```
    Returns the supported distortion compensation of the StereoDeviceRenderer, e.g. StereoDeviceRenderer.DISTORTION_BARREL, StereoDeviceRenderer.DISTORTION_CHROMATIC, etc.
    
    See Also:
    StereoDeviceRenderer.getDistortionBits(), createRenderer(int, int, float[], FovHVHalves[], float, int), getRecommendedDistortionBits(), getMinimumDistortionBits()
  - getRecommendedDistortionBits
```
int getRecommendedDistortionBits()
```
    Returns the recommended distortion compensation bits for the StereoDeviceRenderer, e.g. StereoDeviceRenderer.DISTORTION_BARREL, StereoDeviceRenderer.DISTORTION_CHROMATIC StereoDeviceRenderer.DISTORTION_VIGNETTE.
    User shall use the recommended distortion compensation to achieve a distortion free view.
    
    See Also:
    StereoDeviceRenderer.getDistortionBits(), createRenderer(int, int, float[], FovHVHalves[], float, int), getSupportedDistortionBits(), getMinimumDistortionBits()
  - getMinimumDistortionBits
```
int getMinimumDistortionBits()
```
    Returns the minimum distortion compensation bits as required by the StereoDeviceRenderer, e.g. StereoDeviceRenderer.DISTORTION_BARREL in case the stereoscopic display uses [a]spherical lenses.
    Minimum distortion compensation bits are being enforced by the StereoDeviceRenderer.
    
    See Also:
    getSupportedDistortionBits(), getRecommendedDistortionBits(), StereoDeviceRenderer.getDistortionBits(), createRenderer(int, int, float[], FovHVHalves[], float, int)
  - createRenderer
```
StereoDeviceRenderer createRenderer(int distortionBits,
                                  int textureCount,
                                  float[] eyePositionOffset,
                                  FovHVHalves[] eyeFov,
                                  float pixelsPerDisplayPixel,
                                  int textureUnit)
```
    Create a new StereoDeviceRenderer instance.
    
    Parameters:
    distortionBits - StereoDeviceRenderer distortion bits, e.g. StereoDeviceRenderer.DISTORTION_BARREL, etc, see getRecommendedDistortionBits().
    textureCount - desired texture count for post-processing, see StereoDeviceRenderer.getTextureCount() and StereoDeviceRenderer.ppAvailable()
    eyePositionOffset - eye position offset, e.g. getDefaultEyePositionOffset().
    eyeFov - FovHVHalves[] field-of-view per eye, e.g. getDefaultFOV(). May contain only one value for monoscopic devices, see getEyeRenderOrder().
    pixelsPerDisplayPixel -
    textureUnit -
    
    Returns:

Interface StereoDevice

Field Summary

Method Summary

Field Detail

DEBUG

DUMP_DATA

SENSOR_ORIENTATION

SENSOR_YAW_CORRECTION

SENSOR_POSITION

Method Detail

getFactory

dispose

isValid

getPosition

getSurfaceSize

getRequiredRotation

getDefaultEyePositionOffset

getDefaultFOV

getLocationSensorParams

resetLocationSensorOrigin

startSensors

stopSensors

getSensorsStarted

getSupportedSensorBits

getEnabledSensorBits

getEyeRenderOrder

getSupportedDistortionBits

getRecommendedDistortionBits

getMinimumDistortionBits

createRenderer