summaryrefslogtreecommitdiffstats
path: root/src/opengl/doc/src/qtopengl-index.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/opengl/doc/src/qtopengl-index.qdoc')
-rw-r--r--src/opengl/doc/src/qtopengl-index.qdoc69
1 files changed, 24 insertions, 45 deletions
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc
index e4980e5974..7ea1635827 100644
--- a/src/opengl/doc/src/qtopengl-index.qdoc
+++ b/src/opengl/doc/src/qtopengl-index.qdoc
@@ -1,29 +1,5 @@
-/****************************************************************************
-**
-** Copyright (C) 2020 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
+// Copyright (C) 2020 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page qtopengl-index.html
@@ -34,11 +10,11 @@
Qt has two main approaches to UI development: \l[QtQuick]{Qt Quick} and
\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.
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
is integrating with a third-party OpenGL-based renderer.
@@ -70,15 +46,29 @@
For more details on enabling OpenGL with \l[QtQuick]{Qt Quick}, see
\l{Rendering via the Qt Rendering Hardware Interface}{scenegraph renderer documentation}.
- \section1 Overview
+ \section1 Using the Module
- \include module-use.qdocinc using qt module
- \snippet snippets/CMakeLists.txt cmake_use
+ \include {module-use.qdocinc} {using the c++ api}
- See also the \l {Build with CMake} overview.
+ \section2 Building with CMake
- \include module-use.qdocinc building with qmake
- \snippet snippets/snippets.pro qmake_use
+ \include {module-use.qdocinc} {building with cmake} {OpenGL}
+
+ \section2 Building with qmake
+
+ \include {module-use.qdocinc} {building_with_qmake} {opengl}
+
+ \section1 Examples
+
+ \list
+ \li \l {Qt OpenGL Examples}
+ \endlist
+
+ \section1 Reference
+
+ \list
+ \li \l {Qt OpenGL C++ Classes} {C++ Classes}
+ \endlist
\section1 Module Evolution
\l{Changes to Qt OpenGL} lists important changes in the module API
@@ -95,15 +85,4 @@
OpenGL\reg is a trademark of Silicon Graphics, Inc. in
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
-
*/