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

Doc: fix QOpenGLWidget::defaultFramebufferObject documentation

Browse Source 
Fix the link to QSurfaceFormat::StereoBuffers, and clean the text up
a bit. If everything is a \note, then we might just as well not have
notes, so move the statement about when this function is useful out
of a note, and combine the statements elaborating on ownership and
lifetime of framebuffer and contexts into a single note.

Change-Id: I7cb1f9ff78ba760e99d639550130f5c833ad684a
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
(cherry picked from commit 47df0eb5131a5fc0decd049bd3f9eefeb26276df)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Volker Hilsheimer 2023-03-01 13:36:32 +01:00 committed by Qt Cherry-pick Bot
parent d3edb65620
commit 74078c5fc6
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/openglwidgets/qopenglwidget.cpp
View File

@ -1358,15 +1358,13 @@ GLuint QOpenGLWidget::defaultFramebufferObject() const
\return The framebuffer object handle of the specified target buffer or
\c 0 if not yet initialized.
\note Calling this overload only makes sense if \l QSurfaceFormat::StereoBuffer is enabled
and supported by the hardware. Will return the default buffer if it's not.
Calling this overload only makes sense if \l QSurfaceFormat::StereoBuffers is enabled
and supported by the hardware. If not, this method will return the default buffer.
\note The framebuffer object belongs to the context returned by context()
and may not be accessible from other contexts.
\note The context and the framebuffer object used by the widget changes when
reparenting the widget via setParent(). In addition, the framebuffer object
changes on each resize.
and may not be accessible from other contexts. The context and the framebuffer
object used by the widget changes when reparenting the widget via setParent().
In addition, the framebuffer object changes on each resize.
\since 6.5