Make rendernode suitable for public consumption

For non-OpenGL APIs the primary (and likely the only) way to add custom
rendering into the Qt Quick scene is via the render node. Other
approaches,like the before/afterRendering signals,
QQuickFramebufferObject, remain OpenGL-only. (although QQuickFramebufferObject
may get a multi-API replacement based on QSGRenderNode at a later time)

Note that this is not a generic 3D content integration enabler. It targets
creating 2D and 2.5D Quick items with custom rendering via the graphics
API in use.

Make QSGRenderNode public, enhance the docs a bit and add a releaseResources().
Add a QSGRendererInterface with a query function in QQuickWindow and
QSGEngine. The scenegraph adaptation can then return a custom implementation of
the interface. This will be necessary to query API-specific values, f.ex. the
ID3D12Device and ID3D12CommandList when running with the d3d12 backend.

The interface allows querying the API and void* resources. Resources that
we know about in advance are enum-based to prevent the
QPlatformNativeInterface-like ugliness of string keys.

Support is there in the batch renderer already, fix this up according to
the new public API, and implement the corresponding bits for the D3D12
renderer.

For D3D12, fix also an issue with QSGNode destruction where graphics resources
in use were attempted to be final-released without a proper wait.

The semantics of changedStates() in QSGRenderNode is changed so that it can be
called at any time, including before render(). This is very useful since we can
implement some state restoring in a more efficient manner.

Added a new example as well. Documentation for QSGRenderNode is heavily
expanded.

Change-Id: I4c4a261c55791d0e38743a784bc4c05a53b3462d
Reviewed-by: Andy Nichols <andy.nichols@qt.io>

1 files changed, 5 insertions, 46 deletions

diff --git a/src/quick/scenegraph/coreapi/qsgrendernode_p.h b/src/quick/scenegraph/coreapi/qsgrendernode_p.h
index 8659b0e62c..5c42e55689 100644
--- a/src/quick/scenegraph/coreapi/qsgrendernode_p.h
+++ b/src/quick/scenegraph/coreapi/qsgrendernode_p.h
@@ -51,64 +51,23 @@
 // We mean it.
 //
 
-#include "qsgnode.h"
-#include <private/qtquickglobal_p.h>
+#include <QtQuick/qsgnode.h>
+#include <QtQuick/qsgrendernode.h>
 
 QT_BEGIN_NAMESPACE
 
-namespace QSGBatchRenderer {
-    class Renderer;
-}
-
-class Q_QUICK_PRIVATE_EXPORT QSGRenderNode : public QSGNode
+class QSGRenderNodePrivate
 {
 public:
-    enum StateFlag
-    {
-        DepthState = 0x01, // depth mask, depth test enable, depth func, clear depth
-        StencilState = 0x02, // stencil mask, stencil test enable, stencil op, stencil func, clear stencil
-        ScissorState = 0x04, // scissor enable, scissor test enable
-        ColorState = 0x08, // clear color, color mask
-        BlendState = 0x10, // blend enable, blend func
-        CullState = 0x20, // front face, cull face enable
-        ViewportState = 0x40 // viewport
-    };
-    Q_DECLARE_FLAGS(StateFlags, StateFlag)
-
-    struct RenderState
-    {
-        // The model-view matrix can be retrieved with matrix().
-        // The opacity can be retrieved with inheritedOpacity().
-        const QMatrix4x4 *projectionMatrix;
-        QRect scissorRect;
-        int stencilValue;
-
-        bool stencilEnabled;
-        bool scissorEnabled;
-    };
-
-    QSGRenderNode();
+    QSGRenderNodePrivate();
 
-    virtual StateFlags changedStates() = 0;
-    virtual void render(const RenderState &state) = 0;
-
-    const QMatrix4x4 *matrix() const { return m_matrix; }
-    const QSGClipNode *clipList() const { return m_clip_list; }
-
-    void setInheritedOpacity(qreal opacity);
-    qreal inheritedOpacity() const { return m_opacity; }
-
-private:
-    friend class QSGNodeUpdater;
-    friend class QSGBatchRenderer::Renderer;
+    static QSGRenderNodePrivate *get(QSGRenderNode *node) { return node->d; }
 
     const QMatrix4x4 *m_matrix;
     const QSGClipNode *m_clip_list;
     qreal m_opacity;
 };
 
-Q_DECLARE_OPERATORS_FOR_FLAGS(QSGRenderNode::StateFlags)
-
 QT_END_NAMESPACE
 
 #endif