summaryrefslogtreecommitdiffstats
path: root/examples/gui/doc
Commit message (Collapse)AuthorAgeFilesLines
* rhiwindow: Set DPR on image texture to ensure DPR-agnostic drawingTor Arne Vestbø6 days1-0/+5
| | | | | | | | | Otherwise the 20x20 margins will produce different layouts depending on the DPR, which is not what we want. Pick-to: 6.7 Change-Id: I4153d0843ef51c8e0f60d7d5166b153d45201c95 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: Create separate Graphics and Multimedia example categoriesJaishree Vyas2024-01-162-2/+2
| | | | | | | Fixes: QTBUG-117884 Pick-to: 6.6 6.7 Change-Id: I33c7b1cbfaeae866dffb0e89a5d09d775736d886 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add \examplecategory to qtguiSafiyyah Moosa2023-08-282-0/+2
| | | | | | | Task-number: QTBUG-116068 Pick-to: 6.5 6.6 Change-Id: Ia0bdc2122434adac51b37ba2207a2b0b993cf19b Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Fix documentation warnings for Qt GuiTopi Reinio2023-05-301-2/+2
| | | | | | | | | | | | | | | | | | | * Fix file quoting in RHI Window example * Add missing \inmodule commands for QRhi Classes * Add missing dependency to qtshadertools * Remove documentation for non-existent overload of QRhiGraphicsPipeline::setTargetBlends() Other fixed warnings: src/gui/rhi/qrhi.cpp: * warning: clang couldn't find function when parsing \fn void setUsage(UsageFlags u) * warning: clang couldn't find function when parsing \fn virtual bool QRhiSwapChain::isFormatSuported(Format f) Change-Id: I73ff7896c3d5c8bb491368e941b32c8026a47191 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* rhi: Make it a QPA-style private but semi-public APILaszlo Agocs2023-05-212-0/+439
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qrhi.h, qshader.h, qshaderdescription.h (and qshaderbaker.h from shadertools; done separately) become "RHI APIs", following the concept of QPA APIs. Mirror completely what is done for QPA headers, but using the "rhi" prefix for the headers. This involves updating syncqt to handle the new category of headers. (a note on the regex: matching everything starting with "qrhi" is not acceptable due to incorrectly matching existing and future headers, hence specifying the four header names explicitly) There is going to be one difference to QPA: the documentation for everything RHI is going to be public and part of the regular docs, not hidden with \internal. In addition to the header renaming and adding the comments and documentation notes and warnings, there is one significant change here: there is no longer a need to do API-specific includes, such as qrhid3d11[_p].h, qrhivulkan[_p].h, etc. These are simply merged into a single header that is then included from qrhi.h. This means that users within Qt, and any future applications can just do #include <rhi/qrhi.h> (or rhi/qshader.h if the QRhi stuff is not relevant), no other headers are needed. There are no changes to functionality in this patch. Only the documentation is expanded, quite a lot, to eliminate all qdoc warnings and make the generated API docs complete. An example, with a quite extensive doc page is added as well. Task-number: QTBUG-113331 Change-Id: I91c749826348f14320cb335b1c83e9d1ea2b1d8b Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Remove "Analog Clock Window Example"Jan Arve Sæther2023-02-073-114/+0
| | | | | | | | | | | | This is almost exactly the same as the "Analog Clock" (widget) example. "Analog Clock Window Example" demonstrates: * How to render to a QWindow (covered by RasterWindow example) * QPainter and transformations (covered by Analog Clock example) * How to use QTimer (covered by Analog Clock example) Pick-to: 6.5 Change-Id: I7f20a29798830ed6345eca250e4139cb314cab84 Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
* Use SPDX license identifiersLucie Gérard2022-05-162-52/+4
| | | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Lars Knoll <lars.knoll@qt.io> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Fix documentation warnings for Qt OpenGLTopi Reinio2020-10-301-0/+0
| | | | | | Task-number: QTBUG-86295 Change-Id: I4fff2d61f8f0513181150954440c9357acf73c1d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Move example file that was left behindPaul Wicking2020-09-101-158/+0
| | | | | | | | | | The qdoc-file that contains the example documentation was left behind when the OpenGL code moved from QtGui to QtOpenGL. This causes all the snippet commands to fail. Task-number: QTBUG-74409 Change-Id: I86a753d4fc832965e76a085062882e6c720becd2 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Update rasterwindow example to not render in resizeEventTor Arne Vestbø2018-03-201-3/+2
| | | | | | | | | | | | | | | | The resize event should not be used to draw, as there will be a follow-up exposeEvent delivered just after, and we don't want to draw twice. This is how QRasterWindow operates too, except it defers the backingstore resize to beginPaint() instead of resizing in the reizeEvent. It's also how QOpenGLWindow operates, which also has a note for the virtual resizeGL method saying: "Scheduling updates from here is not necessary. The windowing systems will send expose events that trigger an update automatically." Change-Id: I2a9740018508c2eb129149f53237ee8e378c03b1 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* doc: cleanup raster window exampleGatis Paeglis2017-07-031-8/+3
| | | | | | | | | | | | | Documentation does not match the sample code. There is no explicit call to QWindow::create(). It is called implicitly by QWindow::show(). Furthermore, QWindow::create() documentation states: "Note that it is not usually necessary to call this function directly, as it will be implicitly called by show(), setVisible(), and other functions that require access to the platform resources.". Change-Id: I632da86438f7f88c1fd8359b9fd6d52f329291cb Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Modernize rasterwindow/openglwindow examples to use requestUpdate()Tor Arne Vestbø2016-09-222-14/+13
| | | | | Change-Id: Ib8d0c42db7343247d0431ea008eb17da9ee98f4d Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Unify license header usage.Jani Heikkinen2016-03-293-15/+15
| | | | | | | | | Update files using old header.LGPL3 to header.LGPL Update files using old FDL template to use new one Update files using old BSD template to use new one Change-Id: I36a78272516f9953d02956522f285b40adfc8915 Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
* Update copyright headersJani Heikkinen2015-02-113-18/+18
| | | | | | | | | | | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Outdated header.LGPL removed (use header.LGPL21 instead) Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing combination. New header.LGPL-COMM taken in the use file which were using old header.LGPL3 (src/plugins/platforms/android/extract.cpp) Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license combination Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe Reviewed-by: Matti Paaso <matti.paaso@theqtcompany.com>
* Doc: Updated thumbnail images for some examples.Jerome Pasion2014-10-281-0/+0
| | | | | | | | | | | | | | | | | | | -Application Example -Analog Clock -Analog Clock Window -Scribble -Digital Clock -Thumbnail images were created with an obscure window manager and they look out of place in the Welcome Mode in Qt Creator. -Used Windows 7 as the platform. -Images within the documentation not updated because they are still relevant. Task-number: QTBUG-33597 Change-Id: I255fc4960e9adcec273f21287ef2182656c6b007 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Use title case in section1 titlesNico Vertriest2014-09-301-2/+2
| | | | | | | | Using Python script title-cased.py Task-number: QTBUG-41250 Change-Id: I00d3d7a0b30db7304a7904efd6d63abd9a7b493b Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix unopened commentSze Howe Koh2013-01-281-1/+1
| | | | | Change-Id: I68d131bb29ed4c150ef2630654d2b8ff59ea47cf Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fix module name formatSze Howe Koh2013-01-251-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtCore -> Qt Core QtDBus -> Qt D-Bus QtDesigner -> Qt Designer QtGui -> Qt GUI QtImageFormats -> Qt Image Formats QtNetwork -> Qt Network QtPrintSupport -> Qt Print Support QtScript -> Qt Script QtSql -> Qt SQL QtSvg -> Qt SVG QtTest -> Qt Test QtWebKit -> Qt WebKit QtWidgets -> Qt Widgets QtXml -> Qt XML QtConcurrent -> Qt Concurrent (partial) QtQuick -> Qt Quick (partial) Also, distinguish between "module" and "library" Change-Id: Icb8aa695ae60b0e45920b0c8fce4dc763a12b0cd Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-183-3/+3
| | | | | Change-Id: Ic804938fc352291d011800d21e549c10acac66fb Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: corrected typo "the the"Nico Vertriest2013-01-111-1/+1
| | | | | | | | | | | Task-number: QTBUG-28756 Spurious repetition of the definite article Trailing space issue corrected. Change-Id: I3a051f5dc291e546d8d67d6775e84b388bdc0363 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Qt Gui Examples: Fixed QDoc filesChristiaan Janssen2012-12-183-0/+0
| | | | | Change-Id: I160d8d186a1078f20f2b779bfbdae90459c27641 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Entered hardcoded url workaround QTBUG-28500Nico Vertriest2012-12-141-2/+2
| | | | | | | | Url for OpenGL Registry Url for Khronos OpenGL ES API Registry Change-Id: I682ddcedf1e06d589e5c44e364936c78fd9219a5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Some fixes to the OpenGL docs in GUIGunnar Sletta2012-12-121-0/+0
| | | | | Change-Id: I6415ff16b1765a5814d50a4cd39db00495d43073 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Fix reference to example pathshjk2012-12-063-3/+3
| | | | | | | | This eliminates seven EXAMPLE PATH DOES NOT EXIST warnings. Change-Id: Iaa6267138a1799fb775f0034805d5691bfa40d7c Reviewed-by: Christian Stenger <christian.stenger@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Add \brief to the examples.Eike Ziller2012-11-293-3/+3
| | | | | | | | | That is used by qdoc to generate brief descriptions for the example manifests. Change-Id: I142a6d3259f90d0c9990033b3c36e139062ac343 Reviewed-by: Eike Ziller <eike.ziller@digia.com> Reviewed-by: hjk <qthjk@ovi.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-223-42/+42
| | | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: If1cc974286d29fd01ec6c19dd4719a67f4c3f00e Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Move gui example doc example images.Frederik Gladhorn2012-09-112-0/+0
| | | | | Change-Id: I01e0c3d51bcb01c66a3f6c7b2ba95f0c9999f4cb Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>
* Moved gui example documentation to the proper location.Samuel Rødal2012-09-013-0/+455
Gui example documentation should be in examples/gui/doc/ Change-Id: I3cd196a2bb5d76b6e275f336b29a2ad1811159dd Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 05:34:27 +0000