summaryrefslogtreecommitdiffstats
path: root/src/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add documentation for PhongAlphaMaterial propertiesMats Honkamaa2019-10-171-0/+35
| | | | | | | | | | Added documentation for the following PhongAlphaMaterial QML Type properties: blendFunctionArg, destinationAlphaArg, destinationRgbArg, sourceAlphaArg, and sourceRgbArg. Task-number: QTBUG-78480 Change-Id: I392480926f8803e82ad88ee9638130c6f9b74931 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-07-161-0/+20
|\ | | | | | | Change-Id: I0f68ab1277617c32b1c31f29d8793d23d9909208
| * Document an example of how textureScale might be usedMichael Brasser2019-07-151-0/+20
| | | | | | | | | | Change-Id: Iead857526a06b104080ab843b26c49efc22f05cc Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* | Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | | | | | | | Task-number: QTBUG-74391 Change-Id: Iec111e88d38fb9a143a60a647251601f331fc41e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-06-271-47/+81
|\| | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: Iae5fa92dfdf8012315c043e20950368e42451e20
| * Doc: Update code samples in 'Qt 3D Render Framegraph' documentationTopi Reinio2019-06-171-47/+81
| | | | | | | | | | | | | | | | | | | | | | | | The code snippets were outdated, referring to QML properties that do not exist. In particular, the Deferred Rendering section contains code that was based on an example that's since moved into tests. Adapt the code to match the updates done to that example and also mention where it originates from. Task-number: QTBUG-73024 Change-Id: I9ec750d05f8e853e5614f33dadcbe44a0b42e356 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Switch export macros to standard formKai Koehne2019-04-021-10/+9
|/ | | | | | | | | | | | Qt expects the export macros to have Q_ prefixes, otherwise the symbol versioning script won't find them and mark them. Also remove non-exising QT3DLOGIC_PRIVATE_EXPORT macro from src/doc/qt3d.qdocconf Task-number: QTBUG-74752 Change-Id: I71b9e85ff09c002fb283824aa51a5a8f50e937f4 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Update QML import versions in "Qt3D QML Types"Kai Koehne2018-12-051-13/+13
| | | | | | | | Follow the example of qtdeclarative and always use the minor Qt version as import. Change-Id: I0adb53a793ddf6a4a9706e2ec1a147799a941e6a Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Documentation: Get rid of QT_INSTALL_HEADERS in documentation configTopi Reinio2018-11-072-8/+11
| | | | | | | | | | | The use of QT_INSTALL_HEADERS caused documentation build failures in certain configurations. Use an alternative method to pass the required include paths to QDoc; make the documentation subproject depend on (a subset of) Qt 3D modules to retrieve them. Task-number: QTBUG-67925 Change-Id: I2fb745fb59c319b85c51b544acdab95cded2207e Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Fix various documentation warningsTopi Reinio2018-11-071-1/+1
| | | | | Change-Id: I3eecd06bba9438b5aa472f3ba7ecaecdeda985e2 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Minor corrections overview pageNico Vertriest2018-10-151-11/+11
| | | | | | | | - added links - minor syntax correction Change-Id: I68f43b5a5091f402488b656a30d5fec40deae8cd Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Merge remote-tracking branch 'origin/5.11' into 5.12Qt Forward Merge Bot2018-10-051-0/+14
|\ | | | | | | Change-Id: I2a92242b0d6be4f4e7f07f0f020fa6751ada9bc3
| * Doc: Mark deprecated Qt 3D QML types obsoleteLeena Miettinen2018-09-251-0/+14
| | | | | | | | | | | | | | | | | | | | The types will be listed on the "Obsolete QML Types" page that is linked from the "All QML Types" page. Task-number: QTBUG-69713 Change-Id: Ieff402d1cce426c0ce4b9191b8fe9b1dd02b4328 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* | Doc: Use a macro to resolve QML import versionsTopi Reinio2018-09-267-28/+28
|/ | | | | | | | | | | QDoc now supports macros for its command parameters, as well as passing parameters to \code and \qml commands. Use these together with the new \QtMinorVersion macro to automate bumping the QML import versions within documentation. Task-number: QTBUG-67818 Change-Id: Ia09a5cc06bd6e7ccd41305cecbdac90318402d00 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Fix Scene2D and Scene3D QML modules uriTakumi ASAKI2018-08-172-6/+6
| | | | | | | | | | This is additional fix for QTBUG-67370. And fix for Scene3D. Task-number: QTBUG-67370 Change-Id: Id362e60ac4072b7935ee86ff2a44e23018adc381 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix incorrect GoochMaterial properties nameTakumi ASAKI2018-08-011-4/+4
| | | | | Change-Id: Ic2062cec8faaeed072c76f7f985b92a1e732454b Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Use correct module namePaul Wicking2018-07-301-2/+2
| | | | | | | | | QML: Importing Qt3D.Scene2D doesn't work, QtQuick.Scene2D does. CPP: Specify header file, as convenience header doesn't exist. Task-number: QTBUG-67370 Change-Id: Ia53e92c076f52bbb81b91370425279c44bf9e3c5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove private classes from public documentationPaul Wicking2018-07-111-1/+2
| | | | | | | | | | | | | | Mark as private: * Qt3DRender::AssimpImporter * Qt3DRender::GLTFImporter * Qt3DRender::GLTFExporter Exclude qt3d/src/plugins/sceneparsers from QDoc. Task-number: QTBUG-67935 Change-Id: Ibaa04de183bce4bd88704d53c92718a331f9866b Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add missing dots (qt3d)Paul Wicking2018-06-191-1/+1
| | | | | | Task-number: QTBUG-68933 Change-Id: I4226b8b9d70548b6921948c5ea47520f40f5df98 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Use FDL license for all .qdoc filesKai Koehne2018-05-2815-315/+135
| | | | | Change-Id: Ib777cb5c17939e618e51ceeb701de973d564014a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add basic documentation for Scene3D QML modulePaul Wicking2018-04-264-3/+66
| | | | | | | | | | | Adds Scene3D as QML module. Provides preliminary documentation for Scene3D QML type. Task-number: QTBUG-61651 Task-number: QTBUG-54816 Change-Id: I2811bb2165ca0adde574ddde70fa7185b3c03083 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix documentation warnings related to Clang QDoc parserTopi Reinio2018-04-205-40/+61
| | | | | | | | | | | | | | | | | | | | | Since Qt 5.11, QDoc uses Clang to parse C++ documentation. Clang requires a module header, as well as proper include paths, to build a precompiled header and process the sources. To do this, add a custom module header that pulls in all Qt 3D modules - this way, we can continue using a single documentation project to covers all of Qt 3D. Fix all documentation warnings are caused by missing namespaces, QML module/type names and typos, as well as a number of linking problems and other minor issues. After this change, the remaining documentation issues consist of 'No documentation for ...' warnings. Task-number: QTBUG-67790 Change-Id: I38b91163c475a00cc1893e793240470c5409eb57 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Revert "Doc: Divide documentation into submodules"Topi Reinio2018-04-2016-57/+4014
| | | | | | | | | | | This reverts commit c8964b8f1cf56718a189b0f57bad446cec30a8b8. QDoc now supports documentation-specific custom module headers and include headers that allow us to keep using a single documentation project that covers multiple modules. Change-Id: I84706a7149097a6b03f0f266e55d6f712a6c773e Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Add and improve examples in render states and material systemSvenn-Arne Dragly2018-03-251-0/+35
| | | | | | | | Also switch \code to \qml. Change-Id: I3f216a3abd55fdf51295ed14715f6f1ffc5e2ea4 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* Document state of the Qt 3D modulesKai Koehne2018-03-122-0/+12
| | | | | | | | | | | | | Do make it explicit which ones are still in development also in the landing page, and add \preliminary and \since tags (for released and TP modules, respectively). Note that the \preliminary, \since tags currently do not work for \qmlmodule, which hopefully gets fixed at one point: QTBUG-65963. Change-Id: I6648311c38f331286be37eefa60794984cd239b7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Divide documentation into submodulesTopi Reinio2018-02-0916-3994/+58
| | | | | | | | | | | | | | | | | QDoc in Qt 5.11 will use Clang (libclang) to parse C++ documentation. In order to do that, Clang needs to have the include paths available when parsing source; qmake provides that information to QDoc but only when the documentation project is located under the correct module (source) path. By having dedicated doc projects for Qt 3D Core, Render, Input, etc. the number of documentation warnings is signicantly reduced. A top-level 'Qt 3D' project is still kept, and contains the landing page, overview, examples, and top-level 'C++ classes' and 'QML types' pages that list all types documented across all Qt 3D submodules. Change-Id: Id5936de36f31c2a8764a64e1e9d7ae0d10e8ab14 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Qt 3D Extras: Fix information on deprecated classesTopi Reinio2017-12-051-29/+3
| | | | | | | | | | | QDoc has no \see command. Further, Qt 3D Extras module page still listed the deprecated classes. To fix these and make it easier to maintain, assign (non-deprecated) classes to groups and list the group members on the module page. Change-Id: I6bb2ff9855c2c481b33c7d0d142a173a5e0b3fd8 Reviewed-by: Sean Harmer <sean.harmer@kdab.com> Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* Fix Qt3D.Animation version in documentationTasuku Suzuki2017-08-042-3/+3
| | | | | | | Qt3D.Animation only supports version 2.9 Change-Id: Ib300af05412e748384f988a930d14e650da6d701 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Write docs for advanced custom material exampleMäättä Antti2017-05-101-3/+6
| | | | | | | | Also add it to highlighted items. Task-number: QTBUG-60287 Change-Id: I87a6074bed171970b287c6cd934e6550d86e27e0 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Add documentation for Scene2D exampleSean Harmer2017-05-091-1/+2
| | | | | Change-Id: I2d47b9224e4f26b342cd8a9bbe3c9c5a5e410dc1 Reviewed-by: Antti Määttä <antti.maatta@qt.io>
* Add documentation for simplecustommaterial exampleMäättä Antti2017-05-051-1/+2
| | | | | | Task-number: QTBUG-60287 Change-Id: Id167ddd190b7aa5468bc6590c9f9f4fea234430b Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: correct several link errorsNico Vertriest2017-05-031-1/+1
| | | | | | | | | | | | | qkeyframeanimation.cpp:61: warning: Can't link to 'Qt3D.Render::Transform' levelofdetailloader.qdoc:40: warning: Can't link to 'minimum' levelofdetailloader.qdoc:40: warning: Can't link to 'maximum' qlevelofdetail.cpp:201: warning: Can't link to 'Qt3DRender::QLevelOfDetail::SizeProxyMode' qlevelofdetailswitch.cpp:62: warning: Can't link to 'LevelOfDetailSwitch::currentIndex' Plus a minor language correction Change-Id: I26096ec74880a406ada27fb3d867983845611410 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Flesh out animation module overview documentationSean Harmer2017-04-131-4/+136
| | | | | Change-Id: If5f3788325cd96845151c0f41c3ffc890edbeab6 Reviewed-by: Andreas Holzammer <andreas.holzammer@kdab.com>
* Add skeleton documentation for scene2d moduleMäättä Antti2017-04-123-4/+110
| | | | | | | | | Add a skeleton documentation. The scene2d docs still need updating with proper usage instruction and docs for the final IF. Task-number: QTBUG-60099 Change-Id: I0a0f329d22b4f694bc663e635533f298da7e0605 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Enable animations doc generationAntti Määttä2017-02-134-5/+113
| | | | | Change-Id: Ia7e725b34b7a180dfbc920e7a65db70dac9ddd66 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* LevelOfDetail (LOD) nodeMike Krus2017-01-231-0/+57
| | | | | | | | | | | | | | | | | | | Component to control complexity of entities based on either distance to camera or size on screen. Given a specific camera, the LevelOfDetail computes the distance to the observer, or the screen size of the entity. The currentIndex property is updated to identify which of the entries in the provided array of distance or size ranges contains the current value. A disabled LevelOfDetail component will act as a simple (user controlled) switch. Updates are not done on disabled sub trees since their bounding boxes may not be valid. Change-Id: Ifa4c088de6b80b6a6ed203070411761574686cdb Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: removed superfluous (double) documentation + link errorNico Vertriest2016-12-071-1/+0
| | | | | | | | | - removed link to Tessellation Modes QML Example - QMouseDevice::sensitivity documented twice - QTextureImage::source documented twice Change-Id: I7d1a37a158bf2861103b20a5d387a005e7c759c6 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Merge remote-tracking branch 'origin/5.7' into 5.8Liang Qi2016-11-281-1/+1
|\ | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/input/backend/updateaxisactionjob.cpp src/render/renderstates/qalphacoverage.cpp src/render/renderstates/qclipplane.cpp src/render/renderstates/qdithering.cpp src/render/renderstates/qseamlesscubemap.cpp src/render/renderstates/qstenciltest.cpp Change-Id: I5b279d30bbbb06af5e8ee9fc47e9794b78a567f5
| * Doc: Fix QT variable value for Qt Quick apps on front pageLeena Miettinen2016-10-111-1/+1
| | | | | | | | | | | | | | | | | | - Fix the value for 3drender module - Add 3dlogic and 3dextras Change-Id: I27e41559d831ea03d473d5088fb4187d50d811d1 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Document 3rdparty assimp libraryKai Koehne2016-10-281-0/+13
|/ | | | | Change-Id: I2c75552f442f73c37426560227386a894a896f2c Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Fix camera controllersMiikka Heikkinen2016-09-051-0/+170
| | | | | | | | | | Fixed a few bugs and inconsistencies between qml and c++ implementations of the camera controllers. Also documented them. Task-number: QTBUG-55697 Change-Id: Ie490b0ca46f60a2a34c04f91572505e908ce65ba Reviewed-by: Antti Määttä <antti.maatta@qt.io> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Qt3DExtra materials documentation fixesMiikka Heikkinen2016-09-021-0/+568
| | | | | | | | | | Materials that were moved to Qt3DExtras were still part of Qt3DRender according to the documentation. Also added documentation for QML versions. Change-Id: Icd918599cf9a97a14e65f38a28309316a5f504dd Reviewed-by: Antti Määttä <antti.maatta@qt.io> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Doc: add a section about common rendering issuesPaul Lemire2016-08-222-0/+136
| | | | | Change-Id: I8c4d03df80d022db2f7d32330d41d7f24bae40d2 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: Remove references to Windows CEVenugopal Shivashankar2016-08-171-1/+0
| | | | | | | | | The platform is not supported since in Qt 5.7. Task-number: QTBUG-55331 Change-Id: Iada84e6c63ed2e7dba4c14c9533f98f847a19f18 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-08-131-1/+1
|\ | | | | | | Change-Id: I59c900a19313370efd8c57659e544073a6fb2d9e
| * Doc: Change instances of 'OS X' to 'macOS'v5.6.2Topi Reinio2016-08-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change all occurrences where the Mac platform is discussed to use the macro \macos (defined in the documentation configuration in qtbase). Change-Id: I0a7da987b0322b622a34f6735210bfdf708479ab Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Doc: Remove 'Technology Preview' from the landing pageTopi Reinio2016-08-111-1/+1
| | | | | | | | | | Change-Id: I3586c12a32607416bdc519d7a8c974fd2ac1523c Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* | Doc: add doc for Qt3DExtras modulePaul Lemire2016-08-104-4/+170
| | | | | | | | | | Change-Id: I4850cd747416b37fe88675099d9b405c2d9e173e Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Doc: add section about GeometryPaul Lemire2016-08-102-1/+155
| | | | | | | | | | Change-Id: Ia3967259d0b54ba326b7ae92388bf2a530719f01 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Doc: update supported platform listPaul Lemire2016-08-091-1/+1
| | | | | | | | | | Change-Id: Idd18f52abd3fb4fdeef4e6c40fff4e317a049480 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-23 12:11:37 +0000