Add QSGSpriteNode to the Scenegraph Adaptation Layer

Most core Qt Quick items use one of the nodes provided by the Scenegraph
Adaptation Layer, however the two items that provide support for Sprites
created their own custom nodes.  There was significant redundancy in
this, and it made it only possible to use the OpenGL adaptation.  The
AnimatedSprite and SpriteSequence items have been cleaned up, and now
use the new QSGSpriteNode.

Change-Id: Idc20b9c5da9dc1c94f6368021785382cdf7cec5a
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>

11 files changed, 287 insertions, 3 deletions

diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext.cpp b/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext.cpp
index d9a298f855..94e9c81f70 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext.cpp
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext.cpp
@@ -47,6 +47,7 @@
 #include "qsgsoftwarepublicnodes_p.h"
 #include "qsgsoftwarelayer_p.h"
 #include "qsgsoftwarerenderer_p.h"
+#include "qsgsoftwarespritenode_p.h"
 
 #include <QtCore/QCoreApplication>
 #include <QtCore/QElapsedTimer>
@@ -154,6 +155,11 @@ void QSGSoftwareRenderContext::renderNextFrame(QSGRenderer *renderer, uint fbo)
     renderer->renderScene(fbo);
 }
 
+int QSGSoftwareRenderContext::maxTextureSize() const
+{
+    return 2048;
+}
+
 QSGRendererInterface *QSGSoftwareContext::rendererInterface(QSGRenderContext *renderContext)
 {
     Q_UNUSED(renderContext);
@@ -175,6 +181,11 @@ QSGNinePatchNode *QSGSoftwareContext::createNinePatchNode()
     return new QSGSoftwareNinePatchNode;
 }
 
+QSGSpriteNode *QSGSoftwareContext::createSpriteNode()
+{
+    return new QSGSoftwareSpriteNode;
+}
+
 QSGRendererInterface::GraphicsApi QSGSoftwareContext::graphicsApi() const
 {
     return Software;
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext_p.h b/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext_p.h
index 9a939a0948..3c3686c268 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext_p.h
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarecontext_p.h
@@ -75,6 +75,7 @@ public:
     void renderNextFrame(QSGRenderer *renderer, uint fbo) override;
     QSGTexture *createTexture(const QImage &image, uint flags = CreateTexture_Alpha) const override;
     QSGRenderer *createRenderer() override;
+    int maxTextureSize() const override;
 
     bool m_initialized;
 };
@@ -96,6 +97,7 @@ public:
     QSGRectangleNode *createRectangleNode() override;
     QSGImageNode *createImageNode() override;
     QSGNinePatchNode *createNinePatchNode() override;
+    QSGSpriteNode *createSpriteNode() override;
 
     GraphicsApi graphicsApi() const override;
     ShaderType shaderType() const override;
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode.cpp b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode.cpp
index 385b257e44..1b2a836dfa 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode.cpp
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode.cpp
@@ -45,6 +45,7 @@
 #include "qsgsoftwarepublicnodes_p.h"
 #include "qsgsoftwarepainternode_p.h"
 #include "qsgsoftwarepixmaptexture_p.h"
+#include "qsgsoftwarespritenode_p.h"
 
 #include <QtQuick/QSGSimpleRectNode>
 #include <QtQuick/qsgsimpletexturenode.h>
@@ -89,6 +90,9 @@ QSGSoftwareRenderableNode::QSGSoftwareRenderableNode(NodeType type, QSGNode *nod
     case QSGSoftwareRenderableNode::SimpleImage:
         m_handle.simpleImageNode = static_cast<QSGImageNode*>(node);
         break;
+    case QSGSoftwareRenderableNode::SpriteNode:
+        m_handle.spriteNode = static_cast<QSGSoftwareSpriteNode*>(node);
+        break;
     case QSGSoftwareRenderableNode::Invalid:
         m_handle.simpleRectNode = nullptr;
         break;
@@ -174,6 +178,10 @@ void QSGSoftwareRenderableNode::update()
 
         boundingRect = m_handle.simpleImageNode->rect().toRect();
         break;
+    case QSGSoftwareRenderableNode::SpriteNode:
+        m_isOpaque = m_handle.spriteNode->isOpaque();
+        boundingRect = m_handle.spriteNode->rect().toRect();
+        break;
     default:
         break;
     }
@@ -256,6 +264,9 @@ QRegion QSGSoftwareRenderableNode::renderNode(QPainter *painter, bool forceOpaqu
     case QSGSoftwareRenderableNode::SimpleImage:
         static_cast<QSGSoftwareImageNode *>(m_handle.simpleImageNode)->paint(painter);
         break;
+    case QSGSoftwareRenderableNode::SpriteNode:
+        static_cast<QSGSoftwareSpriteNode *>(m_handle.spriteNode)->paint(painter);
+        break;
     default:
         break;
     }
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode_p.h b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode_p.h
index fcbea7391a..dc224be2c0 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode_p.h
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenode_p.h
@@ -67,6 +67,7 @@ class QSGSoftwarePainterNode;
 class QSGSoftwareInternalRectangleNode;
 class QSGSoftwareGlyphNode;
 class QSGSoftwareNinePatchNode;
