diff options
Diffstat (limited to 'src/doc/src/qt3drender-module.qdoc')
-rw-r--r-- | src/doc/src/qt3drender-module.qdoc | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc new file mode 100644 index 000000000..fabdd4220 --- /dev/null +++ b/src/doc/src/qt3drender-module.qdoc @@ -0,0 +1,103 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt3D module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** 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 Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module Qt3DRender + \title Qt 3D Render C++ Classes + \brief The Qt 3D Render module contains functionality to support 2D and 3D + rendering using Qt 3D. + \since 5.7 + + \ingroup modules + \ingroup qt3d-modules + \qtvariable 3drender + + The Qt 3D Render module provides an aspect, components, and other supporting types necessary + to implement 2D and 3D rendering as part of the Qt 3D framework. + + To use classes from this module, add this directive into the C++ files: + + \code + #include <Qt3DRender> + \endcode + + To link against the corresponding C++ library, add the following to your qmake project file: + + \badcode + QT += 3drender + \endcode + + Classes, types, and functions are declared under the \l [Qt3DRender]{Qt3DRender} namespace. + + \section1 Overview + + The Qt 3D Render aspect offers support for data-driven configuration as described + in \l {Qt 3D Render Framegraph}. + + \section1 Reference + \list + \li \l {Qt 3D Render C++ Classes} + \li \l {Qt 3D Examples} + \endlist +*/ + +/*! + \namespace Qt3DRender + \inmodule Qt3DRender + \ingroup qt3d-namespaces + + \brief Contains classes that enable 2D and 3D rendering. +*/ + +/*! + \qmlmodule Qt3D.Render 2.0 + \title Qt 3D Render QML Types + \since 5.7 + + \ingroup qmlmodules + \ingroup qt3d-qmlmodules + + \brief Provides Qt 3D QML types for rendering. + + To import and use the module's QML types, use the following statement: + + \badcode + import Qt3D.Render 2.0 + \endcode +*/ |