1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add stereoscopic example to OpenGL examples

Browse Source 
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 <laszlo.agocs@qt.io>
(cherry picked from commit 11c522495d40cca0d76e47cfd1a726d07d3a97ee)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Safiyyah Moosa 2023-11-22 11:53:52 +01:00 committed by Qt Cherry-pick Bot
parent c98a4863dd
commit dc86b61d77
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
examples/opengl/doc/src/stereoqopenglwidget.qdoc
View File

@ -5,8 +5,16 @@
\example stereoqopenglwidget \example stereoqopenglwidget
\title QOpenGLWidget Stereoscopic Rendering Example \title QOpenGLWidget Stereoscopic Rendering Example
\examplecategory {Graphics & Multimedia} \examplecategory {Graphics & Multimedia}
\brief This example shows how to create a minimal QOpenGLWidget based application \ingroup examples-widgets-opengl
with stereoscopic rendering support. \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 \image stereoexample-leftbuffer.png
@ -16,9 +24,6 @@
The above image is what will be rendered to the right buffer. 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 \section1 Setting the correct surface flag
To enable stereoscopic rendering you need to set the flag To enable stereoscopic rendering you need to set the flag
QSurfaceFormat::StereoBuffers globally. Just doing it on the widget is not enough QSurfaceFormat::StereoBuffers globally. Just doing it on the widget is not enough