From dc86b61d77a676ecdef5edf164f26876597d128e Mon Sep 17 00:00:00 2001 From: Safiyyah Moosa Date: Wed, 22 Nov 2023 11:53:52 +0100 Subject: [PATCH] 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 Change-Id: I6d5b992e533b897d84100f0f897aae97ef89290f Reviewed-by: Laszlo Agocs (cherry picked from commit 11c522495d40cca0d76e47cfd1a726d07d3a97ee) Reviewed-by: Qt Cherry-pick Bot --- examples/opengl/doc/src/stereoqopenglwidget.qdoc | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/examples/opengl/doc/src/stereoqopenglwidget.qdoc b/examples/opengl/doc/src/stereoqopenglwidget.qdoc index 6037d370dfd..f9e230af63a 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