Adaptable shader effect enablers

The D3D12 node implementation is mostly missing. The rest of the enablers
should be in place now however.

Importing QtQuick 2.8 provides new properties for ShaderEffect:

- shaderType can be used to decide which language should be used

- shaderCompilationType tells if compilation is runtime or offline

- shaderSourceType tells if the vertex/fragmentShader properties refer
  to source strings or source files or pre-compiled bytecode files

The last two are bitmasks. In practice however we will support only
one approach per backend for now (runtime + source string for OpenGL,
offline + bytecode for D3D12).

In addition to QSGShaderEffectNode, introduce the QSGGuiThreadShaderEffectManager
interface. This provides the gui thread bits for the above and performs shader
reflection. Backends that use the new ShaderEffect system must provide both.
For each ShaderEffect item there will be a manager (on the gui thread) and
a node (on the render thread).

Reflection is expected to be done via standard helper libs (d3d12shader
+ D3DReflect from d3dcompiler for the D3D12 backend), or via manually inspecting
SPIR-V, or parsing the source (like the GL path does now), or by using some
3rd party library (not recommended). In any case we require that reflection is
doable on the gui thread without dependencies to the actual graphics API.

The ShaderEffect documentation is greatly extended, covering HLSL and the new
properties.

The test app uses manually compiled shaders on its HLSL path for now. This
is because there is no story yet for build system integration for public
use (the internal HLSL -> bytecode in C header rule is only suitable for
the d3d12 plugin itself, apps need something different).

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

9 files changed, 135 insertions, 1 deletions

diff --git a/tests/manual/nodetypes/Effects.qml b/tests/manual/nodetypes/Effects.qml
new file mode 100644
index 0000000000..8af9a5eb95
--- /dev/null
+++ b/tests/manual/nodetypes/Effects.qml
@@ -0,0 +1,92 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the demonstration applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+// Use QtQuick 2.8 to get shaderType and the other new properties
+import QtQuick 2.8
+
+Item {
+    Rectangle {
+        color: "gray"
+        anchors.margins: 10
+        anchors.fill: parent
+        Image {
+            id: image
+            source: "qrc:/qt.png"
+        }
+        ShaderEffectSource {
+            id: effectSource
+            sourceItem: image
+            hideSource: true
+        }
+        ShaderEffect {
+            width: image.width
+            height: image.height
+            anchors.centerIn: parent
+
+            property variant source: effectSource
+            property real amplitude: 0.04 * 0.2
+            property real frequency: 20
+            property real time: 0
+
+            NumberAnimation on time { loops: Animation.Infinite; from: 0; to: Math.PI * 2; duration: 600 }
+
+            property string glslFragmentShader:
+                "uniform sampler2D source;" +
+                "uniform highp float amplitude;" +
+                "uniform highp float frequency;" +
+                "uniform highp float time;" +
+                "uniform lowp float qt_Opacity;" +
+                "varying highp vec2 qt_TexCoord0;" +
+                "void main() {" +
+                "    highp vec2 p = sin(time + frequency * qt_TexCoord0);" +
+                "    gl_FragColor = texture2D(source, qt_TexCoord0 + amplitude * vec2(p.y, -p.x)) * qt_Opacity;" +
+                "}"
+
+            property string hlslVertexShaderByteCode: "qrc:/vs_wobble.cso"
+            property string hlslPixelShaderByteCode: "qrc:/ps_wobble.cso"
+
+            // This effect does not need a custom vertex shader but have one with HLSL just to test that path as well.
+            vertexShader: shaderType === ShaderEffect.GLSL ? ""
+                                                           : (shaderType === ShaderEffect.HLSL ? hlslVertexShaderByteCode : "")
+            fragmentShader: shaderType === ShaderEffect.GLSL ? glslFragmentShader
+                                                             : (shaderType === ShaderEffect.HLSL ? hlslPixelShaderByteCode : "")
+        }
+    }
+}
diff --git a/tests/manual/nodetypes/effects.hlsl b/tests/manual/nodetypes/effects.hlsl
new file mode 100644
index 0000000000..203dbda7f2
--- /dev/null
+++ b/tests/manual/nodetypes/effects.hlsl
@@ -0,0 +1,32 @@
+cbuffer ConstantBuffer : register(b0)
+{
+    float4x4 qt_Matrix;
+    float qt_Opacity;
+
+    float amplitude;
+    float frequency;
+    float time;
+};
+
+struct PSInput
+{
+    float4 position : SV_POSITION;
+    float2 coord : TEXCOORD0;
+};
+
+PSInput VS_Wobble(float4 position : POSITION, float2 coord : TEXCOORD0)
+{
+    PSInput result;
+    result.position = mul(qt_Matrix, position);
+    result.coord = coord;
+    return result;
+}
+
+Texture2D source : register(t0);
+SamplerState sourceSampler : register(s0);
+
+float4 PS_Wobble(PSInput input) : SV_TARGET
+{
+    float2 p = sin(time + frequency * input.coord);
+    return source.Sample(sourceSampler, input.coord + amplitude * float2(p.y, -p.x)) * qt_Opacity;
+}
diff --git a/tests/manual/nodetypes/hlslcompile.bat b/tests/manual/nodetypes/hlslcompile.bat
new file mode 100644
index 0000000000..8f7ca86069
--- /dev/null
+++ b/tests/manual/nodetypes/hlslcompile.bat
@@ -0,0 +1,2 @@
+fxc /E VS_Wobble /T vs_5_0 /Fo vs_wobble.cso effects.hlsl
+fxc /E PS_Wobble /T ps_5_0 /Fo ps_wobble.cso effects.hlsl
diff --git a/tests/manual/nodetypes/main.qml b/tests/manual/nodetypes/main.qml
index fe75e2d948..10f5840262 100644
--- a/tests/manual/nodetypes/main.qml
+++ b/tests/manual/nodetypes/main.qml
@@ -68,5 +68,8 @@ Item {
 
         if (event.key === Qt.Key_L)
             loader.source = "qrc:/Layers.qml";
+
+        if (event.key === Qt.Key_E)
+            loader.source = "qrc:/Effects.qml";
     }
 }
