Add a GLES 3.1 graphics helper

...to enable sampler2DMS uniforms.

Also fixes the ES3 helper when it comes to uniformByteSize.

[ChangeLog] 2D samplers for multisample textures are now supported
on OpenGL ES 3.1 and newer

Task-number: QTBUG-68403
Change-Id: Iee1bd8baf097e19d89f651845938c681fb2a4df9
Reviewed-by: Andy Nichols <andy.nichols@qt.io>

7 files changed, 314 insertions, 2 deletions

diff --git a/src/render/renderers/opengl/graphicshelpers/graphicscontext.cpp b/src/render/renderers/opengl/graphicshelpers/graphicscontext.cpp
index af1fb5675..e793a0068 100644
--- a/src/render/renderers/opengl/graphicshelpers/graphicscontext.cpp
+++ b/src/render/renderers/opengl/graphicshelpers/graphicscontext.cpp
@@ -74,6 +74,7 @@
 #endif
 #include <Qt3DRender/private/graphicshelperes2_p.h>
 #include <Qt3DRender/private/graphicshelperes3_p.h>
+#include <Qt3DRender/private/graphicshelperes3_1_p.h>
 #include <Qt3DRender/private/graphicshelperes3_2_p.h>
 
 #include <QSurface>
@@ -343,6 +344,9 @@ GraphicsHelperInterface *GraphicsContext::resolveHighestOpenGLFunctions()
             if (m_gl->format().minorVersion() >= 2) {
                 glHelper = new GraphicsHelperES3_2;
                 qCDebug(Backend) << Q_FUNC_INFO << " Building OpenGL ES 3.2 Helper";
+            } else if (m_gl->format().minorVersion() >= 1) {
+                glHelper = new GraphicsHelperES3_1;
+                qCDebug(Backend) << Q_FUNC_INFO << " Building OpenGL ES 3.1 Helper";
             } else {
                 glHelper = new GraphicsHelperES3();
                 qCDebug(Backend) << Q_FUNC_INFO << " Building OpenGL ES 3.0 Helper";
diff --git a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3.cpp b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3.cpp
index 87a160a85..29ecf9308 100644
--- a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3.cpp
+++ b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3.cpp
@@ -328,6 +328,109 @@ UniformType GraphicsHelperES3::uniformTypeFromGLType(GLenum glType)
     }
 }
 
