diff options
Diffstat (limited to 'src/doc/src/qt3dextras-module.qdoc')
-rw-r--r-- | src/doc/src/qt3dextras-module.qdoc | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/src/doc/src/qt3dextras-module.qdoc b/src/doc/src/qt3dextras-module.qdoc new file mode 100644 index 000000000..7aa042160 --- /dev/null +++ b/src/doc/src/qt3dextras-module.qdoc @@ -0,0 +1,132 @@ +/**************************************************************************** +** +** Copyright (C) 2016 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 Qt3DExtras + \title Qt 3D Extras C++ Classes + \keyword Qt 3D Extras + \preliminary + + \brief The Qt 3D Extras module provides a set of prebuilt elements to help + you get started with Qt 3D. + + This module is still in development but is available as a technology preview. + This means it is unstable, likely to change and provided as a convenience only. + + \ingroup modules + \ingroup qt3d-modules-preliminary + \qtvariable 3dextras + + \code + #include <Qt3DExtras> + \endcode + + To link against the corresponding C++ library, add the following to your qmake project file: + + \badcode + QT += 3dextras + \endcode + + Classes, types, and functions are declared under the \l [Qt3DExtras]{Qt3DExtras} namespace. + + \section1 Overview + + \section2 Materials + + \annotatedlist qt3d-extras-materials + + \section2 Meshes and Geometries + + \annotatedlist qt3d-extras-geometries + + \section2 Camera Controllers + + \annotatedlist qt3d-extras-cameracontrollers + + \section2 Entities + + \list + \li Qt3DExtras::QSkyboxEntity + \endlist + + \section2 FrameGraphs + + \list + \li Qt3DExtras::QForwardRenderer + \endlist + + \section2 Window + + \list + \li Qt3DExtras::Qt3DWindow + \endlist + + \note The Quick3DExtras module also specifies a Qt3DExtras::Quick::Qt3DQuickWindow. + + \section1 Reference + \list + \li \l {Qt 3D Extras C++ Classes} + \li \l {Qt 3D Examples} + \endlist + */ + +/*! + \namespace Qt3DExtras + \inmodule Qt3DExtras + \ingroup qt3d-namespaces + + \brief Contains classes from the Qt3DExtras module. +*/ + +/*! + \qmlmodule Qt3D.Extras 2.0 + \title Qt 3D Extras QML Types + \preliminary + + \ingroup qmlmodules + \ingroup qt3d-qmlmodules-preliminary + + \brief Provides Qt 3D QML types for the extras module. + + To import and use the module's QML types, use the following statement: + + \badcode + import Qt3D.Extras 2.0 + \endcode +*/ |