diff --git a/tests/manual/nodetypes/nodetypes.cpp b/tests/manual/nodetypes/nodetypes.cpp
index aaa641f300..3ebae43c00 100644
--- a/tests/manual/nodetypes/nodetypes.cpp
+++ b/tests/manual/nodetypes/nodetypes.cpp
@@ -67,6 +67,7 @@ int main(int argc, char **argv)
     qDebug("  [T] - Text");
     qDebug("  [A] - Render thread Animator");
     qDebug("  [L] - Layers");
+    qDebug("  [E] - Effects");
     qDebug("\nPress S to stop the currently running test\n");
 
     Helper helper;
diff --git a/tests/manual/nodetypes/nodetypes.pro b/tests/manual/nodetypes/nodetypes.pro
index a1633dcf22..51a6ac3e5a 100644
--- a/tests/manual/nodetypes/nodetypes.pro
+++ b/tests/manual/nodetypes/nodetypes.pro
@@ -4,4 +4,5 @@ SOURCES += nodetypes.cpp
 
 RESOURCES += nodetypes.qrc
 
-OTHER_FILES += main.qml Rects.qml LotsOfRects.qml Images.qml Text.qml Animators.qml Layers.qml
+OTHER_FILES += main.qml Rects.qml LotsOfRects.qml \
+               Images.qml Text.qml Animators.qml Layers.qml Effects.qml effects.hlsl
diff --git a/tests/manual/nodetypes/nodetypes.qrc b/tests/manual/nodetypes/nodetypes.qrc
index b10fceef24..f6c007e3f3 100644
--- a/tests/manual/nodetypes/nodetypes.qrc
+++ b/tests/manual/nodetypes/nodetypes.qrc
@@ -7,8 +7,11 @@
         <file>Text.qml</file>
         <file>Animators.qml</file>
         <file>Layers.qml</file>
+        <file>Effects.qml</file>
         <file>qt.png</file>
         <file>face-smile.png</file>
         <file>shadow.png</file>
+        <file>vs_wobble.cso</file>
+        <file>ps_wobble.cso</file>
     </qresource>
 </RCC>
diff --git a/tests/manual/nodetypes/ps_wobble.cso b/tests/manual/nodetypes/ps_wobble.cso
new file mode 100644
index 0000000000..4e5b6a27f4
--- /dev/null
+++ b/tests/manual/nodetypes/ps_wobble.cso
diff --git a/tests/manual/nodetypes/vs_wobble.cso b/tests/manual/nodetypes/vs_wobble.cso
new file mode 100644
index 0000000000..f3a2596457
--- /dev/null
+++ b/tests/manual/nodetypes/vs_wobble.cso