+uint GraphicsHelperES3::uniformByteSize(const ShaderUniform &description)
+{
+    uint rawByteSize = 0;
+    int arrayStride = qMax(description.m_arrayStride, 0);
+    int matrixStride = qMax(description.m_matrixStride, 0);
+
+    switch (description.m_type) {
+
+    case GL_FLOAT_VEC2:
+    case GL_INT_VEC2:
+    case GL_UNSIGNED_INT_VEC2:
+        rawByteSize = 8;
+        break;
+
+    case GL_FLOAT_VEC3:
+    case GL_INT_VEC3:
+    case GL_UNSIGNED_INT_VEC3:
+        rawByteSize = 12;
+        break;
+
+    case GL_FLOAT_VEC4:
+    case GL_INT_VEC4:
+    case GL_UNSIGNED_INT_VEC4:
+        rawByteSize = 16;
+        break;
+
+    case GL_FLOAT_MAT2:
+        rawByteSize = matrixStride ? 2 * matrixStride : 16;
+        break;
+
+    case GL_FLOAT_MAT2x4:
+        rawByteSize = matrixStride ? 2 * matrixStride : 32;
+        break;
+
+    case GL_FLOAT_MAT4x2:
+        rawByteSize = matrixStride ? 4 * matrixStride : 32;
+        break;
+
+    case GL_FLOAT_MAT3:
+        rawByteSize = matrixStride ? 3 * matrixStride : 36;
+        break;
+
+    case GL_FLOAT_MAT2x3:
+        rawByteSize = matrixStride ? 2 * matrixStride : 24;
+        break;
+
+    case GL_FLOAT_MAT3x2:
+        rawByteSize = matrixStride ? 3 * matrixStride : 24;
+        break;
+
+    case GL_FLOAT_MAT4:
+        rawByteSize = matrixStride ? 4 * matrixStride : 64;
+        break;
+
+    case GL_FLOAT_MAT4x3:
+        rawByteSize = matrixStride ? 4 * matrixStride : 48;
+        break;
+
+    case GL_FLOAT_MAT3x4:
+        rawByteSize = matrixStride ? 3 * matrixStride : 48;
+        break;
+
+    case GL_BOOL:
+        rawByteSize = 1;
+        break;
+
+    case GL_BOOL_VEC2:
+        rawByteSize = 2;
+        break;
+
+    case GL_BOOL_VEC3:
+        rawByteSize = 3;
+        break;
+
+    case GL_BOOL_VEC4:
+        rawByteSize = 4;
+        break;
+
+    case GL_INT:
+    case GL_FLOAT:
+    case GL_UNSIGNED_INT:
+    case GL_SAMPLER_2D:
+    case GL_SAMPLER_3D:
+    case GL_SAMPLER_CUBE:
+    case GL_INT_SAMPLER_2D:
+    case GL_INT_SAMPLER_3D:
+    case GL_INT_SAMPLER_CUBE:
+    case GL_UNSIGNED_INT_SAMPLER_2D:
+    case GL_UNSIGNED_INT_SAMPLER_3D:
+    case GL_UNSIGNED_INT_SAMPLER_CUBE:
+    case GL_SAMPLER_2D_SHADOW:
+    case GL_SAMPLER_CUBE_SHADOW:
+    case GL_SAMPLER_2D_ARRAY:
+    case GL_INT_SAMPLER_2D_ARRAY:
+    case GL_UNSIGNED_INT_SAMPLER_2D_ARRAY:
+    case GL_SAMPLER_2D_ARRAY_SHADOW:
+        rawByteSize = 4;
+        break;
+    }
+
+    return arrayStride ? rawByteSize * arrayStride : rawByteSize;
+}
+
 void GraphicsHelperES3::blitFramebuffer(GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1, GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1, GLbitfield mask, GLenum filter)
 {
     m_extraFuncs->glBlitFramebuffer(srcX0, srcY0, srcX1, srcY1, dstX0, dstY0, dstX1, dstY1, mask, filter);
diff --git a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_1.cpp b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_1.cpp
new file mode 100644
index 000000000..135e83aec
--- /dev/null
+++ b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_1.cpp
@@ -0,0 +1,124 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "graphicshelperes3_1_p.h"
+#include <private/qgraphicsutils_p.h>
+#include <QOpenGLExtraFunctions>
+
+QT_BEGIN_NAMESPACE
+
+// ES 3.1+
+#ifndef GL_SAMPLER_2D_MULTISAMPLE
+#define GL_SAMPLER_2D_MULTISAMPLE         0x9108
+#endif
+#ifndef GL_INT_SAMPLER_2D_MULTISAMPLE
+#define GL_INT_SAMPLER_2D_MULTISAMPLE     0x9109
+#endif
+#ifndef GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE
+#define GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE 0x910A
+#endif
+
+namespace Qt3DRender {
+namespace Render {
+
+GraphicsHelperES3_1::GraphicsHelperES3_1()
+{
+}
+
+GraphicsHelperES3_1::~GraphicsHelperES3_1()
+{
+}
+
+UniformType GraphicsHelperES3_1::uniformTypeFromGLType(GLenum glType)
+{
+    switch (glType) {
+    case GL_SAMPLER_2D_MULTISAMPLE:
+    case GL_INT_SAMPLER_2D_MULTISAMPLE:
+    case GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE:
+        return UniformType::Sampler;
+
+    default:
+       return GraphicsHelperES3::uniformTypeFromGLType(glType);
+    }
+}
+
+uint GraphicsHelperES3_1::uniformByteSize(const ShaderUniform &description)
+{
+    uint rawByteSize = 0;
+
+    switch (description.m_type) {
+    case GL_SAMPLER_2D_MULTISAMPLE:
+    case GL_INT_SAMPLER_2D_MULTISAMPLE:
+    case GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE:
+        rawByteSize = 4;
+        break;
+
+    default:
+        rawByteSize = GraphicsHelperES3::uniformByteSize(description);
+        break;
+    }
+
+    return rawByteSize;
+}
+
+void GraphicsHelperES3_1::buildUniformBuffer(const QVariant &v, const ShaderUniform &description, QByteArray &buffer)
+{
+    char *bufferData = buffer.data();
+
+    switch (description.m_type) {
+    case GL_SAMPLER_2D_MULTISAMPLE:
+    case GL_INT_SAMPLER_2D_MULTISAMPLE:
+    case GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE:
+    {
+        Q_ASSERT(description.m_size == 1);
+        int value = v.toInt();
+        QGraphicsUtils::fillDataArray<GLint>(bufferData, &value, description, 1);
+        break;
+    }
+
+    default:
+        GraphicsHelperES3::buildUniformBuffer(v, description, buffer);
+        break;
+    }
+}
+
+} // namespace Render
+} // namespace Qt3DRender
+
+QT_END_NAMESPACE
diff --git a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_1_p.h b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_1_p.h
new file mode 100644
index 000000000..70a584380
--- /dev/null
+++ b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_1_p.h
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QT3DRENDER_RENDER_GRAPHICSHELPERES3_1_H
+#define QT3DRENDER_RENDER_GRAPHICSHELPERES3_1_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists for the convenience
+// of other Qt classes.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <Qt3DRender/private/graphicshelperes3_p.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+namespace Render {
+
+class GraphicsHelperES3_1 : public GraphicsHelperES3
+{
+public:
+    GraphicsHelperES3_1();
+    ~GraphicsHelperES3_1();
+
+    // QGraphicHelperInterface interface
+    UniformType uniformTypeFromGLType(GLenum glType) override;
+    uint uniformByteSize(const ShaderUniform &description) override;
+    void buildUniformBuffer(const QVariant &v, const ShaderUniform &description, QByteArray &buffer) override;
+};
+
+} // namespace Render
+} // namespace Qt3DRender
+
+QT_END_NAMESPACE
+
+#endif // QT3DRENDER_RENDER_GRAPHICSHELPERES3_1_H
diff --git a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_2_p.h b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_2_p.h
index 018db6481..787bba5f0 100644
--- a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_2_p.h
+++ b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_2_p.h
@@ -51,14 +51,14 @@
 // We mean it.
 //
 
