Warning: That file was not part of the compilation database. It may have many parsing errors.
1 | /**************************************************************************** |
---|---|
2 | ** |
3 | ** Copyright (C) 2014 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 Qt3DRender |
30 | \title Qt 3D Render C++ Classes |
31 | \brief The Qt 3D Render module contains functionality to support 2D and 3D |
32 | rendering using Qt 3D. |
33 | \since 5.7 |
34 | |
35 | \ingroup modules |
36 | \ingroup qt3d-modules |
37 | \qtvariable 3drender |
38 | |
39 | The Qt 3D Render module provides an aspect, components, and other supporting types necessary |
40 | to implement 2D and 3D rendering as part of the Qt 3D framework. |
41 | |
42 | To use classes from this module, add this directive into the C++ files: |
43 | |
44 | \code |
45 | #include <Qt3DRender> |
46 | \endcode |
47 | |
48 | To link against the corresponding C++ library, add the following to your qmake project file: |
49 | |
50 | \badcode |
51 | QT += 3drender |
52 | \endcode |
53 | |
54 | Classes, types, and functions are declared under the \l [Qt3DRender]{Qt3DRender} namespace. |
55 | |
56 | \section1 Overview |
57 | |
58 | The Qt 3D Render aspect offers support for data-driven configuration as described |
59 | in \l {Qt 3D Render Framegraph}. |
60 | |
61 | \section1 Reference |
62 | \list |
63 | \li \l {Qt 3D Render C++ Classes} |
64 | \li \l {Qt 3D Examples} |
65 | \endlist |
66 | */ |
67 | |
68 | /*! |
69 | \namespace Qt3DRender |
70 | \inmodule Qt3DRender |
71 | \ingroup qt3d-namespaces |
72 | |
73 | \brief Contains classes that enable 2D and 3D rendering. |
74 | */ |
75 | |
76 | /*! |
77 | \qmlmodule Qt3D.Render 2.\QtMinorVersion |
78 | \title Qt 3D Render QML Types |
79 | \since 5.7 |
80 | |
81 | \ingroup qmlmodules |
82 | \ingroup qt3d-qmlmodules |
83 | |
84 | \brief Provides Qt 3D QML types for rendering. |
85 | |
86 | To import and use the module's QML types, use the following statement: |
87 | |
88 | \qml \QtMinorVersion |
89 | import Qt3D.Render 2.\1 |
90 | \endqml |
91 | */ |
92 |
Warning: That file was not part of the compilation database. It may have many parsing errors.