summaryrefslogtreecommitdiffstats
path: root/src/opengl/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'src/opengl/doc/src')
-rw-r--r--src/opengl/doc/src/qtopengl-index.qdoc24
-rw-r--r--src/opengl/doc/src/qtopengl-module.qdoc26
2 files changed, 12 insertions, 38 deletions
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc
index 75eb386f6e..058907f2f5 100644
--- a/src/opengl/doc/src/qtopengl-index.qdoc
+++ b/src/opengl/doc/src/qtopengl-index.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -34,6 +34,8 @@
\warning This module should not be used anymore for new code. Please
use the corresponding OpenGL classes in \l{Qt GUI}.
+ \section1 Introduction
+
OpenGL is a standard API for rendering 3D graphics. OpenGL only
deals with 3D rendering and provides little or no support for GUI
programming issues. The user interface for an OpenGL application
@@ -46,18 +48,6 @@
other Qt widget, except that it opens an OpenGL display buffer where
you can use the OpenGL API to render the contents.
- To include the definitions of the module's classes, use the
- following directive:
-
- \snippet code/doc_src_qtopengl.cpp 0
-
- \if !defined(qtforpython)
- To link against the module, add this line to your \l qmake \c
- .pro file:
-
- \snippet code/doc_src_qtopengl.pro 1
- \endif
-
The Qt OpenGL module is implemented as a platform-independent Qt/C++
wrapper around the platform-dependent GLX (version 1.3 or later),
WGL, or AGL C APIs. Although the basic functionality provided is very
@@ -68,6 +58,14 @@
The \l{Qt OpenGL C++ Classes} page gives an overview over the available classes
in this module.
+ \include module-use.qdocinc using qt module
+ \snippet snippets/CMakeLists.txt cmake_use
+
+ See also the \l[QtDoc]{Building with CMake} overview.
+
+ \include module-use.qdocinc building with qmake
+ \snippet snippets/snippets.pro qmake_use
+
\section1 Licenses and Trademarks
The Qt OpenGL module is available under commercial licenses from \l{The Qt Company}.
diff --git a/src/opengl/doc/src/qtopengl-module.qdoc b/src/opengl/doc/src/qtopengl-module.qdoc
index 24df4aec76..aaed3311bc 100644
--- a/src/opengl/doc/src/qtopengl-module.qdoc
+++ b/src/opengl/doc/src/qtopengl-module.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -35,28 +35,4 @@
use OpenGL in Qt applications.
\warning This module should not be used anymore for new code.
-
- OpenGL is a standard API for rendering 3D graphics. OpenGL only
- deals with 3D rendering and provides little or no support for GUI
- programming issues. The user interface for an OpenGL application
- must be created with another toolkit, such as Cocoa on the \macos
- platform, Microsoft Foundation Classes (MFC) under Windows, or Qt
- on both platforms.
-
- \note OpenGL is a trademark of Silicon Graphics, Inc. in
- the United States and other countries.
-
- The Qt OpenGL module makes it easy to use OpenGL in Qt applications.
-
- To include the definitions of the module's classes, use the
- following directive:
-
- \snippet code/doc_src_qtopengl.cpp 0
-
- \if !defined(qtforpython)
- To link against the module, add this line to your \l qmake \c
- .pro file:
-
- \snippet code/doc_src_qtopengl.pro 1
- \endif
*/