-#include <Qt3DRender/private/graphicshelperes3_p.h>
+#include <Qt3DRender/private/graphicshelperes3_1_p.h>
 
 QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 namespace Render {
 
-class GraphicsHelperES3_2 : public GraphicsHelperES3
+class GraphicsHelperES3_2 : public GraphicsHelperES3_1
 {
 public:
     GraphicsHelperES3_2();
diff --git a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_p.h b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_p.h
index 1df710625..142b7cadd 100644
--- a/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_p.h
+++ b/src/render/renderers/opengl/graphicshelpers/graphicshelperes3_p.h
@@ -87,6 +87,7 @@ public:
     void vertexAttributePointer(GLenum shaderDataType, GLuint index, GLint size, GLenum type, GLboolean normalized, GLsizei stride, const GLvoid *pointer) override;
 
     UniformType uniformTypeFromGLType(GLenum glType) override;
+    uint uniformByteSize(const ShaderUniform &description) override;
 
 protected:
     QOpenGLExtraFunctions *m_extraFuncs = nullptr;
diff --git a/src/render/renderers/opengl/graphicshelpers/graphicshelpers.pri b/src/render/renderers/opengl/graphicshelpers/graphicshelpers.pri
index b3698858a..9b25be0eb 100644
--- a/src/render/renderers/opengl/graphicshelpers/graphicshelpers.pri
+++ b/src/render/renderers/opengl/graphicshelpers/graphicshelpers.pri
@@ -7,6 +7,7 @@ HEADERS += \
     $$PWD/graphicshelperinterface_p.h \
     $$PWD/graphicshelperes2_p.h \
     $$PWD/graphicshelperes3_p.h \
+    $$PWD/graphicshelperes3_1_p.h \
     $$PWD/graphicshelperes3_2_p.h \
     $$PWD/graphicshelpergl2_p.h \
     $$PWD/graphicshelpergl3_3_p.h \
@@ -18,6 +19,7 @@ SOURCES += \
     $$PWD/graphicscontext.cpp \
     $$PWD/graphicshelperes2.cpp \
     $$PWD/graphicshelperes3.cpp \
+    $$PWD/graphicshelperes3_1.cpp \
     $$PWD/graphicshelperes3_2.cpp \
     $$PWD/graphicshelpergl2.cpp \
     $$PWD/graphicshelpergl3_3.cpp \