+class QSGSoftwareSpriteNode;
 
 class QSGSoftwareRenderableNode
 {
@@ -81,7 +82,8 @@ public:
         Glyph,
         NinePatch,
         SimpleRectangle,
-        SimpleImage
+        SimpleImage,
+        SpriteNode
     };
 
     QSGSoftwareRenderableNode(NodeType type, QSGNode *node);
@@ -123,6 +125,7 @@ private:
         QSGSoftwareNinePatchNode *ninePatchNode;
         QSGRectangleNode *simpleRectangleNode;
         QSGImageNode *simpleImageNode;
+        QSGSoftwareSpriteNode *spriteNode;
     };
 
     const NodeType m_nodeType;
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater.cpp b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater.cpp
index f13edb87fb..cb866bec12 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater.cpp
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater.cpp
@@ -180,6 +180,16 @@ void QSGSoftwareRenderableNodeUpdater::endVisit(QSGRootNode *)
 {
 }
 
+bool QSGSoftwareRenderableNodeUpdater::visit(QSGSpriteNode *node)
+{
+    return updateRenderableNode(QSGSoftwareRenderableNode::SpriteNode, node);
+}
+
+void QSGSoftwareRenderableNodeUpdater::endVisit(QSGSpriteNode *)
+{
+
+}
+
 void QSGSoftwareRenderableNodeUpdater::updateNodes(QSGNode *node, bool isNodeRemoved)
 {
     m_opacityState.clear();
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater_p.h b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater_p.h
index d7c12e8b02..5bc241cce1 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater_p.h
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderablenodeupdater_p.h
@@ -86,6 +86,8 @@ public:
     void endVisit(QSGGlyphNode *) override;
     bool visit(QSGRootNode *) override;
     void endVisit(QSGRootNode *) override;
+    bool visit(QSGSpriteNode *) override;
+    void endVisit(QSGSpriteNode *) override;
 
     void updateNodes(QSGNode *node, bool isNodeRemoved = false);
 
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder.cpp b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder.cpp
index ede2005918..ac00127b35 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder.cpp
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder.cpp
@@ -140,6 +140,16 @@ void QSGSoftwareRenderListBuilder::endVisit(QSGRootNode *)
 {
 }
 
+bool QSGSoftwareRenderListBuilder::visit(QSGSpriteNode *node)
+{
+    return addRenderableNode(node);
+}
+
+void QSGSoftwareRenderListBuilder::endVisit(QSGSpriteNode *)
+{
+
+}
+
 bool QSGSoftwareRenderListBuilder::addRenderableNode(QSGNode *node)
 {
     auto renderableNode = m_renderer->renderableNode(node);
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder_p.h b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder_p.h
index ce538f835f..e34cc81e23 100644
--- a/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder_p.h
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarerenderlistbuilder_p.h
@@ -80,6 +80,8 @@ public:
     void endVisit(QSGGlyphNode *) override;
     bool visit(QSGRootNode *) override;
     void endVisit(QSGRootNode *) override;
+    bool visit(QSGSpriteNode *) override;
+    void endVisit(QSGSpriteNode *) override;
 
 private:
     bool addRenderableNode(QSGNode *node);
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarespritenode.cpp b/src/quick/scenegraph/adaptations/software/qsgsoftwarespritenode.cpp
new file mode 100644
index 0000000000..ba7bbc2d11
--- /dev/null
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarespritenode.cpp
@@ -0,0 +1,139 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtQuick 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 "qsgsoftwarespritenode_p.h"
+#include "qsgsoftwarepixmaptexture_p.h"
+#include <QtGui/QPainter>
+
+QT_BEGIN_NAMESPACE
+
+QSGSoftwareSpriteNode::QSGSoftwareSpriteNode()
+{
+    setMaterial((QSGMaterial*)1);
+    setGeometry((QSGGeometry*)1);
+}
+
+void QSGSoftwareSpriteNode::setTexture(QSGTexture *texture)
+{
+    m_texture = qobject_cast<QSGSoftwarePixmapTexture*>(texture);
+    markDirty(DirtyMaterial);
+}
+
+void QSGSoftwareSpriteNode::setTime(float time)
+{
+    if (m_time != time) {
+        m_time = time;
+        markDirty(DirtyMaterial);
+    }
+}
+
+void QSGSoftwareSpriteNode::setSourceA(const QPoint &source)
+{
+    if (m_sourceA != source) {
+        m_sourceA = source;
+        markDirty(DirtyMaterial);
+    }
+}
+
+void QSGSoftwareSpriteNode::setSourceB(const QPoint &source)
+{
+    if (m_sourceB != source) {
+        m_sourceB = source;
+        markDirty(DirtyMaterial);
+    }
+}
+
+void QSGSoftwareSpriteNode::setSpriteSize(const QSize &size)
+{
+    if (m_spriteSize != size) {
+        m_spriteSize = size;
+        markDirty(DirtyMaterial);
+    }
+}
+
+void QSGSoftwareSpriteNode::setSheetSize(const QSize &size)
+{
+    if (m_sheetSize != size) {
+        m_sheetSize = size;
+        markDirty(DirtyMaterial);
+    }
+}
+
+void QSGSoftwareSpriteNode::setSize(const QSizeF &size)
+{
+    if (m_size != size) {
+        m_size = size;
+        markDirty(DirtyGeometry);
+    }
+}
+
+void QSGSoftwareSpriteNode::setFiltering(QSGTexture::Filtering filtering)
+{
+    Q_UNUSED(filtering);
+}
+
+void QSGSoftwareSpriteNode::update()
+{
+}
+
+void QSGSoftwareSpriteNode::paint(QPainter *painter)
+{
+    //Get the pixmap handle from the texture
+    if (!m_texture)
+        return;
+
+    const QPixmap &pixmap = m_texture->pixmap();
+
+    // XXX try to do some kind of interpolation between sourceA and sourceB using time
+    painter->drawPixmap(QRectF(0, 0, m_size.width(), m_size.height()),
+                        pixmap,
+                        QRectF(m_sourceA, m_spriteSize));
+}
+
+bool QSGSoftwareSpriteNode::isOpaque() const
+{
+    return false;
+}
+
+QRectF QSGSoftwareSpriteNode::rect() const
+{
+    return QRectF(0, 0, m_size.width(), m_size.height());
+}
+
+QT_END_NAMESPACE
diff --git a/src/quick/scenegraph/adaptations/software/qsgsoftwarespritenode_p.h b/src/quick/scenegraph/adaptations/software/qsgsoftwarespritenode_p.h
new file mode 100644
index 0000000000..284ed3dff5
--- /dev/null
+++ b/src/quick/scenegraph/adaptations/software/qsgsoftwarespritenode_p.h
@@ -0,0 +1,92 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtQuick 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 QSGSOFTWARESPRITENODE_H
+#define QSGSOFTWARESPRITENODE_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <private/qsgadaptationlayer_p.h>
+
+QT_BEGIN_NAMESPACE
+
+class QSGSoftwarePixmapTexture;
+class QSGSoftwareSpriteNode : public QSGSpriteNode
+{
+public:
+    QSGSoftwareSpriteNode();
+
+    void setTexture(QSGTexture *texture) override;
+    void setTime(float time) override;
+    void setSourceA(const QPoint &source) override;
+    void setSourceB(const QPoint &source) override;
+    void setSpriteSize(const QSize &size) override;
+    void setSheetSize(const QSize &size) override;
+    void setSize(const QSizeF &size) override;
+    void setFiltering(QSGTexture::Filtering filtering) override;
+    void update() override;
+
+    void paint(QPainter *painter);
+    bool isOpaque() const;
+    QRectF rect() const;
+
+private:
+
+    QSGSoftwarePixmapTexture *m_texture;
+    float m_time;
+    QPoint m_sourceA;
+    QPoint m_sourceB;
+    QSize m_spriteSize;
+    QSize m_sheetSize;
+    QSizeF m_size;
+
+};
+
+QT_END_NAMESPACE
+
+#endif // QSGSOFTWARESPRITENODE_H
diff --git a/src/quick/scenegraph/adaptations/software/software.pri b/src/quick/scenegraph/adaptations/software/software.pri
index a8ba77c147..1933a37d48 100644
--- a/src/quick/scenegraph/adaptations/software/software.pri
+++ b/src/quick/scenegraph/adaptations/software/software.pri
@@ -18,7 +18,8 @@ SOURCES += \
     $$PWD/qsgsoftwarerenderlistbuilder.cpp \
     $$PWD/qsgsoftwarerenderloop.cpp \
     $$PWD/qsgsoftwarelayer.cpp \
-    $$PWD/qsgsoftwareadaptation.cpp
+    $$PWD/qsgsoftwareadaptation.cpp \
+    $$PWD/qsgsoftwarespritenode.cpp
 
 HEADERS += \
     $$PWD/qsgsoftwarecontext_p.h \
@@ -36,4 +37,5 @@ HEADERS += \
     $$PWD/qsgsoftwarerenderlistbuilder_p.h \
     $$PWD/qsgsoftwarerenderloop_p.h \
     $$PWD/qsgsoftwarelayer_p.h \
-    $$PWD/qsgsoftwareadaptation_p.h
+    $$PWD/qsgsoftwareadaptation_p.h \
+    $$PWD/qsgsoftwarespritenode_p.h