JOGL 2.3.2 · com.jogamp.opengl.util.stereo.StereoDeviceRenderer

Stereoscopic device rendering interface.

The following pseudo-code describes how to implement a renderer using a StereoDeviceRenderer. See StereoClientRenderer which implements the following:

device.beginFrame(GL)
For both eyes:
- device.updateViewerPose(int)
- if device.ppAvailable(): Set the render target, e.g. FBO
- Set the viewport using Eye#getViewport()
- upstream.reshapeEye(..)
- upstream.display(..).
Reset the viewport
If device.ppAvailable():
- device.ppBegin(GL)
- Use render target, e.g. FBO's texture
- device.ppBothEyes(GL) or device.ppOneEye(GL, int) for both eyes
- device.ppEnd(GL)
device.endFrame(GL)

Correct `Asymmetric FOV` Rendering

The StereoClientRenderer shall render both images for each eye correctly Off-axis utilizing an asymmetric camera frustum, i.e. by using StereoDevice's default FovHVHalves.
Some references:

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	StereoDeviceRenderer.Eye Interface describing one eye of the stereoscopic device, see `StereoDeviceRenderer#getEye(int)`.

Field Summary

Modifier and Type	Field and Description
public static final int	DISTORTION_BARREL Distortion Bit: Barrel distortion compensating lens pincushion distortion
public static final int	DISTORTION_CHROMATIC Distortion Bit: Chromatic distortion compensating lens chromatic aberration.
public static final int	DISTORTION_TIMEWARP Distortion Bit: Timewarp distortion technique to predict `ViewerPose` movement to reduce latency.
public static final int	DISTORTION_VIGNETTE Distortion Bit: Vignette distortion compensating lens chromatic aberration.

Method Summary

Modifier and Type	Method and Description
public void	beginFrame(final GL gl) Notifying that a new frame is about to start.
public void	dispose(final GL gl) Release all OpenGL related resources
public void	endFrame(final GL gl) Notifying that the frame has been rendered completely.
public StereoDevice	getDevice() Returns the `StereoDevice` of this `StereoDeviceRenderer` instance.
public int	getDistortionBits() Returns used distortion compensation bits, e.g. `DISTORTION_BARREL`, in case the stereoscopic display requires such, i.e. in case lenses are utilized.
public StereoDeviceRenderer.Eye	getEye(final int eyeNum) Returns the `Eye` instance for the denoted `eyeNum`.
public DimensionImmutable[]	getEyeSurfaceSize() Returns the surface size for each eye's a single image in pixel units.
public ViewerPose	getLastViewerPose() Returns the last `ViewerPose`.
public int	getTextureCount() Returns the used texture-image count for post-processing, see `ppAvailable()`.
public int	getTextureUnit() Returns the desired texture-image unit for post-processing, see `ppAvailable()`.
public DimensionImmutable	getTotalSurfaceSize() Returns the total surface size required for the complete images in pixel units.
public void	init(final GL gl) Initialize OpenGL related resources
public boolean	ppAvailable() Returns `true` if stereoscopic post-processing is required and available, otherwise `false`.
public void	ppBegin(final GL gl) Begin stereoscopic post-processing, see `ppAvailable()`.
public void	ppEnd(final GL gl) End stereoscopic post-processing, see `ppAvailable()`.
public void	ppOneEye(final GL gl, final int eyeNum) Performs stereoscopic post-processing for one eye, see `ppAvailable()`.
public ViewerPose	updateViewerPose() Updates the `ViewerPose` and returns it.
public boolean	usesSideBySideStereo() Method returns `true` if using side-by-side (SBS) stereoscopic images, otherwise `false`.

Field Detail

DISTORTION_BARREL	back to summary
public static final int DISTORTION_BARREL Distortion Bit: Barrel distortion compensating lens pincushion distortion

DISTORTION_CHROMATIC	back to summary
public static final int DISTORTION_CHROMATIC Distortion Bit: Chromatic distortion compensating lens chromatic aberration.

DISTORTION_TIMEWARP back to summary

DISTORTION_TIMEWARP	back to summary
public static final int DISTORTION_TIMEWARP Distortion Bit: Timewarp distortion technique to predict `ViewerPose` movement to reduce latency. FIXME: Explanation needs refinement!

public static final int DISTORTION_TIMEWARP

Distortion Bit: Timewarp distortion technique to predict ViewerPose movement to reduce latency.

FIXME: Explanation needs refinement!

DISTORTION_VIGNETTE	back to summary
public static final int DISTORTION_VIGNETTE Distortion Bit: Vignette distortion compensating lens chromatic aberration.

Method Detail

beginFrame	back to summary
public void beginFrame(final GL gl) Notifying that a new frame is about to start.

dispose	back to summary
public void dispose(final GL gl) Release all OpenGL related resources

endFrame	back to summary
public void endFrame(final GL gl) Notifying that the frame has been rendered completely.

getDevice	back to summary
public StereoDevice getDevice() Returns the `StereoDevice` of this `StereoDeviceRenderer` instance.

getDistortionBits back to summary

