summaryrefslogtreecommitdiffstats
path: root/src/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* | Update FrameGraph documentationPaul Lemire2016-08-091-8/+8
| | | | | | | | | | Change-Id: Iab953f6920e5d9d577b4c6741a3e6e59f3f647e8 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Add qdoc files to doc.proPaul Lemire2016-08-091-0/+2
| | | | | | | | | | | | | | Allows QtCreator to find them Change-Id: I2249f9cf54d2b52332b696ead520c4a76ea4efb4 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Doc: Add docs for the Deferred Renderer exampleLeena Miettinen2016-06-081-0/+2
| | | | | | | | | | | | Change-Id: Icc1e688ffb44431841054324fddecb2b6402d94b Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* | Doc: Add highlighting for some prominent Qt 3D examplesTopi Reinio2016-06-011-0/+3
| | | | | | | | | | | | | | | | | | | | This sets the highlight attribute in examples-manifest.xml for these examples, causing them to be raised towards the top of the example list on Qt Creator's Welcome mode. Task-number: QTBUG-53733 Change-Id: I2802c779621b70915d90f1f3304142ae70b61c14 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Merge branch '5.6' into 5.7Sean Harmer2016-05-191-1/+1
|\| | | | | | | Change-Id: Ie0fc178d3c0f818ea32aac0e98c97861d4c0f671
| * Doc: Remove repository name from examplesinstallpathv5.6.1-1v5.6.1Topi Reinio2016-05-131-1/+1
| | | | | | | | | | | | | | | | Examples in binary packages now directly match the install path. Change-Id: I477b72161e1f743a4e0925dacb38a05a3dd93946 Task-number: QTBUG-52953 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
* | Update docs/examples: QClearBuffer -> QClearBuffersWieland Hagen2016-05-041-13/+13
| | | | | | | | | | Change-Id: I85b8892e0980d001dcdeaf1741c1c0cc529da4a2 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* | Minor documentation fixesTomi Korpipää2016-04-191-2/+0
| | | | | | | | | | Change-Id: I5eee874b68c17252acbeccd3f1bde2c2108dc674 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* | Merge branch '5.6' into 5.7Sean Harmer2016-04-165-0/+0
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/qt3d/examples-common/qorbitcontrol.h src/core/qnodecreatedchange.cpp src/core/qnodecreatedchange.h src/input/frontend/qaxisactionhandler.h src/input/frontend/qinputaspect.h src/input/frontend/qkeyboardhandler.h src/input/frontend/qmousedevice.h src/input/frontend/qmousehandler.h src/input/frontend/qphysicaldevicecreatedchange.h src/input/input.pro src/logic/qframeaction.h src/plugins/sceneparsers/assimp/assimp.pro src/quick3d/imports/input/importsinput.pro src/quick3d/imports/render/importsrender.pro src/render/backend/trianglesextractor.cpp src/render/framegraph/qclearbuffer.h src/render/framegraph/qlighting.h src/render/framegraph/qstateset.h src/render/frontend/qrenderattachment.h src/render/geometry/qabstractattribute.h src/render/geometry/qabstractbuffer.h src/render/geometry/qattribute.h src/render/geometry/qboundingvolumespecifier.h src/render/geometry/qbuffer.h src/render/materialsystem/qfilterkey.h src/render/materialsystem/qparameter.h src/render/materialsystem/qparametermapping.h src/render/renderstates/qblendstate.h src/render/renderstates/qdepthmask.h src/render/renderstates/qpointsize.cpp src/render/renderstates/qrenderstatecreatedchange.cpp src/render/renderstates/qstencilop.h src/render/renderstates/qstencilopseparate.h src/render/renderstates/qstenciltestseparate.h src/render/texture/qabstracttexture.h src/render/texture/qabstracttextureimage.h src/render/texture/qtextureproviders.h Change-Id: I894d7781042cabdaa0cac690c198b57a41127bd4
| * Purge sRGB chunks from PNGs in documentation.Edward Welbourne2016-03-225-0/+0
| | | | | | | | | | | | | | | | Subjects each *.png file that matched grep -law "sRGB" to: pngcrush -ow -brute -rem allb -reduce -force Change-Id: I45f0404fedf58c3ec3380ba9adc26b1883007299 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Merge remote-tracking branch 'origin/5.6' into devLiang Qi2016-01-267-262/+190
|\| | | | | | | | | | | | | | | | | Conflicts: src/doc/src/qt3dcollision-module.qdoc src/render/frontend/qcamera.cpp src/render/frontend/qcameralens.cpp Change-Id: I8a0ae250a6b8e065a1ef3c817968ebb7ef23b20d
| * Doc: Fix documentation macro and other issuesTopi Reinio2016-01-261-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc doesn't allow a macro that expands into an empty string: src/core/nodes/qcomponent.cpp:189: warning: Unknown command '\TODO' Linking issues that are fixed by adding a dependency to Qt GUI: src/input/frontend/qkeyevent.cpp:121: warning: Can't link to 'QKeyEvent::nativeScanCode()' src/input/frontend/qkeyevent.cpp:141: warning: Can't link to 'QKeySequence::StandardKey' src/quick3d/quick3d/qquaternionanimation.cpp:42: warning: Can't link to 'QQuaternion' Other fixed warnings: src/input/frontend/qmousecontroller.cpp:54: warning: Unknown command '\intantiates' src/quick3d/quick3d/qquaternionanimation.cpp:42: warning: C++ class Qt3DCore::Quick::QQuaternionAnimation not found src/render/materialsystem/qparametermapping.cpp:85: warning: Undocumented enum item 'UniformBufferObject' Undocumented enum item 'ShaderStorageBufferObject' examples/qt3d/wireframe/doc/src/wireframe.qdoc:28: warning: Can't link to 'BasicCamera' Change-Id: Iea8f591bd09f0b8895dc568a48f2bfe80f2fe73d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
| * Doc: Mark QCircularBuffer as \internalTopi Reinio2016-01-251-159/+159
| | | | | | | | | | | | | | | | | | | | As the class was made private, mark it \internal. Because its private header file is not included in the documentation build, also replace the qdoc comments '/*!' with standard C comments to avoid documentation warnings. Change-Id: I896d13e4192830976d8f24c5b98fdef2b127bf1c Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| * Doc: Exclude private header files from the documentation buildTopi Reinio2016-01-251-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | In the documentation configuration, exclude all '_p.h' files from the documentation build. This prevents QDoc from generating documentation for private classes, and also allows removal of documentation that explicitly set the private classes \internal. Change-Id: I8fcf5c99a2a0b75e9ee5dcd928fa4a2b4b8cf34f Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| * Doc: Use 'Qt 3D' instead of Qt3D consistentlyTopi Reinio2016-01-253-8/+9
| | | | | | | | | | Change-Id: I91c0d00c0116a05209239da399f4076316a51fc7 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| * Doc: Add skeletal doc structure for the QML types of Qt3D Input moduleVenugopal Shivashankar2016-01-221-3/+2
| | | | | | | | | | | | | | Also marked a few private C++ classes as \internal. Change-Id: I32a7da498c97e132f6b6e60d551cc0b7feb52b01 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| * Added Audio Visualizer exampleTitta Heikkala2016-01-221-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | Example visualizes the magnitude of music played as animated bars. The music is played using media player. Implementation combines the use of Qt 3D rendering with Qt Quick 2D elements. Change-Id: I945d50d0dbd26151f274269649cca793a5ad4d27 Reviewed-by: Tomi Korpipää <tomi.korpipaa@theqtcompany.com> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com> Reviewed-by: Pasi Keränen <pasi.keranen@theqtcompany.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| * Doc: Removed Qt3DCollision namespace and module docsVenugopal Shivashankar2016-01-214-85/+4
| | | | | | | | | | | | | | | | Besides that, fixed a few qdoc warnings. Change-Id: Ibaf8fd6ffbb93f3f2bd73fa5fedf06e94f6ac2eb Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
| * Fixed some documentation warningsTomi Korpipää2016-01-194-5/+11
| | | | | | | | | | | | | | Change-Id: I5055043641a1916dde47ad614d8ab7a5788fd93b Task-number: QTBUG-46037 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com> Reviewed-by: Pasi Keränen <pasi.keranen@theqtcompany.com>
* | Unify license header usageAntti Kokko2016-01-264-20/+20
| | | | | | | | | | | | | | Updated FDL license. Change-Id: If5b261a12d1fba0d317848d3710e45e83f992fdf Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
* | Unify license header usageAntti Kokko2016-01-268-89/+113
|/ | | | | | | Update old header.LGPL3 to header.LGPL Change-Id: I8eac0cd6bbc276a56df487249cc459c0d4fab165 Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
* Doc: Remove duplicated examplesinstallpathTopi Reinio2015-12-071-2/+0
| | | | | | | | The first one is correct, remove the redefinition. Task-number: QTBUG-49777 Change-Id: Ic2d4edb0b8ef2b596fdac1eb417c7cf20a61af5c Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Fix QDoc warnings and do further cleanupTopi Reinio2015-11-234-76/+75
| | | | | | | | | Fix the documentation issues that still remained broken after renaming the namespaces/QML modules. Do further cleanup and minor doc editing. Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Documentation clean upVenugopal Shivashankar2015-11-0610-274/+275
| | | | | | | | | | - Changed 'Qt3D' references to 'Qt 3D'. - Fixed incorrect \inqmlmodule instances. - Fixed broken \printuntil instances in the example docs. - Updated the namespace qualifier for a few class references. Change-Id: I250afe6843b10ed520f9ce5d7465203cc5c212c1 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Move the doc artifacts outside of the submodule directoryVenugopal Shivashankar2015-10-2826-0/+3446
The qdocconf now lives in 'src/doc' because the documentation project defined by it covers the whole Qt 3D module. This change enables qmake to use 'qt3d' as the output directory for doc make targets. The new 'doc' directory also includes the relevant images, snippets, and the qdoc files. Change-Id: Ibc6d0912f8b1e665767e97630b3e5509e10c5710 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-07 22:49:07 +0000