diff options
| author | Laszlo Agocs <laszlo.agocs@qt.io> | 2019-08-30 13:13:54 +0200 |
|---|---|---|
| committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2019-09-08 09:42:11 +0200 |
| commit | ba3e72ab7e4c43806259b1de8f646bfd841d24e0 (patch) | |
| tree | 7d7c2013671c5232d1a73b76e98c4ed138775a51 /src | |
| parent | 1a5c6544c88d6092ca57e780e332a0f302041b06 (diff) | |
Clarify docs and comments regarding under and overlays
Change-Id: I8973798996b6c775f425819af1d6a09f1773a9dc
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/quick/items/qquickwindow.cpp | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp index 4e65c60b85..6fe2891242 100644 --- a/src/quick/items/qquickwindow.cpp +++ b/src/quick/items/qquickwindow.cpp @@ -4193,7 +4193,11 @@ QQmlIncubationController *QQuickWindow::incubationController() const command buffer, before via QSGRendererInterface. Note however that the render pass (or passes) are already recorded at this point and it is not possible to add more commands within the scenegraph's pass. Instead, use - afterRenderPassRecording() for that. + afterRenderPassRecording() for that. This signal has therefore limited use + and is rarely needed in an RHI-based setup. Rather, it is the combination + of beforeRendering() + beforeRenderPassRecording() or beforeRendering() + + afterRenderPassRecording() that is typically used to achieve under- or + overlaying of the custom rendering. \warning This signal is emitted from the scene graph rendering thread. If your slot function needs to finish before execution continues, you must make sure that @@ -4229,7 +4233,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const \note Resource updates (uploads, copies) typically cannot be enqueued from within a render pass. Therefore, more complex user rendering will need to - connect to both the beforeRendering() and this signals. + connect to both beforeRendering() and this signal. \warning This signal is emitted from the scene graph rendering thread. If your slot function needs to finish before execution continues, you must make sure that @@ -4260,7 +4264,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const \note Resource updates (uploads, copies) typically cannot be enqueued from within a render pass. Therefore, more complex user rendering will need to - connect to both the beforeRendering() and this signals. + connect to both beforeRendering() and this signal. \warning This signal is emitted from the scene graph rendering thread. If your slot function needs to finish before execution continues, you must make sure that |