summaryrefslogtreecommitdiffstats
path: root/README
blob: 3e8bb203c066c5112c31cb4b471916d8c54b05bf (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
This directory contains the Qt3D project:
   * QtQuick3D QML bindings and
   * Qt3D C++ APIs


Building QtQuick3D
==================

Check the building instructions in doc/src/qt3d-building.qdoc also available
online at: http://doc.qt.nokia.com/qt-quick3d-snapshot/qt3d-building.html


Whats in QtQuick3D
==================

Directory structure:

src/threed/
    This is the main library of the Qt3D project, containing abstractions
    for cross-platform GL, shaders, lighting models, and so on.
src/plugins/
    Scene format loading plugins.
src/imports/
    QML import plugins.
util/
    Various utilities that are useful when working with Qt3D.
examples/
    Some examples of using QtQuiick3D (QML bindings) and Qt3D (C++ API).
demos/
    Some more complex demos of using QtQuiick3D (QML bindings) and Qt3D (C++ API).
tests/auto/qml3d/
    Unit tests for the QtQuick3D bindings.
tests/auto/threed/
    Unit tests for the Qt3D C++ API
doc/
    Documentation.
devices/symbian/
    Symbian deployment file


Documentation
=============

The documentation can be generated with "make docs".  It will be placed
into "doc/html" in the build directory.