|
JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java (public API).
|
Interface describing a native stereoscopic device. More...
Public Member Functions | |
| StereoDeviceFactory | getFactory () |
| Return the factory used to create this device. More... | |
| void | dispose () |
Disposes this StereoDevice, if valid. More... | |
| boolean | isValid () |
Returns true, if instance is created and not disposed, otherwise returns false. More... | |
| PointImmutable | getPosition () |
| If operation within a device spanning virtual desktop, returns the device position. More... | |
| DimensionImmutable | getSurfaceSize () |
| Returns the required surface size in pixel in target space. More... | |
| int | getRequiredRotation () |
| Returns the CCW rotation as required by this display device. More... | |
| Vec3f | getDefaultEyePositionOffset () |
Return the device default eye position offset for createRenderer(int, int, Vec3f, FovHVHalves[], float). More... | |
| FovHVHalves[] | getDefaultFOV () |
Returns the device default FovHVHalves for all supported eyes in natural order, i.e. More... | |
| LocationSensorParameter | getLocationSensorParams () |
Returns the LocationSensorParameter of the device if SENSOR_POSITION is supported, otherwise returns null. More... | |
| void | resetLocationSensorOrigin () |
| Sets the location sensor's origin of this device to the current position. More... | |
| boolean | startSensors (int desiredSensorBits, int requiredSensorBits) |
| Start desired and required sensors. More... | |
| boolean | stopSensors () |
| Stop sensors. More... | |
| boolean | getSensorsStarted () |
| Return true if sensors have been started, false otherwise. More... | |
| int | getSupportedSensorBits () |
| Returns the supported sensor capability bits, e.g. More... | |
| int | getEnabledSensorBits () |
| Returns the actual used sensor capability bits, e.g. More... | |
| int[] | getEyeRenderOrder () |
| Returns an array of the preferred eye rendering order. More... | |
| int | getSupportedDistortionBits () |
Returns the supported distortion compensation of the StereoDeviceRenderer, e.g. More... | |
| int | getRecommendedDistortionBits () |
Returns the recommended distortion compensation bits for the StereoDeviceRenderer, e.g. More... | |
| int | getMinimumDistortionBits () |
Returns the minimum distortion compensation bits as required by the StereoDeviceRenderer, e.g. More... | |
| StereoDeviceRenderer | createRenderer (final int distortionBits, final int textureCount, final Vec3f eyePositionOffset, final FovHVHalves[] eyeFov, final float pixelsPerDisplayPixel, final int textureUnit) |
Create a new StereoDeviceRenderer instance. More... | |
Static Public Attributes | |
| static final boolean | DEBUG = Debug.debug("StereoDevice") |
| static final boolean | DUMP_DATA = Debug.isPropertyDefined("jogl.debug.StereoDevice.DumpData", true) |
| static final int | SENSOR_ORIENTATION = 1 << 0 |
| Sensor Bit: Orientation tracking. More... | |
| static final int | SENSOR_YAW_CORRECTION = 1 << 1 |
| Sensor Bit: Yaw correction. More... | |
| static final int | SENSOR_POSITION = 1 << 2 |
| Sensor Bit: Positional tracking. More... | |
Interface describing a native stereoscopic device.
Definition at line 40 of file StereoDevice.java.
| StereoDeviceRenderer com.jogamp.opengl.util.stereo.StereoDevice.createRenderer | ( | final int | distortionBits, |
| final int | textureCount, | ||
| final Vec3f | eyePositionOffset, | ||
| final FovHVHalves[] | eyeFov, | ||
| final float | pixelsPerDisplayPixel, | ||
| final int | textureUnit | ||
| ) |
Create a new StereoDeviceRenderer instance.
| 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 |
| void com.jogamp.opengl.util.stereo.StereoDevice.dispose | ( | ) |
Disposes this StereoDevice, if valid.
Implementation shall stop sensors and free all resources.
| Vec3f com.jogamp.opengl.util.stereo.StereoDevice.getDefaultEyePositionOffset | ( | ) |
Return the device default eye position offset for createRenderer(int, int, Vec3f, FovHVHalves[], float).
Result is an array of float values for
| FovHVHalves[] com.jogamp.opengl.util.stereo.StereoDevice.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!
| int com.jogamp.opengl.util.stereo.StereoDevice.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.
| int[] com.jogamp.opengl.util.stereo.StereoDevice.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.
| StereoDeviceFactory com.jogamp.opengl.util.stereo.StereoDevice.getFactory | ( | ) |
Return the factory used to create this device.
| LocationSensorParameter com.jogamp.opengl.util.stereo.StereoDevice.getLocationSensorParams | ( | ) |
Returns the LocationSensorParameter of the device if SENSOR_POSITION is supported, otherwise returns null.
| int com.jogamp.opengl.util.stereo.StereoDevice.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.
| PointImmutable com.jogamp.opengl.util.stereo.StereoDevice.getPosition | ( | ) |
If operation within a device spanning virtual desktop, returns the device position.
Otherwise simply 0/0.
| int com.jogamp.opengl.util.stereo.StereoDevice.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.
| int com.jogamp.opengl.util.stereo.StereoDevice.getRequiredRotation | ( | ) |
Returns the CCW rotation as required by this display device.
| boolean com.jogamp.opengl.util.stereo.StereoDevice.getSensorsStarted | ( | ) |
Return true if sensors have been started, false otherwise.
| int com.jogamp.opengl.util.stereo.StereoDevice.getSupportedDistortionBits | ( | ) |
Returns the supported distortion compensation of the StereoDeviceRenderer, e.g.
StereoDeviceRenderer#DISTORTION_BARREL, StereoDeviceRenderer#DISTORTION_CHROMATIC, etc.
| int com.jogamp.opengl.util.stereo.StereoDevice.getSupportedSensorBits | ( | ) |
Returns the supported sensor capability bits, e.g.
SENSOR_ORIENTATION, SENSOR_POSITION of the StereoDevice.
| DimensionImmutable com.jogamp.opengl.util.stereo.StereoDevice.getSurfaceSize | ( | ) |
Returns the required surface size in pixel in target space.
| boolean com.jogamp.opengl.util.stereo.StereoDevice.isValid | ( | ) |
Returns true, if instance is created and not disposed, otherwise returns false.
| void com.jogamp.opengl.util.stereo.StereoDevice.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.
| boolean com.jogamp.opengl.util.stereo.StereoDevice.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.
| desiredSensorBits | the desired optional sensors |
| requiredSensorBits | the required sensors |
| boolean com.jogamp.opengl.util.stereo.StereoDevice.stopSensors | ( | ) |
Stop sensors.
Returns true if action was successful, otherwise false.
|
static |
Definition at line 41 of file StereoDevice.java.
|
static |
Definition at line 42 of file StereoDevice.java.
|
static |
Sensor Bit: Orientation tracking.
Definition at line 47 of file StereoDevice.java.
|
static |
Sensor Bit: Positional tracking.
Definition at line 57 of file StereoDevice.java.
|
static |
Sensor Bit: Yaw correction.
Definition at line 52 of file StereoDevice.java.