aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@qt.io>2023-05-23 12:33:18 +0200
committerLaszlo Agocs <laszlo.agocs@qt.io>2023-06-01 11:27:48 +0200
commit6bdc58c2dbeffe723e4d6ae878ad380e118104ca (patch)
treed8f5dbdc5c2ae9a02cc4686e909987fb8144049d
parent450fa684f7444bd07e85cc1f645c6dbda19d4024 (diff)
rhiunderqml example doc: Fix a link and improve a note
Change-Id: I663db98e275ea1cbc49b1314e4b18892e5c8c00f Reviewed-by: Andy Nichols <andy.nichols@qt.io>
-rw-r--r--examples/quick/scenegraph/rhiunderqml/doc/src/rhiunderqml.qdoc15
1 files changed, 8 insertions, 7 deletions
diff --git a/examples/quick/scenegraph/rhiunderqml/doc/src/rhiunderqml.qdoc b/examples/quick/scenegraph/rhiunderqml/doc/src/rhiunderqml.qdoc
index 5eab97b490..358b89123c 100644
--- a/examples/quick/scenegraph/rhiunderqml/doc/src/rhiunderqml.qdoc
+++ b/examples/quick/scenegraph/rhiunderqml/doc/src/rhiunderqml.qdoc
@@ -51,7 +51,7 @@
\list
\li The scene graph's render loop calls \l QRhi::beginFrame()
\li \l QQuickWindow::beforeRendering() is emitted - the application prepares resources for its custom rendering
- \li The scene graph calls \l QRhi::beginPass()
+ \li The scene graph calls \l QRhiCommandBuffer::beginPass()
\li \l QQuickWindow::beforeRenderPassRecording() is emitted - the application records draw calls
\li The scene graph records draw calls
\endlist
@@ -171,12 +171,13 @@
perfectly fine as well. The important thing to keep in mind is that whatever
is recorded on the \l QRhiCommandBuffer retrieved from the window's
\l{QRhiSwapChain}{swapchain}, it is effectively prepended before the Qt Quick
- scene graph's own rendering within the main render pass. This means that,
- for example, if depth buffer usage with depth testing and writing out depth
- values is involved, then the Qt Quick content may be affected by the values
- written to the depth buffer. See \l{Qt Quick Scene Graph Default Renderer}
- for details on the scene graph's renderer, in particular the sections about
- the handling of \e opaque and \e{alpha blended} primitives.
+ scene graph's own rendering within the main render pass.
+
+ \note This means that if depth buffer usage with depth testing and writing
+ out depth values is involved, then the Qt Quick content may be affected by
+ the values written to the depth buffer. See \l{Qt Quick Scene Graph Default
+ Renderer} for details on the scene graph's renderer, in particular the
+ sections about the handling of \e opaque and \e{alpha blended} primitives.
To get the window size in pixels, \l QRhiRenderTarget::pixelSize() is used.
This is convenient because this way the example does not need to calculate