Adapt to the RHI API concept

Besides following the header naming changes, make the obvious API
changes that are based on data that is already there but was hidden
previously due to not wanting anything QRhi to shine through in the
public API.

This kind of hiding is no longer needed, even if qrhi.h and similar
still cannot be included from a public header. Forward declarations
are now perfectly fine however.

Task-number: QTBUG-113331
Change-Id: I9a114082cf9218edc487df50956f5793d6b8bdb4
Reviewed-by: Volker Hilsheimer <[email protected]>

1 files changed, 16 insertions, 10 deletions

diff --git a/examples/quick/scenegraph/customrendernode/doc/src/customrendernode.qdoc b/examples/quick/scenegraph/customrendernode/doc/src/customrendernode.qdoc
index 1972d99c4d..4240e30558 100644
--- a/examples/quick/scenegraph/customrendernode/doc/src/customrendernode.qdoc
+++ b/examples/quick/scenegraph/customrendernode/doc/src/customrendernode.qdoc
@@ -12,15 +12,21 @@
 
     \image customrendernode-example.gif
 
-    QSGRenderNode allows direct access to the Render Hardware Interface (RHI) within the
-    scenegraph. This example demonstrates how to create QSGRenderNode based render node
-    and manage it with a custom item. The render node creates an RHI pipeline, updates
-    vertex and uniform buffers, and renders into the RHI command buffer.
+    QSGRenderNode allows direct access to the Render Hardware Interface (RHI)
+    within the scenegraph. This example demonstrates how to create QSGRenderNode
+    based render node and manage it with a custom item. The render node creates
+    an RHI pipeline, updates vertex and uniform buffers, and renders into the
+    RHI command buffer.
 
-    \warning This example demonstrates advanced, low-level functionality
-    performing portable, cross-platform 3D rendering, while relying on private
-    APIs from the Qt Gui and Qt Quick modules. Developers are encouraged to
-    carefully evaluate the potential lack of source and binary compatibility
-    guarantees before using these APIs in their applications.
+    In practice this is a portable, cross-platform approach to perform custom
+    rendering inline with the scenegraph's own rendering, without resorting to a
+    native 3D API such as OpenGL, Metal, or Vulkan. Rather, the application uses
+    Qt's graphics and shader abstraction layer.
 
- */
+    \note This example demonstrates advanced, low-level functionality performing
+    portable, cross-platform 3D rendering, while relying on APIs with limited
+    compatibility guarantee from the Qt Gui module.  To be able to use the QRhi
+    APIs, the application links to \c{Qt::GuiPrivate} and includes
+    \c{<rhi/qrhi.h>}.
+
+*/