Add QShaderImage frontend class

Will allow to use GL Image with shaders for read/write operations

Change-Id: Ib08068d982a523bb84d9897c32ece237452f8d2c
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
 

3 files changed, 509 insertions, 1 deletions

diff --git a/tests/auto/render/qshaderimage/qshaderimage.pro b/tests/auto/render/qshaderimage/qshaderimage.pro
new file mode 100644
index 000000000..1990b9732
--- /dev/null
+++ b/tests/auto/render/qshaderimage/qshaderimage.pro
@@ -0,0 +1,12 @@
+TEMPLATE = app
+
+TARGET = tst_qshaderimage
+
+QT += 3dcore 3dcore-private 3drender 3drender-private testlib
+
+CONFIG += testcase
+
+SOURCES += tst_qshaderimage.cpp
+
+include(../../core/common/common.pri)
+include(../commons/commons.pri)
diff --git a/tests/auto/render/qshaderimage/tst_qshaderimage.cpp b/tests/auto/render/qshaderimage/tst_qshaderimage.cpp
new file mode 100644
index 000000000..0a12e806f
--- /dev/null
+++ b/tests/auto/render/qshaderimage/tst_qshaderimage.cpp
@@ -0,0 +1,495 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://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 <QtTest/QTest>
+#include <Qt3DRender/qshaderimage.h>
+#include <Qt3DRender/qtexture.h>
+#include <Qt3DRender/private/qshaderimage_p.h>
+#include <QObject>
+#include <QSignalSpy>
+#include <Qt3DCore/qpropertyupdatedchange.h>
+#include <Qt3DCore/private/qnodecreatedchangegenerator_p.h>
+#include <Qt3DCore/qnodecreatedchange.h>
+#include "testpostmanarbiter.h"
+
+class tst_QShaderImage : public QObject
+{
+    Q_OBJECT
+
+private Q_SLOTS:
+
+    void initTestCase()
+    {
+        qRegisterMetaType<Qt3DRender::QAbstractTexture*>("Qt3DRender::QAbstractTexture*");
+
+    }
+
+    void checkDefaultConstruction()
+    {
+        // GIVEN
+        Qt3DRender::QShaderImage shaderImage;
+
+        // THEN
+        QVERIFY(shaderImage.texture() == nullptr);
+        QCOMPARE(shaderImage.layered(), false);
+        QCOMPARE(shaderImage.mipLevel(), 0);
+        QCOMPARE(shaderImage.layer(), 0);
+        QCOMPARE(shaderImage.access(), Qt3DRender::QShaderImage::ReadWrite);
+        QCOMPARE(shaderImage.format(), Qt3DRender::QShaderImage::Automatic);
+    }
+
+    void checkPropertyChanges()
+    {
+        // GIVEN
+        Qt3DRender::QShaderImage shaderImage;
+
+        {
+            // WHEN
+            QSignalSpy spy(&shaderImage, SIGNAL(textureChanged(Qt3DRender::QAbstractTexture *)));
+            Qt3DRender::QTexture2D newValue;
+            shaderImage.setTexture(&newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.texture(), &newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            shaderImage.setTexture(&newValue);
+
+            // THEN
+            QCOMPARE(shaderImage.texture(), &newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+        {
+            // WHEN
+            QSignalSpy spy(&shaderImage, SIGNAL(layeredChanged(bool)));
+            const bool newValue = true;
+            shaderImage.setLayered(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.layered(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            shaderImage.setLayered(newValue);
+
+            // THEN
+            QCOMPARE(shaderImage.layered(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+        {
+            // WHEN
+            QSignalSpy spy(&shaderImage, SIGNAL(mipLevelChanged(int)));
+            const int newValue = 12;
+            shaderImage.setMipLevel(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.mipLevel(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            shaderImage.setMipLevel(newValue);
+
+            // THEN
+            QCOMPARE(shaderImage.mipLevel(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+        {
+            // WHEN
+            QSignalSpy spy(&shaderImage, SIGNAL(layerChanged(int)));
+            const int newValue = 2;
+            shaderImage.setLayer(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.layer(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            shaderImage.setLayer(newValue);
+
+            // THEN
+            QCOMPARE(shaderImage.layer(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+        {
+            // WHEN
+            QSignalSpy spy(&shaderImage, SIGNAL(accessChanged(Access)));
+            const Qt3DRender::QShaderImage::Access newValue = Qt3DRender::QShaderImage::ReadOnly;
+            shaderImage.setAccess(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.access(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            shaderImage.setAccess(newValue);
+
+            // THEN
+            QCOMPARE(shaderImage.access(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+        {
+            // WHEN
+            QSignalSpy spy(&shaderImage, SIGNAL(formatChanged(ImageFormat)));
+            const Qt3DRender::QShaderImage::ImageFormat newValue = Qt3DRender::QShaderImage::RG8U;
+            shaderImage.setFormat(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.format(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            shaderImage.setFormat(newValue);
+
+            // THEN
+            QCOMPARE(shaderImage.format(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+    }
+
+    void checkCreationData()
+    {
+        // GIVEN
+        Qt3DRender::QShaderImage shaderImage;
+        Qt3DRender::QTexture2D t;
+
+        shaderImage.setTexture(&t);
+        shaderImage.setLayered(true);
+        shaderImage.setMipLevel(883);
+        shaderImage.setLayer(1584);
+        shaderImage.setAccess(Qt3DRender::QShaderImage::WriteOnly);
+        shaderImage.setFormat(Qt3DRender::QShaderImage::R32F);
+
+        // WHEN
+        QVector<Qt3DCore::QNodeCreatedChangeBasePtr> creationChanges;
+
+        {
+            Qt3DCore::QNodeCreatedChangeGenerator creationChangeGenerator(&shaderImage);
+            creationChanges = creationChangeGenerator.creationChanges();
+        }
+
+        // THEN
+        {
+            // ShaderImage + Texture creation
+            QCOMPARE(creationChanges.size(), 2);
+
+            const auto creationChangeData = qSharedPointerCast<Qt3DCore::QNodeCreatedChange<Qt3DRender::QShaderImageData>>(creationChanges.first());
+            const Qt3DRender::QShaderImageData cloneData = creationChangeData->data;
+
+            QCOMPARE(shaderImage.texture()->id(), cloneData.textureId);
+            QCOMPARE(shaderImage.layered(), cloneData.layered);
+            QCOMPARE(shaderImage.mipLevel(), cloneData.mipLevel);
+            QCOMPARE(shaderImage.layer(), cloneData.layer);
+            QCOMPARE(shaderImage.access(), cloneData.access);
+            QCOMPARE(shaderImage.format(), cloneData.format);
+            QCOMPARE(shaderImage.id(), creationChangeData->subjectId());
+            QCOMPARE(shaderImage.isEnabled(), true);
+            QCOMPARE(shaderImage.isEnabled(), creationChangeData->isNodeEnabled());
+            QCOMPARE(shaderImage.metaObject(), creationChangeData->metaObject());
+        }
+
+        // WHEN
+        shaderImage.setEnabled(false);
+
+        {
+            Qt3DCore::QNodeCreatedChangeGenerator creationChangeGenerator(&shaderImage);
+            creationChanges = creationChangeGenerator.creationChanges();
+        }
+
+        // THEN
+        {
+            // ShaderImage + Texture creation
+            QCOMPARE(creationChanges.size(), 2);
+
+            const auto creationChangeData = qSharedPointerCast<Qt3DCore::QNodeCreatedChange<Qt3DRender::QShaderImageData>>(creationChanges.first());
+            const Qt3DRender::QShaderImageData cloneData = creationChangeData->data;
+
+            QCOMPARE(shaderImage.texture()->id(), cloneData.textureId);
+            QCOMPARE(shaderImage.layered(), cloneData.layered);
+            QCOMPARE(shaderImage.mipLevel(), cloneData.mipLevel);
+            QCOMPARE(shaderImage.layer(), cloneData.layer);
+            QCOMPARE(shaderImage.access(), cloneData.access);
+            QCOMPARE(shaderImage.format(), cloneData.format);
+            QCOMPARE(shaderImage.id(), creationChangeData->subjectId());
+            QCOMPARE(shaderImage.isEnabled(), false);
+            QCOMPARE(shaderImage.isEnabled(), creationChangeData->isNodeEnabled());
+            QCOMPARE(shaderImage.metaObject(), creationChangeData->metaObject());
+        }
+    }
+
+    void checkTextureUpdate()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        Qt3DRender::QShaderImage shaderImage;
+        arbiter.setArbiterOnNode(&shaderImage);
+        Qt3DRender::QTexture2D t;
+
+        {
+            // WHEN
+            shaderImage.setTexture(&t);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "texture");
+            QCOMPARE(change->value().value<Qt3DCore::QNodeId>(), shaderImage.texture()->id());
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+
+            arbiter.events.clear();
+        }
+
+        {
+            // WHEN
+            shaderImage.setTexture(&t);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+    }
+
+    void checkLayeredUpdate()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        Qt3DRender::QShaderImage shaderImage;
+        arbiter.setArbiterOnNode(&shaderImage);
+
+        {
+            // WHEN
+            shaderImage.setLayered(true);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "layered");
+            QCOMPARE(change->value().value<bool>(), shaderImage.layered());
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+
+            arbiter.events.clear();
+        }
+
+        {
+            // WHEN
+            shaderImage.setLayered(true);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+    }
+
+    void checkMipLevelUpdate()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        Qt3DRender::QShaderImage shaderImage;
+        arbiter.setArbiterOnNode(&shaderImage);
+
+        {
+            // WHEN
+            shaderImage.setMipLevel(5);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "mipLevel");
+            QCOMPARE(change->value().value<int>(), shaderImage.mipLevel());
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+
+            arbiter.events.clear();
+        }
+
+        {
+            // WHEN
+            shaderImage.setMipLevel(5);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+    }
+
+    void checkLayerUpdate()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        Qt3DRender::QShaderImage shaderImage;
+        arbiter.setArbiterOnNode(&shaderImage);
+
+        {
+            // WHEN
+            shaderImage.setLayer(8);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "layer");
+            QCOMPARE(change->value().value<int>(), shaderImage.layer());
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+
+            arbiter.events.clear();
+        }
+
+        {
+            // WHEN
+            shaderImage.setLayer(8);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+    }
+
+    void checkAccessUpdate()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        Qt3DRender::QShaderImage shaderImage;
+        arbiter.setArbiterOnNode(&shaderImage);
+
+        {
+            // WHEN
+            shaderImage.setAccess(Qt3DRender::QShaderImage::WriteOnly);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "access");
+            QCOMPARE(change->value().value<Qt3DRender::QShaderImage::Access>(), shaderImage.access());
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+
+            arbiter.events.clear();
+        }
+
+        {
+            // WHEN
+            shaderImage.setAccess(Qt3DRender::QShaderImage::WriteOnly);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+    }
+
+    void checkFormatUpdate()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        Qt3DRender::QShaderImage shaderImage;
+        arbiter.setArbiterOnNode(&shaderImage);
+
+        {
+            // WHEN
+            shaderImage.setFormat(Qt3DRender::QShaderImage::RG16F);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "format");
+            QCOMPARE(change->value().value<Qt3DRender::QShaderImage::ImageFormat>(), shaderImage.format());
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+
+            arbiter.events.clear();
+        }
+
+        {
+            // WHEN
+            shaderImage.setFormat(Qt3DRender::QShaderImage::RG16F);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+    }
+
+    void checkTextureBookeeping()
+    {
+        // GIVEN
+        Qt3DRender::QShaderImage shaderImage;
+        QSignalSpy spy(&shaderImage, SIGNAL(textureChanged(Qt3DRender::QAbstractTexture *)));
+
+        {
+            // WHEN
+            Qt3DRender::QTexture2D tex;
+            shaderImage.setTexture(&tex);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(shaderImage.texture(), &tex);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+        }
+        // THEN
+        QCOMPARE(spy.count(), 1);
+        QVERIFY(shaderImage.texture() == nullptr);
+    }
+
+};
+
+QTEST_MAIN(tst_QShaderImage)
+
+#include "tst_qshaderimage.moc"
diff --git a/tests/auto/render/render.pro b/tests/auto/render/render.pro
index ac1ef50dd..8c5c43483 100644
--- a/tests/auto/render/render.pro
+++ b/tests/auto/render/render.pro
@@ -103,7 +103,8 @@ qtConfig(private_tests) {
         qwaitfence \
         setfence \
         waitfence \
-        qtexturedataupdate
+        qtexturedataupdate \
+        qshaderimage
 
     QT_FOR_CONFIG = 3dcore-private
     # TO DO: These could be restored to be executed in all cases