getDistortionBits	back to summary
public int getDistortionBits() Returns used distortion compensation bits, e.g. `DISTORTION_BARREL`, in case the stereoscopic display requires such, i.e. in case lenses are utilized. Distortion requires `post-processing`.

public int getDistortionBits()

Returns used distortion compensation bits, e.g. DISTORTION_BARREL, in case the stereoscopic display requires such, i.e. in case lenses are utilized.

Distortion requires post-processing.

getEye	back to summary
public StereoDeviceRenderer.Eye getEye(final int eyeNum) Returns the `Eye` instance for the denoted `eyeNum`.

getEyeSurfaceSize	back to summary
public DimensionImmutable[] getEyeSurfaceSize() Returns the surface size for each eye's a single image in pixel units.

getLastViewerPose	back to summary
public ViewerPose getLastViewerPose() Returns the last `ViewerPose`.

getTextureCount back to summary

getTextureCount	back to summary
public int getTextureCount() Returns the used texture-image count for post-processing, see `ppAvailable()`. In case the renderer does not support multiple textures for post-processing, or no post-processing at all, method returns zero despite the request from `StereoDevice#createRenderer(int, int, float[], com.jogamp.opengl.math.FovHVHalves[], float)`.

public int getTextureCount()

Returns the used texture-image count for post-processing, see ppAvailable().

In case the renderer does not support multiple textures for post-processing, or no post-processing at all, method returns zero despite the request from StereoDevice#createRenderer(int, int, float[], com.jogamp.opengl.math.FovHVHalves[], float).

getTextureUnit	back to summary
public int getTextureUnit() Returns the desired texture-image unit for post-processing, see `ppAvailable()`.

getTotalSurfaceSize back to summary

getTotalSurfaceSize	back to summary
public DimensionImmutable getTotalSurfaceSize() Returns the total surface size required for the complete images in pixel units. If `usesSideBySideStereo()` the total size spans over both `getEyeSurfaceSize()`, side-by-side. Otherwise the size is equal to `getEyeSurfaceSize()`.

public DimensionImmutable getTotalSurfaceSize()

Returns the total surface size required for the complete images in pixel units.

If usesSideBySideStereo() the total size spans over both getEyeSurfaceSize(), side-by-side.

Otherwise the size is equal to getEyeSurfaceSize().

init	back to summary
public void init(final GL gl) Initialize OpenGL related resources

ppAvailable back to summary

ppAvailable	back to summary
public boolean ppAvailable() Returns `true` if stereoscopic post-processing is required and available, otherwise `false`. Stereoscopic post-processing is available if: one of the distortion bits are set, see `getDistortionBits()` If stereoscopic post-processing is used the following post-processing methods must be called to before `endFrame()`: `ppBegin(GL)` `ppOneEye(GL, int)` for both eyes `ppEnd(GL)`

public boolean ppAvailable()

Returns true if stereoscopic post-processing is required and available, otherwise false.

Stereoscopic post-processing is available if:

one of the distortion bits are set, see getDistortionBits()

If stereoscopic post-processing is used the following post-processing methods must be called to before endFrame():

ppBegin back to summary

ppBegin	back to summary
public void ppBegin(final GL gl) Begin stereoscopic post-processing, see `ppAvailable()`. `updateViewerPose(int)` for both eyes must be called upfront when rendering upstream `StereoGLEventListener`.

public void ppBegin(final GL gl)

Begin stereoscopic post-processing, see ppAvailable().

updateViewerPose(int) for both eyes must be called upfront when rendering upstream StereoGLEventListener.

ppEnd	back to summary
public void ppEnd(final GL gl) End stereoscopic post-processing, see `ppAvailable()`.

ppOneEye	back to summary
public void ppOneEye(final GL gl, final int eyeNum) Performs stereoscopic post-processing for one eye, see `ppAvailable()`.

updateViewerPose	back to summary
public ViewerPose updateViewerPose() Updates the `ViewerPose` and returns it.

usesSideBySideStereo back to summary

usesSideBySideStereo	back to summary
public boolean usesSideBySideStereo() Method returns `true` if using side-by-side (SBS) stereoscopic images, otherwise `false`. SBS requires that both eye's images are presented side-by-side in the final framebuffer. Either the renderer presents the images side-by-side according to the `eye's viewport`, or `post-processing` is utilized to merge `textures` to a side-by-side configuration.

public boolean usesSideBySideStereo()

Method returns true if using side-by-side (SBS) stereoscopic images, otherwise false.

SBS requires that both eye's images are presented side-by-side in the final framebuffer.

Either the renderer presents the images side-by-side according to the eye's viewport, or post-processing is utilized to merge textures to a side-by-side configuration.

Modifier and Type	Method and Description
public EyeParameter	getEyeParameter() Returns the `EyeParameter` of this eye.
public RectangleImmutable	getViewport() Returns the viewport for this eye.

public Interface StereoDeviceRenderer

Correct `Asymmetric FOV` Rendering

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Interface StereoDeviceRenderer.Eye

Method Summary

Method Detail

public Interface StereoDeviceRenderer

Correct Asymmetric FOV Rendering

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Interface StereoDeviceRenderer.Eye

Method Summary

Method Detail

Correct `Asymmetric FOV` Rendering