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

Doc: Revise OpenGL module landing page

Browse Source 
Add the new qdocinc cmake and qmake snippets and reorganize some of the
sections structure.

Task-number: QTBUG-100369
Pick-to: 6.3
Change-Id: Iafa31856500e458c14feeb92bee660f44a65ffa9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Andreas Eliasson 2022-03-22 14:05:43 +01:00
parent b57e023b3b
commit 3989f56c6b
1 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
src/opengl/doc/src/qtopengl-index.qdoc
View File

@ -34,11 +34,11 @@
Qt has two main approaches to UI development: \l[QtQuick]{Qt Quick} and Qt has two main approaches to UI development: \l[QtQuick]{Qt Quick} and
\l{Qt Widgets}. They exist to support different types of user \l{Qt Widgets}. They exist to support different types of user
interfaces, and build on separate graphics engines which have been interfaces, and build on separate graphics engines that have been
optimized for each of these types. optimized for each of these types.
It is possible to combine code written in the OpenGL graphics API It is possible to combine code written in the OpenGL graphics API
with both these user interface types in Qt. This can be useful with both of these user interface types in Qt. This can be useful
when the application has its own OpenGL-dependent code, or when it when the application has its own OpenGL-dependent code, or when it
is integrating with a third-party OpenGL-based renderer. is integrating with a third-party OpenGL-based renderer.
@ -70,15 +70,29 @@
For more details on enabling OpenGL with \l[QtQuick]{Qt Quick}, see For more details on enabling OpenGL with \l[QtQuick]{Qt Quick}, see
\l{Rendering via the Qt Rendering Hardware Interface}{scenegraph renderer documentation}. \l{Rendering via the Qt Rendering Hardware Interface}{scenegraph renderer documentation}.
\section1 Overview \section1 Using the Module
\include module-use.qdocinc using qt module \include {module-use.qdocinc} {using the c++ api}
\snippet snippets/CMakeLists.txt cmake_use
See also the \l {Build with CMake} overview. \section2 Building with CMake
\include module-use.qdocinc building with qmake \include {module-use.qdocinc} {building with cmake} {OpenGL}
\snippet snippets.pro qmake_use
\section2 Building with qmake
\include {module-use.qdocinc} {building_with_qmake} {opengl}
\section1 Examples
\list
\li \l {OpenGL Window Example}
\endlist
\section1 Reference
\list
\li \l {Qt OpenGL C++ Classes} {C++ Classes}
\endlist
\section1 Module Evolution \section1 Module Evolution
\l{Changes to Qt OpenGL} lists important changes in the module API \l{Changes to Qt OpenGL} lists important changes in the module API
@ -95,15 +109,4 @@
OpenGL\reg is a trademark of Silicon Graphics, Inc. in OpenGL\reg is a trademark of Silicon Graphics, Inc. in
the United States and other countries. the United States and other countries.
\section1 Related Information
These are links to the API reference materials and related pages.
\list
\li \l{Qt OpenGL C++ Classes}{C++ Classes}
\li \l{OpenGL Window Example}
\endlist
*/ */