diff options
-rw-r--r-- | src/animation/animation.pro | 2 | ||||
-rw-r--r-- | src/animation/doc/qt3danimation.qdocconf | 43 | ||||
-rw-r--r-- | src/core/core.pro | 2 | ||||
-rw-r--r-- | src/core/doc/qt3dcore.qdocconf | 47 | ||||
-rw-r--r-- | src/doc/qt3d-config.qdocconf | 36 | ||||
-rw-r--r-- | src/doc/qt3d.qdocconf | 91 | ||||
-rw-r--r-- | src/doc/src/levelofdetailloader.qdoc (renamed from src/render/doc/src/levelofdetailloader.qdoc) | 0 | ||||
-rw-r--r-- | src/doc/src/qcircularbuffer.qdoc (renamed from src/core/doc/src/qcircularbuffer.qdoc) | 0 | ||||
-rw-r--r-- | src/doc/src/qmlextracontrollers.qdoc (renamed from src/extras/doc/src/qmlextracontrollers.qdoc) | 0 | ||||
-rw-r--r-- | src/doc/src/qmlextramaterials.qdoc (renamed from src/extras/doc/src/qmlextramaterials.qdoc) | 0 | ||||
-rw-r--r-- | src/doc/src/qt3d-module.qdoc | 35 | ||||
-rw-r--r-- | src/doc/src/qt3danimation-module.qdoc (renamed from src/animation/doc/src/qt3danimation-module.qdoc) | 6 | ||||
-rw-r--r-- | src/doc/src/qt3dextras-module.qdoc (renamed from src/extras/doc/src/qt3dextras-module.qdoc) | 2 | ||||
-rw-r--r-- | src/doc/src/qt3dinput-module.qdoc (renamed from src/input/doc/src/qt3dinput-module.qdoc) | 1 | ||||
-rw-r--r-- | src/doc/src/qt3dlogic-module.qdoc (renamed from src/logic/doc/src/qt3dlogic-module.qdoc) | 0 | ||||
-rw-r--r-- | src/doc/src/qt3drender-framegraph.qdoc (renamed from src/render/doc/src/qt3drender-framegraph.qdoc) | 16 | ||||
-rw-r--r-- | src/doc/src/qt3drender-geometry.qdoc (renamed from src/render/doc/src/qt3drender-geometry.qdoc) | 8 | ||||
-rw-r--r-- | src/doc/src/qt3drender-module.qdoc (renamed from src/render/doc/src/qt3drender-module.qdoc) | 3 | ||||
-rw-r--r-- | src/doc/src/qt3drender-protips.qdoc (renamed from src/render/doc/src/qt3drender-protips.qdoc) | 19 | ||||
-rw-r--r-- | src/doc/src/qt3dscene2d-module.qdoc (renamed from src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc) | 2 | ||||
-rw-r--r-- | src/extras/doc/qt3dextras.qdocconf | 43 | ||||
-rw-r--r-- | src/extras/extras.pro | 2 | ||||
-rw-r--r-- | src/input/doc/qt3dinput.qdocconf | 43 | ||||
-rw-r--r-- | src/input/input.pro | 2 | ||||
-rw-r--r-- | src/logic/doc/qt3dlogic.qdocconf | 43 | ||||
-rw-r--r-- | src/logic/logic.pro | 2 | ||||
-rw-r--r-- | src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf | 45 | ||||
-rw-r--r-- | src/quick3d/quick3dscene2d/quick3dscene2d.pro | 2 | ||||
-rw-r--r-- | src/render/doc/qt3drender.qdocconf | 43 | ||||
-rw-r--r-- | src/render/render.pro | 2 |
30 files changed, 132 insertions, 408 deletions
diff --git a/src/animation/animation.pro b/src/animation/animation.pro index 066985760..b7d08416c 100644 --- a/src/animation/animation.pro +++ b/src/animation/animation.pro @@ -21,6 +21,4 @@ HEADERS += \ SOURCES += \ animationlogging.cpp -QMAKE_DOCS = $$PWD/doc/qt3danimation.qdocconf - load(qt_module) diff --git a/src/animation/doc/qt3danimation.qdocconf b/src/animation/doc/qt3danimation.qdocconf deleted file mode 100644 index 74c185e7f..000000000 --- a/src/animation/doc/qt3danimation.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../doc/qt3d-config.qdocconf) - -project = Qt3DAnimation -description = Qt 3D Animation Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DAnimation - -qhp.Qt3DAnimation.file = qt3danimation.qhp -qhp.Qt3DAnimation.namespace = org.qt-project.qt3danimation.$QT_VERSION_TAG -qhp.Qt3DAnimation.virtualFolder = qt3danimation -qhp.Qt3DAnimation.indexTitle = Qt 3D Animation -qhp.Qt3DAnimation.indexRoot = - -qhp.Qt3DAnimation.filterAttributes = qt3danimation $QT_VERSION qtrefdoc -qhp.Qt3DAnimation.customFilters.Qt.name = Qt3DAnimation $QT_VERSION -qhp.Qt3DAnimation.customFilters.Qt.filterAttributes = qt3danimation $QT_VERSION - -qhp.Qt3DAnimation.subprojects = classes qmltypes - -qhp.Qt3DAnimation.subprojects.classes.title = C++ Classes -qhp.Qt3DAnimation.subprojects.classes.indexTitle = Qt 3D Animation C++ Classes -qhp.Qt3DAnimation.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DAnimation.subprojects.classes.sortPages = true - -qhp.Qt3DAnimation.subprojects.qmltypes.title = QML Types -qhp.Qt3DAnimation.subprojects.qmltypes.indexTitle = Qt 3D Animation QML Types -qhp.Qt3DAnimation.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DAnimation.subprojects.qmltypes.sortPages = true - -tagfile = qt3danimation.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3drender qt3dlogic \ - qt3dinput qt3dextras qt3dscene2d - -sourcedirs += .. -headerdirs += .. -imagedirs += images -exampledirs += snippets diff --git a/src/core/core.pro b/src/core/core.pro index 742085ac7..8e65fafab 100644 --- a/src/core/core.pro +++ b/src/core/core.pro @@ -20,6 +20,4 @@ include(transforms/transforms.pri) include(resources/resources.pri) include(services/services.pri) -QMAKE_DOCS = $$PWD/doc/qt3dcore.qdocconf - load(qt_module) diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf deleted file mode 100644 index 3b772aec1..000000000 --- a/src/core/doc/qt3dcore.qdocconf +++ /dev/null @@ -1,47 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../doc/qt3d-config.qdocconf) - -project = Qt3DCore -description = Qt 3D Core Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DCore - -qhp.Qt3DCore.file = qt3dcore.qhp -qhp.Qt3DCore.namespace = org.qt-project.qt3dcore.$QT_VERSION_TAG -qhp.Qt3DCore.virtualFolder = qt3dcore -qhp.Qt3DCore.indexTitle = Qt 3D Core -qhp.Qt3DCore.indexRoot = - -qhp.Qt3DCore.filterAttributes = qt3dcore $QT_VERSION qtrefdoc -qhp.Qt3DCore.customFilters.Qt.name = Qt3DCore $QT_VERSION -qhp.Qt3DCore.customFilters.Qt.filterAttributes = qt3dcore $QT_VERSION - -qhp.Qt3DCore.subprojects = classes qmltypes - -qhp.Qt3DCore.subprojects.classes.title = C++ Classes -qhp.Qt3DCore.subprojects.classes.indexTitle = Qt 3D Core C++ Classes -qhp.Qt3DCore.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DCore.subprojects.classes.sortPages = true - -qhp.Qt3DCore.subprojects.qmltypes.title = QML Types -qhp.Qt3DCore.subprojects.qmltypes.indexTitle = Qt 3D Core QML Types -qhp.Qt3DCore.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DCore.subprojects.qmltypes.sortPages = true - -tagfile = qt3dcore.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3drender qt3dlogic qt3dinput \ - qt3dextras qt3danimation qt3dscene2d - -sourcedirs += .. \ - ../../quick3d/quick3d - -headerdirs += .. \ - ../../quick3d/quick3d - -imagedirs += images -exampledirs += snippets diff --git a/src/doc/qt3d-config.qdocconf b/src/doc/qt3d-config.qdocconf deleted file mode 100644 index b5f1fad8f..000000000 --- a/src/doc/qt3d-config.qdocconf +++ /dev/null @@ -1,36 +0,0 @@ -examplesinstallpath = qt3d - -# Dependencies to Qt documentation -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# Exclude private header files from the documentation build -excludefiles += "*_p.h" - -examples.fileextensions += "*.fraq *.geom *.vert" -examples.imageextensions += "*.png" - -macro.TODO = " " - -Cpp.ignoretokens += QT3DINPUTSHARED_EXPORT \ - QT3DCORESHARED_EXPORT \ - QT3DLOGIC_PRIVATE_EXPORT \ - QT3DLOGICSHARED_EXPORT \ - QT3DRENDERSHARED_EXPORT \ - QT3DRENDERSHARED_PRIVATE_EXPORT \ - QT3DQUICKSHARED_PRIVATE_EXPORT \ - QT3DEXTRASSHARED_EXPORT \ - QT3DANIMATIONSHARED_EXPORT \ - QT3DQUICKSCENE2DSHARED_EXPORT - -Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY - -manifestmeta.highlighted.names = \ - "Qt3D/Qt 3D: Advanced custom material QML Example" \ - "Qt3D/Qt 3D: Audio Visualizer Example" \ - "Qt3D/Qt 3D: Planets QML Example" - -manifestmeta.thumbnail.names += "Qt3D/Qt 3D: Deferred Renderer C++ Example" - -navigation.landingpage = "Qt 3D" -navigation.cppclassespage = "Qt 3D C++ Classes" -navigation.qmltypespage = "Qt 3D QML Types" diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf index b397f1837..7da047ced 100644 --- a/src/doc/qt3d.qdocconf +++ b/src/doc/qt3d.qdocconf @@ -1,10 +1,17 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(qt3d-config.qdocconf) project = Qt3D description = Qt 3D Reference Documentation version = $QT_VERSION +examplesinstallpath = qt3d + +indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \ + $QT_INSTALL_DOCS/qtgui/qtgui.index \ + $QT_INSTALL_DOCS/qtqml/qtqml.index \ + $QT_INSTALL_DOCS/qtquick/qtquick.index \ + $QT_INSTALL_DOCS/qmake/qmake.index + qhp.projects = Qt3D qhp.Qt3D.file = qt3d.qhp @@ -17,33 +24,87 @@ qhp.Qt3D.filterAttributes = qt3d $QT_VERSION qtrefdoc qhp.Qt3D.customFilters.Qt.name = Qt3D $QT_VERSION qhp.Qt3D.customFilters.Qt.filterAttributes = qt3d $QT_VERSION -qhp.Qt3D.subprojects = classes qmltypes examples +qhp.Qt3D.subprojects = classes qmltypes qhp.Qt3D.subprojects.classes.title = C++ Classes qhp.Qt3D.subprojects.classes.indexTitle = Qt 3D C++ Classes -qhp.Qt3D.subprojects.classes.selectors = class doc:headerfile +qhp.Qt3D.subprojects.classes.selectors = class fake:headerfile qhp.Qt3D.subprojects.classes.sortPages = true qhp.Qt3D.subprojects.qmltypes.title = QML Types qhp.Qt3D.subprojects.qmltypes.indexTitle = Qt 3D QML Types -qhp.Qt3D.subprojects.qmltypes.selectors = qmltype +qhp.Qt3D.subprojects.qmltypes.selectors = qmlclass qhp.Qt3D.subprojects.qmltypes.sortPages = true -qhp.Qt3D.subprojects.examples.title = Examples -qhp.Qt3D.subprojects.examples.indexTitle = Qt 3D Examples -qhp.Qt3D.subprojects.examples.selectors = doc:example -qhp.Qt3D.subprojects.examples.sortPages = true +tagfile = qt3d.tags + +depends += qtcore qtgui qtqml qtquick qtdoc -# dependencies to other Qt 3D modules -depends += qt3dcore qt3drender qt3dlogic qt3dinput \ - qt3dextras qt3danimation qt3dscene2d +headerdirs += . \ + ../render \ + ../core \ + ../logic \ + ../plugins \ + ../quick3d/quick3d \ + ../input \ + ../extras \ + ../animation \ + ../quick3d/quick3dscene2d -tagfile = qt3d.tags +# Exclude private header files from the documentation build +excludefiles += "*_p.h" -headerdirs += src -sourcedirs += src +sourcedirs += . \ + ../render \ + ../core \ + ../logic \ + ../plugins \ + ../quick3d/quick3d \ + ../input \ + ../extras \ + ../animation \ + ../quick3d/quick3dscene2d exampledirs += ../../examples/qt3d \ snippets -imagedirs += images +examples.fileextensions += "*.fraq *.geom *.vert" +examples.imageextensions += "*.png" + +excludedirs += \ + ../plugins/renderplugins + +macro.TODO = " " +imagedirs += images \ + ../../examples/qt3d/shadow-map-qml/doc/images \ + ../../examples/qt3d/basicshapes-cpp/doc/images \ + ../../examples/qt3d/planets-qml/doc/images \ + ../../examples/qt3d/wireframe/doc/images \ + ../../examples/qt3d/audio-visualizer-qml/doc/images \ + ../../examples/qt3d/simplecustommaterial/doc/images \ + ../../examples/qt3d/scene2d/doc/images \ + ../../examples/qt3d/advancedcustommaterial/doc/images + +Cpp.ignoretokens += QT3DINPUTSHARED_EXPORT \ + QT3DCORESHARED_EXPORT \ + QT3DLOGIC_PRIVATE_EXPORT \ + QT3DLOGICSHARED_EXPORT \ + QT3DRENDERSHARED_EXPORT \ + QT3DRENDERSHARED_PRIVATE_EXPORT \ + QT3DQUICKSHARED_PRIVATE_EXPORT \ + QT3DEXTRASSHARED_EXPORT \ + QT3DANIMATIONSHARED_EXPORT \ + QT3DQUICKSCENE2DSHARED_EXPORT + +Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY + +manifestmeta.highlighted.names = \ + "Qt3D/Qt 3D: Advanced custom material QML Example" \ + "Qt3D/Qt 3D: Audio Visualizer Example" \ + "Qt3D/Qt 3D: Planets QML Example" + +manifestmeta.thumbnail.names += "Qt3D/Qt 3D: Deferred Renderer C++ Example" + +navigation.landingpage = "Qt 3D" +navigation.cppclassespage = "Qt 3D C++ Classes" +navigation.qmltypespage = "Qt 3D QML Types" diff --git a/src/render/doc/src/levelofdetailloader.qdoc b/src/doc/src/levelofdetailloader.qdoc index 6294e4735..6294e4735 100644 --- a/src/render/doc/src/levelofdetailloader.qdoc +++ b/src/doc/src/levelofdetailloader.qdoc diff --git a/src/core/doc/src/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc index e313a7375..e313a7375 100644 --- a/src/core/doc/src/qcircularbuffer.qdoc +++ b/src/doc/src/qcircularbuffer.qdoc diff --git a/src/extras/doc/src/qmlextracontrollers.qdoc b/src/doc/src/qmlextracontrollers.qdoc index 737d0f823..737d0f823 100644 --- a/src/extras/doc/src/qmlextracontrollers.qdoc +++ b/src/doc/src/qmlextracontrollers.qdoc diff --git a/src/extras/doc/src/qmlextramaterials.qdoc b/src/doc/src/qmlextramaterials.qdoc index 48f1a2326..48f1a2326 100644 --- a/src/extras/doc/src/qmlextramaterials.qdoc +++ b/src/doc/src/qmlextramaterials.qdoc diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc index cb08a60c0..103d84ff4 100644 --- a/src/doc/src/qt3d-module.qdoc +++ b/src/doc/src/qt3d-module.qdoc @@ -38,6 +38,19 @@ ****************************************************************************/ /*! + \module Qt3DCore + \title Qt 3D Core C++ Classes + \brief The Qt 3D module contains functionality to support near-realtime simulation systems. + + \ingroup modules + \ingroup qt3d-modules + \qtvariable 3dcore + + The Qt 3D module provides the foundations and core types used for near-realtime + simulations built on the Qt 3D framework. +*/ + +/*! \page qt3d-cpp.html \title Qt 3D C++ Classes \brief The Qt 3D module contains functionality to support near-realtime simulation systems. @@ -74,28 +87,38 @@ */ /*! - \page qt3d-qml.html + \namespace Qt3DCore + \inmodule Qt3DCore + \ingroup qt3d-namespaces + + \brief Contains classes that are the foundation for Qt 3D simulation + framework, as well as classes that provide the ability to render using the + Qt 3D framework. +*/ + +/*! + \qmlmodule Qt3D.Core 2.0 \title Qt 3D QML Types \brief QML Types for the Qt 3D module. \since 5.7 + \ingroup qmlmodules + \ingroup qt3d-qmlmodules - The Qt 3D core QML types are imported with + To import and use the module's QML types, use the following statement: \badcode import Qt3D.Core 2.0 \endcode - Other modules import functionality for collision detection, rendering, input, - and animation. The complete list of Qt 3D import statements: + For collision detection, renderer, and input-related QML types, use the + following import statements: \badcode - import Qt3D.Core 2.0 import Qt3D.Render 2.0 import Qt3D.Input 2.0 import Qt3D.Logic 2.0 import Qt3D.Extras 2.0 import Qt3D.Animation 2.9 - import Qt3D.Scene2D 2.9 \endcode \section1 QML Types diff --git a/src/animation/doc/src/qt3danimation-module.qdoc b/src/doc/src/qt3danimation-module.qdoc index 918c401f9..631e449e2 100644 --- a/src/animation/doc/src/qt3danimation-module.qdoc +++ b/src/doc/src/qt3danimation-module.qdoc @@ -32,7 +32,7 @@ \preliminary \keyword Qt 3D Animation - \brief The Qt 3D Animation module provides a set of prebuilt elements to help + \brief The Qt 3D Animation modules provides a set of prebuilt elements to help you get started with Qt 3D. This module is still in development but is available as a technology preview. @@ -43,7 +43,7 @@ \qtvariable 3danimation \code - #include <Qt3DAnimation> + #include <Qt3DAnimation> \endcode To link against the corresponding C++ library, add the following to your qmake project file: @@ -229,6 +229,4 @@ \badcode import Qt3D.Animation 2.9 \endcode - - \section1 QML Types */ diff --git a/src/extras/doc/src/qt3dextras-module.qdoc b/src/doc/src/qt3dextras-module.qdoc index 98cfdf17a..7aa042160 100644 --- a/src/extras/doc/src/qt3dextras-module.qdoc +++ b/src/doc/src/qt3dextras-module.qdoc @@ -129,6 +129,4 @@ \badcode import Qt3D.Extras 2.0 \endcode - - \section1 QML Types */ diff --git a/src/input/doc/src/qt3dinput-module.qdoc b/src/doc/src/qt3dinput-module.qdoc index 7739d596d..0fbe0aef1 100644 --- a/src/input/doc/src/qt3dinput-module.qdoc +++ b/src/doc/src/qt3dinput-module.qdoc @@ -28,7 +28,6 @@ /*! \module Qt3DInput \title Qt 3D Input C++ Classes - \keyword Qt 3D Input \brief The Qt 3D Input module provides classes for handling user input in applications using Qt3D. \since 5.7 diff --git a/src/logic/doc/src/qt3dlogic-module.qdoc b/src/doc/src/qt3dlogic-module.qdoc index 8994b8bcd..8994b8bcd 100644 --- a/src/logic/doc/src/qt3dlogic-module.qdoc +++ b/src/doc/src/qt3dlogic-module.qdoc diff --git a/src/render/doc/src/qt3drender-framegraph.qdoc b/src/doc/src/qt3drender-framegraph.qdoc index 98eee0e40..44b1cbe89 100644 --- a/src/render/doc/src/qt3drender-framegraph.qdoc +++ b/src/doc/src/qt3drender-framegraph.qdoc @@ -129,7 +129,7 @@ example, if you want to use different rendering approaches for indoor and outdoor scenes or to enable or disable some special effect. - \code + \badcode Entity { id: sceneRoot components: RenderSettings { @@ -141,7 +141,7 @@ \note activeFrameGraph is the default property of the FrameGraph component in QML. - \code + \badcode Entity { id: sceneRoot components: RenderSettings { @@ -150,7 +150,7 @@ } \endcode - \section2 How the Framegraph is Used + \section2 How the Framegraph Is Used \list \li The Qt 3D renderer performs a \e{depth first traversal} of the @@ -192,7 +192,7 @@ we render to an intermediate \e G-buffer. Here is a simple FrameGraph that can be used for forward rendering: - \code + \badcode Viewport { rect: Qt.rect(0.0, 0.0, 1.0, 1.0) property alias camera: cameraSelector.camera @@ -231,7 +231,7 @@ nearer to the root of the framegraph as this will result in fewer leaf nodes, and hence, fewer RenderViews overall. - \code + \badcode Viewport { rect: Qt.rect(0.0, 0.0, 1.0, 1.0) property alias camera: cameraSelector.camera @@ -246,7 +246,7 @@ } \endcode - \code + \badcode CameraSelector { Viewport { rect: Qt.rect(0.0, 0.0, 1.0, 1.0) @@ -268,7 +268,7 @@ \image multiviewport.png - \code + \badcode Viewport { id: mainViewport rect: Qt.rect(0, 0, 1, 1) @@ -416,7 +416,7 @@ many games due to the ability to use large numbers of dynamic lights at the expense of additional GPU memory usage. - \code + \badcode Viewport { rect: Qt.rect(0.0, 0.0, 1.0, 1.0) diff --git a/src/render/doc/src/qt3drender-geometry.qdoc b/src/doc/src/qt3drender-geometry.qdoc index 6d86b92e7..03e84b1d7 100644 --- a/src/render/doc/src/qt3drender-geometry.qdoc +++ b/src/doc/src/qt3drender-geometry.qdoc @@ -54,7 +54,7 @@ \li \l {GeometryRenderer} \endlist - \section2 Buffer Object + \section2 Buffer The Qt3DRender::QBuffer class stores the raw data. This acts purely as an array of memory. In most cases a Qt3DRender::QBuffer will be used @@ -71,7 +71,7 @@ } \endcode - \section2 Attribute Object + \section2 Attribute Qt3DRender::QAttribute specifies how data contained in the referenced buffer should be extracted and passed to an input of a vertex shader. It @@ -97,7 +97,7 @@ } \endcode - \section2 Geometry Object + \section2 Geometry A Qt3DRender::QGeometry aggregates various attributes to form a piece of geometry. Usually a proper geometry will provide an attribute for vertex @@ -131,7 +131,7 @@ } \endcode - \section2 GeometryRenderer Object + \section2 GeometryRenderer Qt3DRender::QGeometryRenderer is a QComponent which when aggregated by a QEntity allows to draw the Qt3DRender::QGeometry it references. It provides diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index 3a7a6f6bb..fabdd4220 100644 --- a/src/render/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -40,7 +40,6 @@ /*! \module Qt3DRender \title Qt 3D Render C++ Classes - \keyword Qt 3D Render \brief The Qt 3D Render module contains functionality to support 2D and 3D rendering using Qt 3D. \since 5.7 @@ -101,6 +100,4 @@ \badcode import Qt3D.Render 2.0 \endcode - - \section1 QML Types */ diff --git a/src/render/doc/src/qt3drender-protips.qdoc b/src/doc/src/qt3drender-protips.qdoc index 801c4a993..c78f3d598 100644 --- a/src/render/doc/src/qt3drender-protips.qdoc +++ b/src/doc/src/qt3drender-protips.qdoc @@ -49,6 +49,13 @@ stages you may end up, in the best cases with something different than what you expected, in the worst cases with a black screen. + \list + \li \l {Technique Selection} + \li \l {Order Matters} + \li \l {Blending} + \li \l {Useful Tools} + \endlist + \section2 Technique Selection Qt 3D provides a technique selection mechanism allowing you to provide @@ -74,10 +81,10 @@ \list \li Filtering with a Qt3DRender::QLayer component and - Qt3DRender::QLayerFilter in the FrameGraph. + Qt3DRender::QLayerFilter in the FrameGraph \li RenderPass or Technique filtering using Qt3DRender::QRenderPassFilter - or Qt3DRender::QTechniqueFilter in the FrameGraph. + or Qt3DRender::QTechniqueFilter in the FrameGraph \endlist @@ -107,17 +114,17 @@ Given the rather limited of troubleshooting given by Qt 3D in its first versions it sometimes helps to have tools to capture OpenGL draw calls and - get more clues about what's happening: + get more clues about what's happening \list \li \l {https://github.com/apitrace/apitrace}{apitrace} \li \l {https://github.com/ValveSoftware/vogl}{vogl} \endlist - These tools allow you to gather traces of all OpenGL calls being made + These tools allow you to gather traces of all the OpenGL calls being made by a Qt 3D application. Having a look at a generated trace file may help - you verify that draw calls are being made, textures are correctly uploaded, - uniforms are set with proper values, and so on. + you verify that draw calls are being made, textures correctly uploaded, + uniforms set with proper values, ... There are plans for Qt 3D tooling in later releases. */ diff --git a/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc b/src/doc/src/qt3dscene2d-module.qdoc index 8809f469a..400b8b19f 100644 --- a/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc +++ b/src/doc/src/qt3dscene2d-module.qdoc @@ -94,6 +94,4 @@ \badcode import Qt3D.Scene2D 2.9 \endcode - - \section1 QML Types */ diff --git a/src/extras/doc/qt3dextras.qdocconf b/src/extras/doc/qt3dextras.qdocconf deleted file mode 100644 index 470a80450..000000000 --- a/src/extras/doc/qt3dextras.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../doc/qt3d-config.qdocconf) - -project = Qt3DExtras -description = Qt 3D Extras Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DExtras - -qhp.Qt3DExtras.file = qt3dextras.qhp -qhp.Qt3DExtras.namespace = org.qt-project.qt3dextras.$QT_VERSION_TAG -qhp.Qt3DExtras.virtualFolder = qt3dextras -qhp.Qt3DExtras.indexTitle = Qt 3D Extras -qhp.Qt3DExtras.indexRoot = - -qhp.Qt3DExtras.filterAttributes = qt3dextras $QT_VERSION qtrefdoc -qhp.Qt3DExtras.customFilters.Qt.name = Qt3DExtras $QT_VERSION -qhp.Qt3DExtras.customFilters.Qt.filterAttributes = qt3dextras $QT_VERSION - -qhp.Qt3DExtras.subprojects = classes qmltypes - -qhp.Qt3DExtras.subprojects.classes.title = C++ Classes -qhp.Qt3DExtras.subprojects.classes.indexTitle = Qt 3D Extras C++ Classes -qhp.Qt3DExtras.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DExtras.subprojects.classes.sortPages = true - -qhp.Qt3DExtras.subprojects.qmltypes.title = QML Types -qhp.Qt3DExtras.subprojects.qmltypes.indexTitle = Qt 3D Extras QML Types -qhp.Qt3DExtras.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DExtras.subprojects.qmltypes.sortPages = true - -tagfile = qt3dextras.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3drender qt3dlogic \ - qt3dinput qt3danimation qt3dscene2d - -sourcedirs += .. -headerdirs += .. -imagedirs += images -exampledirs += snippets diff --git a/src/extras/extras.pro b/src/extras/extras.pro index 700d39dea..22c9fcb93 100644 --- a/src/extras/extras.pro +++ b/src/extras/extras.pro @@ -7,8 +7,6 @@ DEFINES += QT3DEXTRAS_LIBRARY # Qt3D is free of Q_FOREACH - make sure it stays that way: DEFINES += QT_NO_FOREACH -QMAKE_DOCS = $$PWD/doc/qt3dextras.qdocconf - load(qt_module) include (geometries/geometries.pri) diff --git a/src/input/doc/qt3dinput.qdocconf b/src/input/doc/qt3dinput.qdocconf deleted file mode 100644 index 6ca49d09a..000000000 --- a/src/input/doc/qt3dinput.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../doc/qt3d-config.qdocconf) - -project = Qt3DInput -description = Qt 3D Input Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DInput - -qhp.Qt3DInput.file = qt3dinput.qhp -qhp.Qt3DInput.namespace = org.qt-project.qt3dinput.$QT_VERSION_TAG -qhp.Qt3DInput.virtualFolder = qt3dinput -qhp.Qt3DInput.indexTitle = Qt 3D Input -qhp.Qt3DInput.indexRoot = - -qhp.Qt3DInput.filterAttributes = qt3dinput $QT_VERSION qtrefdoc -qhp.Qt3DInput.customFilters.Qt.name = Qt3DInput $QT_VERSION -qhp.Qt3DInput.customFilters.Qt.filterAttributes = qt3dinput $QT_VERSION - -qhp.Qt3DInput.subprojects = classes qmltypes - -qhp.Qt3DInput.subprojects.classes.title = C++ Classes -qhp.Qt3DInput.subprojects.classes.indexTitle = Qt 3D Input C++ Classes -qhp.Qt3DInput.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DInput.subprojects.classes.sortPages = true - -qhp.Qt3DInput.subprojects.qmltypes.title = QML Types -qhp.Qt3DInput.subprojects.qmltypes.indexTitle = Qt 3D Input QML Types -qhp.Qt3DInput.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DInput.subprojects.qmltypes.sortPages = true - -tagfile = qt3dinput.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3drender qt3dlogic \ - qt3dextras qt3danimation qt3dscene2d - -sourcedirs += .. -headerdirs += .. -imagedirs += images -exampledirs += snippets diff --git a/src/input/input.pro b/src/input/input.pro index 7db74cfde..73a571c9f 100644 --- a/src/input/input.pro +++ b/src/input/input.pro @@ -17,6 +17,4 @@ HEADERS += \ qt3dinput_global.h \ qt3dinput_global_p.h -QMAKE_DOCS = $$PWD/doc/qt3dinput.qdocconf - load(qt_module) diff --git a/src/logic/doc/qt3dlogic.qdocconf b/src/logic/doc/qt3dlogic.qdocconf deleted file mode 100644 index 8f7196991..000000000 --- a/src/logic/doc/qt3dlogic.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../doc/qt3d-config.qdocconf) - -project = Qt3DLogic -description = Qt 3D Logic Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DLogic - -qhp.Qt3DLogic.file = qt3dlogic.qhp -qhp.Qt3DLogic.namespace = org.qt-project.qt3dlogic.$QT_VERSION_TAG -qhp.Qt3DLogic.virtualFolder = qt3dlogic -qhp.Qt3DLogic.indexTitle = Qt 3D Logic -qhp.Qt3DLogic.indexRoot = - -qhp.Qt3DLogic.filterAttributes = qt3dlogic $QT_VERSION qtrefdoc -qhp.Qt3DLogic.customFilters.Qt.name = Qt3DLogic $QT_VERSION -qhp.Qt3DLogic.customFilters.Qt.filterAttributes = qt3dlogic $QT_VERSION - -qhp.Qt3DLogic.subprojects = classes qmltypes - -qhp.Qt3DLogic.subprojects.classes.title = C++ Classes -qhp.Qt3DLogic.subprojects.classes.indexTitle = Qt 3D Logic C++ Classes -qhp.Qt3DLogic.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DLogic.subprojects.classes.sortPages = true - -qhp.Qt3DLogic.subprojects.qmltypes.title = QML Types -qhp.Qt3DLogic.subprojects.qmltypes.indexTitle = Qt 3D Logic QML Types -qhp.Qt3DLogic.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DLogic.subprojects.qmltypes.sortPages = true - -tagfile = qt3dlogic.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3drender qt3dinput \ - qt3dextras qt3danimation qt3dscene2d - -sourcedirs += .. -headerdirs += .. -imagedirs += images -exampledirs += snippets diff --git a/src/logic/logic.pro b/src/logic/logic.pro index 2fd73391c..584b9af4b 100644 --- a/src/logic/logic.pro +++ b/src/logic/logic.pro @@ -13,6 +13,4 @@ gcov { include(logic.pri) -QMAKE_DOCS = $$PWD/doc/qt3dlogic.qdocconf - load(qt_module) diff --git a/src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf b/src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf deleted file mode 100644 index 06e67daa5..000000000 --- a/src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf +++ /dev/null @@ -1,45 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../../doc/qt3d-config.qdocconf) - -project = Qt3DScene2D -description = Qt 3D Scene2D Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DScene2D - -qhp.Qt3DScene2D.file = qt3dscene2d.qhp -qhp.Qt3DScene2D.namespace = org.qt-project.qt3dscene2d.$QT_VERSION_TAG -qhp.Qt3DScene2D.virtualFolder = qt3dscene2d -qhp.Qt3DScene2D.indexTitle = Qt 3D Scene2D -qhp.Qt3DScene2D.indexRoot = - -qhp.Qt3DScene2D.filterAttributes = qt3dscene2d $QT_VERSION qtrefdoc -qhp.Qt3DScene2D.customFilters.Qt.name = Qt3DScene2D $QT_VERSION -qhp.Qt3DScene2D.customFilters.Qt.filterAttributes = qt3dscene2d $QT_VERSION - -qhp.Qt3DScene2D.subprojects = classes qmltypes - -qhp.Qt3DScene2D.subprojects.classes.title = C++ Classes -qhp.Qt3DScene2D.subprojects.classes.indexTitle = Qt 3D Scene2D C++ Classes -qhp.Qt3DScene2D.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DScene2D.subprojects.classes.sortPages = true - -qhp.Qt3DScene2D.subprojects.qmltypes.title = QML Types -qhp.Qt3DScene2D.subprojects.qmltypes.indexTitle = Qt 3D Scene2D QML Types -qhp.Qt3DScene2D.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DScene2D.subprojects.qmltypes.sortPages = true - -tagfile = qt3dscene2d.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3drender qt3dlogic \ - qt3dinput qt3dextras qt3danimation - -sourcedirs += .. - -headerdirs += .. - -imagedirs += images -exampledirs += snippets diff --git a/src/quick3d/quick3dscene2d/quick3dscene2d.pro b/src/quick3d/quick3dscene2d/quick3dscene2d.pro index b85863328..fb599187b 100644 --- a/src/quick3d/quick3dscene2d/quick3dscene2d.pro +++ b/src/quick3d/quick3dscene2d/quick3dscene2d.pro @@ -25,6 +25,4 @@ HEADERS += \ include(./items/items.pri) -QMAKE_DOCS = $$PWD/doc/qt3dscene2d.qdocconf - load(qt_module) diff --git a/src/render/doc/qt3drender.qdocconf b/src/render/doc/qt3drender.qdocconf deleted file mode 100644 index a3a827678..000000000 --- a/src/render/doc/qt3drender.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../doc/qt3d-config.qdocconf) - -project = Qt3DRender -description = Qt 3D Render Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DRender - -qhp.Qt3DRender.file = qt3drender.qhp -qhp.Qt3DRender.namespace = org.qt-project.qt3drender.$QT_VERSION_TAG -qhp.Qt3DRender.virtualFolder = qt3drender -qhp.Qt3DRender.indexTitle = Qt 3D Render -qhp.Qt3DRender.indexRoot = - -qhp.Qt3DRender.filterAttributes = qt3drender $QT_VERSION qtrefdoc -qhp.Qt3DRender.customFilters.Qt.name = Qt3DRender $QT_VERSION -qhp.Qt3DRender.customFilters.Qt.filterAttributes = qt3drender $QT_VERSION - -qhp.Qt3DRender.subprojects = classes qmltypes - -qhp.Qt3DRender.subprojects.classes.title = C++ Classes -qhp.Qt3DRender.subprojects.classes.indexTitle = Qt 3D Render C++ Classes -qhp.Qt3DRender.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DRender.subprojects.classes.sortPages = true - -qhp.Qt3DRender.subprojects.qmltypes.title = QML Types -qhp.Qt3DRender.subprojects.qmltypes.indexTitle = Qt 3D Render QML Types -qhp.Qt3DRender.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DRender.subprojects.qmltypes.sortPages = true - -tagfile = qt3drender.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3dlogic qt3dinput \ - qt3dextras qt3danimation qt3dscene2d - -sourcedirs += .. -headerdirs += .. -imagedirs += images -exampledirs += snippets diff --git a/src/render/render.pro b/src/render/render.pro index fae103b2c..ea5ce7dc5 100644 --- a/src/render/render.pro +++ b/src/render/render.pro @@ -52,6 +52,4 @@ MODULE_PLUGIN_TYPES = \ geometryloaders \ renderplugins -QMAKE_DOCS = $$PWD/doc/qt3drender.qdocconf - load(qt_module) |