diff options
| author | Kai Koehne <kai.koehne@qt.io> | 2020-05-22 14:24:22 +0200 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@qt.io> | 2020-05-26 15:11:41 +0200 |
| commit | 6456893c0b700960c12d615c977298cdc0b4ee1c (patch) | |
| tree | 37e7630505d21cc9f719da5d01e33d86d870ab71 /src/opengl/doc/src/qtopengl-index.qdoc | |
| parent | a716ee67fd7cb94a3de4467c5b5dd3c889c28c63 (diff) | |
Document how to use CMake for Qt OpenGL
Task-number: QTBUG-73058
Change-Id: I8ba85fbba533c882ef63c56c1b9f20becfb36ebc
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/opengl/doc/src/qtopengl-index.qdoc')
| -rw-r--r-- | src/opengl/doc/src/qtopengl-index.qdoc | 24 |
1 files changed, 11 insertions, 13 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}. |