Make DebugOverlay accessible from QML

Register and document QDebugOverlay.

Change-Id: I357918ce3448c451d796f88656ec287bf03ffcfd
Reviewed-by: Mike Krus <mike.krus@kdab.com>
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

2 files changed, 31 insertions, 0 deletions

diff --git a/src/quick3d/imports/render/qt3dquick3drenderplugin.cpp b/src/quick3d/imports/render/qt3dquick3drenderplugin.cpp
index a8492a80e..59fcfa6d6 100644
--- a/src/quick3d/imports/render/qt3dquick3drenderplugin.cpp
+++ b/src/quick3d/imports/render/qt3dquick3drenderplugin.cpp
@@ -118,6 +118,7 @@
 #include <Qt3DRender/qshaderimage.h>
 #include <Qt3DRender/qsubtreeenabler.h>
 #include <Qt3DRender/qrendercapabilities.h>
+#include <Qt3DRender/qdebugoverlay.h>
 
 #include <QtGui/qwindow.h>
 
@@ -274,6 +275,7 @@ void Qt3DQuick3DRenderPlugin::registerTypes(const char *uri)
     qmlRegisterType<Qt3DRender::QWaitFence>(uri, 2, 13, "WaitFence");
     qmlRegisterType<Qt3DRender::QNoPicking>(uri, 2, 14, "NoPicking");
     qmlRegisterType<Qt3DRender::QSubtreeEnabler>(uri, 2, 14, "SubtreeEnabler");
+    qmlRegisterType<Qt3DRender::QDebugOverlay>(uri, 2, 16, "DebugOverlay");
 
     // RenderTarget
     qmlRegisterType<Qt3DRender::QRenderTargetOutput>(uri, 2, 0, "RenderTargetOutput");
diff --git a/src/render/framegraph/qdebugoverlay.cpp b/src/render/framegraph/qdebugoverlay.cpp
index d82ae88ba..f6034ac73 100644
--- a/src/render/framegraph/qdebugoverlay.cpp
+++ b/src/render/framegraph/qdebugoverlay.cpp
@@ -42,6 +42,35 @@ QT_BEGIN_NAMESPACE
 namespace Qt3DRender {
 
 /*!
+    \class Qt3DRender::QDebugOverlay
+    \inmodule Qt3DRender
+    \ingroup framegraph
+    \brief Enables a visual overlay with scene details.
+
+    Placing a QDebugOverlay in one branch of a custom framegraph will cause an overlay
+    with scene details to be rendered along with the scene.
+
+    The standard QForwardRenderer includes a QDebugOverlay node that can be enabled via
+    the QForwardRenderer::showDebugOverlay property.
+
+*/
+
+/*!
+    \qmltype DebugOverlay
+    \inqmlmodule Qt3D.Render
+    \instantiates Qt3DRender::QDebugOverlay
+    \inherits FrameGraphNode
+    \since 2.16
+    \brief Enables a visual overlay with scene details.
+
+    Placing a DebugOverlay in one branch of a custom framegraph will cause an overlay
+    with scene details to be rendered along with the scene.
+
+    The standard ForwardRenderer includes a DebugOverlay node that can be enabled via
+    the ForwardRenderer::showDebugOverlay property.
+*/
+
+/*!
  * \internal
  */
 QDebugOverlayPrivate::QDebugOverlayPrivate()