summaryrefslogtreecommitdiffstats
path: root/examples/qt3d/simple-qml/doc/src/simple-qml.qdoc
blob: 9d4f55c52a97777ac4c5cb34a8deab9b3a509b57 (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
/****************************************************************************
**
** 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$
**
****************************************************************************/

/*!
    \example simple-qml
    \title Qt 3D: Simple QML Example
    \ingroup qt3d-examples-qml
    \brief A QML application that demonstrates how to render a scene in Qt 3D.

    \image simple-qml.png

    \e {Simple} demonstrates how to render a scene in Qt 3D.

    \include examples-run.qdocinc

    \section1 Setting Up the Scene

    We set up the entire scene in the \e main.qml file.

    To be able to use the types in the Q3D and Q3D Render modules, we must
    import the modules:

    \quotefromfile simple-qml/main.qml
    \skipto import Qt3D.Core
    \printuntil Render 2.0

    The first entities we create are a \l Camera, which represents the camera
    used for the final rendering, and a camera controller, which allows us to
    control this camera using the keyboard or the mouse:

    \skipto Camera {
    \printuntil }
    \printuntil }

    A \l RenderSettings entity specifies a ForwardRenderer as the active
    framegraph:

    \printuntil },

    The event source is set by the Qt3DQuickWindow:

    \skipto InputSettings
    \printuntil }
*/