summaryrefslogtreecommitdiffstats
path: root/examples/opengl/doc
diff options
context:
space:
mode:
authorSafiyyah Moosa <safiyyah.moosa@qt.io>2023-11-22 11:53:52 +0100
committerSafiyyah Moosa <safiyyah.moosa@qt.io>2023-12-05 12:37:30 +0100
commit11c522495d40cca0d76e47cfd1a726d07d3a97ee (patch)
tree1758f75453019f847c16bb2bc44796eeda997738 /examples/opengl/doc
parent1914f62c317075e30489701fd2efc87f3aa9367a (diff)
Docs: Add stereoscopic example to OpenGL examples
This fix uses the \ingroup command to add the stereoscopic example to the examples-widgets-opengl group. I also elaborated on the hardware requirements. Fixes: QTBUG-119280 Pick-to: 6.5 6.6 Change-Id: I6d5b992e533b897d84100f0f897aae97ef89290f Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'examples/opengl/doc')
-rw-r--r--examples/opengl/doc/src/stereoqopenglwidget.qdoc15
1 files changed, 10 insertions, 5 deletions
diff --git a/examples/opengl/doc/src/stereoqopenglwidget.qdoc b/examples/opengl/doc/src/stereoqopenglwidget.qdoc
index 6037d370df..f9e230af63 100644
--- a/examples/opengl/doc/src/stereoqopenglwidget.qdoc
+++ b/examples/opengl/doc/src/stereoqopenglwidget.qdoc
@@ -5,8 +5,16 @@
\example stereoqopenglwidget
\title QOpenGLWidget Stereoscopic Rendering Example
\examplecategory {Graphics & Multimedia}
- \brief This example shows how to create a minimal QOpenGLWidget based application
- with stereoscopic rendering support.
+ \ingroup examples-widgets-opengl
+ \brief This example shows how to create a minimal QOpenGLWidget based
+ application with stereoscopic rendering support.
+
+ \note Support for stereoscopic rendering has certain hardware requirements,
+ such as, a graphics card with stereo support, 3D glasses and specific
+ monitors.
+
+ \note This example renders two images to two separate buffers. When you
+ view the images through 3D glasses, they give a 3D holographic effect.
\image stereoexample-leftbuffer.png
@@ -16,9 +24,6 @@
The above image is what will be rendered to the right buffer.
- \note Support for stereoscopic rendering has certain hardware requirements, like
- your graphics card needs stereo support.
-
\section1 Setting the correct surface flag
To enable stereoscopic rendering you need to set the flag
QSurfaceFormat::StereoBuffers globally. Just doing it on the widget is not enough