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, 52 insertions, 6 deletions

diff --git a/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp b/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp
index afeeea760c..cbdf54a9ea 100644
--- a/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp
+++ b/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp
@@ -360,6 +360,16 @@ void QSGD3D12Engine::endLayer()
     d->endLayer();
 }
 
+void QSGD3D12Engine::invalidateCachedFrameState()
+{
+    d->invalidateCachedFrameState();
+}
+
+void QSGD3D12Engine::restoreFrameState(bool minimal)
+{
+    d->restoreFrameState(minimal);
+}
+
 void QSGD3D12Engine::finalizePipeline(const QSGD3D12PipelineState &pipelineState)
 {
     d->finalizePipeline(pipelineState);
@@ -495,6 +505,16 @@ void QSGD3D12Engine::activateRenderTargetAsTexture(uint id)
     d->activateRenderTargetAsTexture(id);
 }
 
+QSGRendererInterface::GraphicsAPI QSGD3D12Engine::graphicsAPI() const
+{
+    return Direct3D12;
+}
+
+void *QSGD3D12Engine::getResource(Resource resource) const
+{
+    return d->getResource(resource);
+}
+
 static inline quint32 alignedSize(quint32 size, quint32 byteAlign)
 {
     return (size + byteAlign - 1) & ~(byteAlign - 1);
@@ -1296,7 +1316,11 @@ void QSGD3D12EnginePrivate::beginDrawCalls()
 {
     frameCommandList->Reset(frameCommandAllocator[frameIndex % frameInFlightCount].Get(), nullptr);
     commandList = frameCommandList.Get();
+    invalidateCachedFrameState();
+}
 
+void QSGD3D12EnginePrivate::invalidateCachedFrameState()
+{
     tframeData.drawingMode = QSGGeometry::DrawingMode(-1);
     tframeData.currentIndexBuffer = 0;
     tframeData.drawCount = 0;
@@ -1305,6 +1329,18 @@ void QSGD3D12EnginePrivate::beginDrawCalls()
     tframeData.descHeapSet = false;
 }
 
+void QSGD3D12EnginePrivate::restoreFrameState(bool minimal)
+{
+    queueSetRenderTarget(currentRenderTarget);
+    if (!minimal) {
+        queueViewport(tframeData.viewport);
+        queueScissor(tframeData.scissor);
+        queueSetBlendFactor(tframeData.blendFactor);
+        queueSetStencilRef(tframeData.stencilRef);
+    }
+    finalizePipeline(tframeData.pipelineState);
+}
+
 void QSGD3D12EnginePrivate::beginFrameDraw()
 {
     if (windowSamples == 1)
@@ -1886,12 +1922,7 @@ void QSGD3D12EnginePrivate::queueDraw(const QSGD3D12Engine::DrawParams &params)
         // start a new one
         beginDrawCalls();
         // prepare for the upcoming drawcalls
-        queueSetRenderTarget(currentRenderTarget);
-        queueViewport(tframeData.viewport);
-        queueScissor(tframeData.scissor);
-        queueSetBlendFactor(tframeData.blendFactor);
-        queueSetStencilRef(tframeData.stencilRef);
-        finalizePipeline(tframeData.pipelineState);
+        restoreFrameState();
     }
 }
 
@@ -2737,4 +2768,19 @@ void QSGD3D12EnginePrivate::activateRenderTargetAsTexture(uint id)
     tframeData.activeTextures.append(TransientFrameData::ActiveTexture::ActiveTexture(TransientFrameData::ActiveTexture::TypeRenderTarget, id));
 }
 
+void *QSGD3D12EnginePrivate::getResource(QSGRendererInterface::Resource resource) const
+{
+    switch (resource) {
+    case QSGRendererInterface::Device:
+        return device;
+    case QSGRendererInterface::CommandQueue:
+        return commandQueue.Get();
+    case QSGRendererInterface::CommandList:
+        return commandList;
+    default:
+        break;
+    }
+    return nullptr;
+}
+
 QT_END_NAMESPACE