summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3dinput-module.qdoc
blob: b14380e3a0ef0cddc71a7549d995a552240c4f3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/****************************************************************************
**
** 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:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module Qt3DInput
    \title Qt 3D Input C++ Classes
    \brief The Qt 3D Input module provides classes for handling user input in
           applications using Qt3D.

    \ingroup modules
    \ingroup qt3d-modules
    \qtvariable 3dinput

    To use classes from this module, add this directive into the C++ files:

    \code
       #include <Qt3DInput>
    \endcode

    To link against the corresponding C++ libraries, add the following to your qmake project file:

    \badcode
       QT += 3dinput
    \endcode
*/

/*!
    \namespace Qt3DInput
    \inmodule Qt3DInput
    \ingroup qt3d-namespaces

    \brief Contains classes that enable user input.
*/

/*!
   \qmlmodule Qt3D.Input 2.0
   \title Qt 3D Input QML Types
   \ingroup qmlmodules
   \ingroup qt3d-qmlmodules

   \brief Provides QML types for Qt 3D user input.

   To import and use the module's QML types, use the following statement:

   \badcode
   import Qt3D.Input 2.0
   \endcode

   \section1 QML Types
*/