1/****************************************************************************
2**
3** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file. Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29    \module Qt3DExtras
30    \title Qt 3D Extras C++ Classes
31    \keyword Qt 3D Extras
32    \preliminary
33
34    \brief The Qt 3D Extras module provides a set of prebuilt elements to help
35    you get started with Qt 3D.
36
37    This module is still in development but is available as a technology preview.
38    This means it is unstable, likely to change and provided as a convenience only.
39
40    \ingroup modules
41    \ingroup qt3d-modules-preliminary
42    \qtvariable 3dextras
43
44    \code
45       #include <Qt3DExtras>
46    \endcode
47
48    To link against the corresponding C++ library, add the following to your qmake project file:
49
50    \badcode
51       QT += 3dextras
52    \endcode
53
54    Classes, types, and functions are declared under the \l [Qt3DExtras]{Qt3DExtras} namespace.
55
56    \section1 Overview
57
58    \section2 Materials
59
60    \annotatedlist qt3d-extras-materials
61
62    \section2 Meshes and Geometries
63
64    \annotatedlist qt3d-extras-geometries
65
66    \section2 Camera Controllers
67
68    \annotatedlist qt3d-extras-cameracontrollers
69
70    \section2 Entities
71
72    \list
73    \li Qt3DExtras::QSkyboxEntity
74    \endlist
75
76    \section2 FrameGraphs
77
78    \list
79    \li Qt3DExtras::QForwardRenderer
80    \endlist
81
82    \section2 Window
83
84    \list
85    \li Qt3DExtras::Qt3DWindow
86    \endlist
87
88    \note The Quick3DExtras module also specifies a Qt3DExtras::Quick::Qt3DQuickWindow.
89
90    \section1 Reference
91    \list
92    \li \l {Qt 3D Extras C++ Classes}
93    \li \l {Qt 3D Examples}
94    \endlist
95 */
96
97/*!
98    \namespace Qt3DExtras
99    \inmodule Qt3DExtras
100    \ingroup qt3d-namespaces
101
102    \brief Contains classes from the Qt3DExtras module.
103*/
104
105/*!
106   \qmlmodule Qt3D.Extras 2.\QtMinorVersion
107   \title Qt 3D Extras QML Types
108   \preliminary
109
110   \ingroup qmlmodules
111   \ingroup qt3d-qmlmodules-preliminary
112
113   \brief Provides Qt 3D QML types for the extras module.
114
115   To import and use the module's QML types, use the following statement:
116
117   \qml \QtMinorVersion
118   import Qt3D.Extras 2.\1
119   \endqml
120*/
121