Merge lp:~loic.molinari/ubuntu-ui-toolkit/ubuntu-ui-toolkit-shape-content-orientation-workaround-removal into lp:ubuntu-ui-toolkit/staging

[Loïc Molinari]

[UbuntuShape] Removed content orientation work around.

The shape was using a workaround to make it render correctly when the content orientation was not the native one. This was perfect for the OrientationHelper shipped with the toolkit but now that the Shell implements the rotation, this is not needed anymore and causes some rendering issues. Note that the shape will still needs to support correct rendering when rotated using the rotation property of the Item, but that is a different issue.

[UbuntuShape] Removed content orientation work around.

The shape was using a workaround to make it render correctly when the content orientation was not the native one. This was perfect for the OrientationHelper shipped with the toolkit but now that the Shell implements the rotation, this is not needed anymore and causes some rendering issues. Note that the shape will still needs to support correct rendering when rotated using the rotation property of the Item, but that is a different issue.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1586
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2077/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/805
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/807
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/807/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/804

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2077/rebuild

review: Approve (continuous-integration)

[Cris Dywan (kalikiana)]

This makes sense.

However I have a small concern. With this change the UbuntuShape becomes "incompatible" with platforms that use Window.contentOrientation such as Ubuntu Phone used to, and others such as Wayland, Android, Sailfish, etc. might - if we care about apps on other platforms that is. Now as already pointed out, Item.rotation isn't currently supported but could be - and technically even the Window.contentOrientation applied by OrientationHelper was changing Item.rotation all along, only that's now what the code was based on. So, I'm wondering, can we have transparent Item.rotation support? And can/ should we avoid being too specific to what Unity8 does, as hard-coding shell-specifics in the toolkit seems less than future proof?

review: Needs Information

[Loïc Molinari (loic.molinari)]

That is true and I plan to propose a solution that works for both Item.rotation and Window.contentOrientation. There is a dedicated bug for that (bug #1480199).

[Cris Dywan (kalikiana)]

Okay, thanks. So this is good to go.

review: Approve

=== modified file 'src/Ubuntu/Components/plugin/shaders/shape.frag'
--- src/Ubuntu/Components/plugin/shaders/shape.frag	2015-07-23 16:01:51 +0000
+++ src/Ubuntu/Components/plugin/shaders/shape.frag	2015-07-31 10:02:25 +0000
@@ -24,8 +24,8 @@
 
 uniform sampler2D shapeTexture;
 uniform sampler2D sourceTexture;
-uniform lowp vec2 dfdtFactors;
 uniform lowp vec2 opacityFactors;
+uniform lowp float dfdtFactor;
 uniform lowp float sourceOpacity;
 uniform lowp float distanceAA;
 uniform bool textured;
@@ -56,10 +56,9 @@
     }
 
     // Get screen-space derivative of texture coordinate t representing the normalized distance
-    // between 2 pixels. dFd*() unfortunately have to be called outside of branches in order to work
+    // between 2 pixels. dFd*() functions have to be called outside of branches in order to work
     // correctly with VMware's "Gallium 0.4 on SVGA3D".
