Document how to use CMake for Qt OpenGL
Task-number: QTBUG-73058 Change-Id: I8ba85fbba533c882ef63c56c1b9f20becfb36ebc Reviewed-by: Paul Wicking <paul.wicking@qt.io>bb10
Kai Koehne
parent
a716ee67fd
commit
6456893c0b
|
|
@ -15,12 +15,13 @@ headerdirs += ..
|
|||
sourcedirs += .. \
|
||||
../../../examples/opengl/doc/src
|
||||
exampledirs += ../../../examples/opengl \
|
||||
../ \
|
||||
snippets
|
||||
. \
|
||||
snippets \
|
||||
..
|
||||
imagedirs += images \
|
||||
../../../examples/opengl/doc/images
|
||||
|
||||
depends += qtdoc qtcore qtgui qtwidgets qmake
|
||||
depends += qtcore qtgui qtwidgets qtdoc qmake qtcmake
|
||||
|
||||
examplesinstallpath = opengl
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
#! [cmake_use]
|
||||
find_package(Qt6 COMPONENTS OpenGL REQUIRED)
|
||||
target_link_libraries(mytarget Qt::OpenGL)
|
||||
#! [cmake_use]
|
||||
|
|
@ -1,53 +0,0 @@
|
|||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2016 The Qt Company Ltd.
|
||||
** Contact: https://www.qt.io/licensing/
|
||||
**
|
||||
** This file is part of the documentation of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:BSD$
|
||||
** 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.
|
||||
**
|
||||
** BSD License Usage
|
||||
** Alternatively, you may use this file under the terms of the BSD license
|
||||
** as follows:
|
||||
**
|
||||
** "Redistribution and use in source and binary forms, with or without
|
||||
** modification, are permitted provided that the following conditions are
|
||||
** met:
|
||||
** * Redistributions of source code must retain the above copyright
|
||||
** notice, this list of conditions and the following disclaimer.
|
||||
** * Redistributions in binary form must reproduce the above copyright
|
||||
** notice, this list of conditions and the following disclaimer in
|
||||
** the documentation and/or other materials provided with the
|
||||
** distribution.
|
||||
** * Neither the name of The Qt Company Ltd nor the names of its
|
||||
** contributors may be used to endorse or promote products derived
|
||||
** from this software without specific prior written permission.
|
||||
**
|
||||
**
|
||||
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
|
||||
**
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
//! [0]
|
||||
#include <QtOpenGL>
|
||||
//! [0]
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
#! [1]
|
||||
QT += opengl
|
||||
#! [1]
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
#! [qmake_use]
|
||||
QT += opengl
|
||||
#! [qmake_use]
|
||||
|
|
@ -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}.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue