1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QPLATFORMSHAREDGRAPHICSCACHE_H
41 #define QPLATFORMSHAREDGRAPHICSCACHE_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is part of the QPA API and is not meant to be used
48 // in applications. Usage of this API may make your code
49 // source and binary incompatible with future versions of Qt.
50 //
51 
52 #include <QtGui/qtguiglobal.h>
53 #include <QtCore/qobject.h>
54 #include <QtGui/qimage.h>
55 
56 QT_BEGIN_NAMESPACE
57 
58 class Q_GUI_EXPORT QPlatformSharedGraphicsCache: public QObject
59 {
60     Q_OBJECT
61 public:
62     enum PixelFormat
63     {
64         Alpha8
65     };
66 
67     enum BufferType
68     {
69         OpenGLTexture
70     };
71 
QObject(parent)72     explicit QPlatformSharedGraphicsCache(QObject *parent = nullptr) : QObject(parent) {}
73 
74     virtual void beginRequestBatch() = 0;
75     virtual void ensureCacheInitialized(const QByteArray &cacheId, BufferType bufferType,
76                                                     PixelFormat pixelFormat) = 0;
77     virtual void requestItems(const QByteArray &cacheId, const QVector<quint32> &itemIds) = 0;
78     virtual void insertItems(const QByteArray &cacheId,
79                                          const QVector<quint32> &itemIds,
80                                          const QVector<QImage> &items) = 0;
81     virtual void releaseItems(const QByteArray &cacheId, const QVector<quint32> &itemIds) = 0;
82     virtual void endRequestBatch() = 0;
83 
84     virtual bool requestBatchStarted() const = 0;
85 
86     virtual uint textureIdForBuffer(void *bufferId) = 0;
87     virtual void referenceBuffer(void *bufferId) = 0;
88     virtual bool dereferenceBuffer(void *bufferId) = 0;
89     virtual QSize sizeOfBuffer(void *bufferId) = 0;
90     virtual void *eglImageForBuffer(void *bufferId) = 0;
91 
92 Q_SIGNALS:
93     void itemsMissing(const QByteArray &cacheId, const QVector<quint32> &itemIds);
94     void itemsAvailable(const QByteArray &cacheId, void *bufferId,
95                         const QVector<quint32> &itemIds, const QVector<QPoint> &positionsInBuffer);
96     void itemsInvalidated(const QByteArray &cacheId, const QVector<quint32> &itemIds);
97     void itemsUpdated(const QByteArray &cacheId, void *bufferId,
98                       const QVector<quint32> &itemIds, const QVector<QPoint> &positionsInBuffer);
99 };
100 
101 QT_END_NAMESPACE
102 
103 #endif // QPLATFORMSHAREDGRAPHICSCACHE_H
104