-    lowp vec2 derivatives = vec2(dFdx(shapeCoord.t), dFdy(shapeCoord.t));
-    lowp float dfdt = dfdtFactors.x != 0.0 ? derivatives.x : derivatives.y;
+    lowp float dfdt = dFdy(shapeCoord.t);
 
     if (aspect == FLAT) {
         // Mask the current color with an anti-aliased and resolution independent shape mask built
@@ -71,7 +70,7 @@
     } else if (aspect == INSET) {
         // The vertex layout of the shape is made so that the derivative is negative from top to
         // middle and positive from middle to bottom.
-        lowp float shapeSide = dfdt * dfdtFactors.y <= 0.0 ? 0.0 : 1.0;
+        lowp float shapeSide = dfdt * dfdtFactor <= 0.0 ? 0.0 : 1.0;
         // Blend the shape inner shadow over the current color. The shadow color is black, its
         // translucency is stored in the texture.
         lowp float shadow = shapeData[int(shapeSide)];
@@ -93,11 +92,11 @@
     } else if (aspect == DROP_SHADOW) {
         // The vertex layout of the shape is made so that the derivative is negative from top to
         // middle and positive from middle to bottom.
-        lowp float shapeSide = dfdt * dfdtFactors.y <= 0.0 ? 0.0 : 1.0;
+        lowp int shapeSide = dfdt * dfdtFactor <= 0.0 ? 0 : 1;
         // Get the anti-aliased and resolution independent shape mask using distance fields.
         lowp float distanceMin = abs(dfdt) * -distanceAA + 0.5;
         lowp float distanceMax = abs(dfdt) * distanceAA + 0.5;
-        lowp float mask = smoothstep(distanceMin, distanceMax, shapeData[int(shapeSide)]);
+        lowp float mask = smoothstep(distanceMin, distanceMax, shapeData[shapeSide]);
         // Get the shadow color outside of the shape mask.
         lowp float shadow = (shapeData.b * -mask) + shapeData.b;  // -ab + a = a(1 - b)
         // Mask the current color then blend the shadow over the resulting color. We simply use

=== modified file 'src/Ubuntu/Components/plugin/shaders/shapeoverlay.frag'
--- src/Ubuntu/Components/plugin/shaders/shapeoverlay.frag	2015-04-16 11:59:56 +0000
+++ src/Ubuntu/Components/plugin/shaders/shapeoverlay.frag	2015-07-31 10:02:25 +0000
@@ -24,8 +24,8 @@
 
 uniform sampler2D shapeTexture;
 uniform sampler2D sourceTexture;
-uniform lowp vec2 dfdtFactors;
 uniform lowp vec2 opacityFactors;
+uniform lowp float dfdtFactor;
 uniform lowp float sourceOpacity;
 uniform lowp float distanceAA;
 uniform bool textured;
@@ -64,10 +64,9 @@
     color = vec4(1.0 - overlay.a) * color + overlay;
 
     // Get screen-space derivative of texture coordinate t representing the normalized distance
-    // between 2 pixels. dFd*() unfortunately have to be called outside of branches in order to work
+    // between 2 pixels. dFd*() functions have to be called outside of branches in order to work
     // correctly with VMware's "Gallium 0.4 on SVGA3D".
-    lowp vec2 derivatives = vec2(dFdx(shapeCoord.t), dFdy(shapeCoord.t));
-    lowp float dfdt = dfdtFactors.x != 0.0 ? derivatives.x : derivatives.y;
+    lowp float dfdt = dFdy(shapeCoord.t);
 
     if (aspect == FLAT) {
         // Mask the current color with an anti-aliased and resolution independent shape mask built
@@ -79,7 +78,7 @@
     } else if (aspect == INSET) {
         // The vertex layout of the shape is made so that the derivative is negative from top to
         // middle and positive from middle to bottom.
-        lowp float shapeSide = dfdt * dfdtFactors.y <= 0.0 ? 0.0 : 1.0;
+        lowp float shapeSide = dfdt * dfdtFactor <= 0.0 ? 0.0 : 1.0;
         // Blend the shape inner shadow over the current color. The shadow color is black, its
         // translucency is stored in the texture.
         lowp float shadow = shapeData[int(shapeSide)];

=== modified file 'src/Ubuntu/Components/plugin/ucubuntushape.cpp'
--- src/Ubuntu/Components/plugin/ucubuntushape.cpp	2015-07-24 18:11:57 +0000
+++ src/Ubuntu/Components/plugin/ucubuntushape.cpp	2015-07-31 10:02:25 +0000
@@ -74,8 +74,8 @@
 
     m_functions = QOpenGLContext::currentContext()->functions();
     m_matrixId = program()->uniformLocation("matrix");
-    m_dfdtFactorsId = program()->uniformLocation("dfdtFactors");
     m_opacityFactorsId = program()->uniformLocation("opacityFactors");
+    m_dfdtFactorId = program()->uniformLocation("dfdtFactor");
     m_sourceOpacityId = program()->uniformLocation("sourceOpacity");
     m_distanceAAId = program()->uniformLocation("distanceAA");
     m_texturedId = program()->uniformLocation("textured");
@@ -138,13 +138,9 @@
     const float distanceAA = (shapeTextureDistanceAA * distanceAApx) / (2.0 * 255.0f);
     program()->setUniformValue(m_distanceAAId, data->distanceAAFactor * distanceAA);
 
-    // Send screen-space derivative factors. Note that when rendering is redirected to a
-    // ShaderEffectSource (FBO), dFdy() sign is flipped.
-    const float orientation = static_cast<float>(data->dfdtFactors & 0x4);
-    const float flip = static_cast<float>(data->dfdtFactors & 0x3) - 1.0f;
-    const bool flipped = orientation != 1.0f && state.projectionMatrix()(1, 3) < 0.0f;
-    const QVector2D dfdtFactors(orientation, flipped ? -flip : flip);
-    program()->setUniformValue(m_dfdtFactorsId, dfdtFactors);
+    // When rendering is redirected to a ShaderEffectSource (FBO), dFdy() sign is flipped.
+    const float dfdtFactor = (state.projectionMatrix()(1, 3) < 0.0f) ? -1.0f : 1.0f;
+    program()->setUniformValue(m_dfdtFactorId, dfdtFactor);
 
     // Update QtQuick engine uniforms.
     if (state.isMatrixDirty()) {
@@ -252,7 +248,6 @@
 
 static struct { QOpenGLContext* openglContext; quint32 textureId[shapeTextureCount]; }
     shapeTextures[maxShapeTextures];
-static bool isPrimaryOrientationLandscape = false;
 
 static int getShapeTexturesIndex(const QOpenGLContext* openglContext);
 
@@ -310,17 +305,6 @@
     , m_sourceOpacity(255)
     , m_flags(Stretched)
 {
-    static bool once = true;
-    if (once) {
-        // Stored statically as the primary orientation is fixed and we don't support multiple
-        // screens for now.
-        if (QGuiApplication::primaryScreen()->primaryOrientation() &
-            (Qt::LandscapeOrientation | Qt::InvertedLandscapeOrientation)) {
-            isPrimaryOrientationLandscape = true;
-        }
-        once = false;
-    }
-
     setFlag(ItemHasContents);
     QObject::connect(&UCUnits::instance(), SIGNAL(gridUnitChanged()), this,
                      SLOT(_q_gridUnitChanged()));
@@ -1307,25 +1291,6 @@
     materialData->distanceAAFactor =
         qMin((radius / (end - start)) - (start / (end - start)), 1.0f) * 255.0f;
 
-    // Screen-space derivatives factors for fragment shaders depend on the primary orientation and
-    // content orientation. A flag indicating a 90° rotation around the primary orientation is
-    // stored on the 3rd bit of dfdtFactors, the flip factor is stored on the first 2 bits as 0 for
-    // -1 and as 2 for 1 (efficiently converted using: float(x & 0x3) - 1.0f).
-    const Qt::ScreenOrientation contentOrientation = window()->contentOrientation();
-    if (isPrimaryOrientationLandscape) {
-        const quint8 portraitMask = Qt::PortraitOrientation | Qt::InvertedPortraitOrientation;
-        const quint8 flipMask = Qt::InvertedLandscapeOrientation | Qt::InvertedPortraitOrientation;
-        quint8 factors = contentOrientation & portraitMask ? 0x4 : 0x0;
-        factors |= contentOrientation & flipMask ? 0x0 : 0x2;
-        materialData->dfdtFactors = factors;
-    } else {
-        const quint8 landscapeMask = Qt::LandscapeOrientation | Qt::InvertedLandscapeOrientation;
-        const quint8 flipMask = Qt::InvertedPortraitOrientation | Qt::LandscapeOrientation;
-        quint8 factors = contentOrientation & landscapeMask ? 0x4 : 0x0;
-        factors |= contentOrientation & flipMask ? 0x0 : 0x2;
-        materialData->dfdtFactors = factors;
-    }
-
     // When the radius is equal to radiusSizeOffset (which means radius size is 0), no aspect is
     // flagged so that a dedicated (statically flow controlled) shaved off shader can be used for
     // optimal performance.

=== modified file 'src/Ubuntu/Components/plugin/ucubuntushape.h'
--- src/Ubuntu/Components/plugin/ucubuntushape.h	2015-07-23 17:17:47 +0000
+++ src/Ubuntu/Components/plugin/ucubuntushape.h	2015-07-31 10:02:25 +0000
@@ -41,8 +41,8 @@
 private:
     QOpenGLFunctions* m_functions;
     int m_matrixId;
-    int m_dfdtFactorsId;
     int m_opacityFactorsId;
+    int m_dfdtFactorId;
     int m_sourceOpacityId;
     int m_distanceAAId;
     int m_texturedId;
@@ -70,7 +70,6 @@
         quint32 shapeTextureId;
         quint8 distanceAAFactor;
         quint8 sourceOpacity;
-        quint8 dfdtFactors;
         quint8 flags;
     };