diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 145 |
1 files changed, 30 insertions, 115 deletions
@@ -1,124 +1,39 @@ -This directory contains the Qt3D project for Qt5: - * QtQuick3D QML bindings and - * Qt3D C++ APIs +!!! WARNING !!! +=============== +This is not the code you're looking for! -Building QtQuick3D -================== +The qt/quick3d repository has been deprecated. We have moved to a new +repository in qt/qt3d. -Qt5 is a rapidly changing bleeding edge environment. This branch is our initial -support for it and thus is also rapidly changing and bleeding edge. +If you're working with Qt5 then to move from the (old) qml2 branch, use qt/qt3d +and it will be built as part of the qt5 build (you'll be on branch: master). -This branch is experimental, and unsupported. This information is provided for -advanced use only. +If you're working with Qt4.x you will now be working out of the qt4 branch +of the qt/qt3d repository. -No guarantees about API stability or even if this works at all are supplied, use -at your own risk. +So: For Qt5 - -First fetch the Qt5 source tree and QtQuick3D qml2 branch: +# get the sources - qt3d will be cloned as a sub-project +cd ~/depot +git clone ssh://codereview.qt-project.org:29418/qt/qt5.git +cd qt5 +./init-repository - cd ~/depot - git clone ssh://codereview.qt-project.org:29418/qt/qt5.git - cd qt5 - ./init-repository --codereview-username <username> \ - --module-subset=qtbase,qtsvg,qtdeclarative,qttools,qtxmlpatterns,qtdoc,qlalr,qtrepotools,qtqa,qtlocation,qtquick3d - git submodule foreach "git fetch gerrit && git reset --hard gerrit/master" - cd qtquick3d - scp -p -P 29418 codereview.qt-project.org:hooks/commit-msg .git/hooks/ - git fetch gerrit - git checkout --track -b qml2 gerrit/qml2 +# build - qt3d will be built as part of Qt5 +cd ~/build +mkdir qt5; cd qt5 +~/depot/qt5/configure +make -If you are reading this file then somehow you probably already got this far anyway. +For Qt4 - +# get the sources +cd ~/depot/qt +git clone ssh://codereview.qt-project.org:29418/qt/qt3d.git +cd qt3d +git checkout qt4 -Now build Qt5, which will also build QtQuick3D as a module: - - cd ~/build - mkdir qt5 - cd qt5 - ~/depot/qt5/configure -nokia-developer -no-webkit -no-phonon -nomake tests \ - -nomake demos -nomake examples -declarative -opengl -svg && make -j 4 - - -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. - - -Packages -======== - -This section is only for those developing QtQuick3D. Read on to discover how -the building of packages works. This section is also important if you want to -change how the structure of the QtQuick3D pro files work. - -QtQuick3D is intended to be built in one of two ways: - -1) Normal developer way: - qmake && make -2) Package creation way: - qmake CONFIG+=package && INSTALL_ROOT=tmp make install - -In 1) the .pro files will cause the toolchain to place the libraries, plugins -header files and other components of QtQuick3D directly into place, as part of -the compile process. What does "in place" mean? Run "qmake -query" to see -the paths where the files are placed - QML plugins go in $$[QT_INSTALL_IMPORTS] -for example. In this mode, there is no need to run "make install" because the -files are already in their target destination. Here the "target destination" -means the Qt which is being built against. - -First note that QtQuick3D has to be installed into the target Qt. This is because -QtQuick3D has QML plugins and resources, as well as shared libraries, all of which -must be resolved by the QMLViewer of the target Qt at runtime. Here where "qmake" -is referred to it means the qmake inside the target Qt. Since QtDeclarative -recommends using QMLViewer when developing and debugging QML Apps, in the developer -case - which is what Qt3D is for - it has to install directly into the target Qt. - -In this mode 1) after the main library is compiled subsequent targets can simply -resolve includes and link time dependencies by use of qt3d.prf and qtquick3d.prf. -These two files are installed into the target Qt's makespecs/features directory -during the processing of the quick3d.pro file. - -In 2) the libraries, plugins and so on are sitting inside the build tree after -the compile step. As a result in order to resolve includes and dependencies -the build system has to navigate the build tree with paths like "-L../../../threed" -to locate the Qt3D libraries. - -Actually there is one build artifact that is not just left where it lands in the -build tree - the header files. These are actually copied into an "include" -directory inside the build root directory. This is because at present the header -files all live inside their own seperate subdirectories under "threed" and would -be too cumbersome to path in explicitly. - -After building the tree the install step is invoked using the INSTALL_ROOT environment -export to cause the installation rules to place all the files into a sandboxed -install tree, ready for packaging. +# build - using your Qt 4.8 +cd ~/build/qt/qt3d +~/build/qt/48/bin/qmake quick3d.pro +make |