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 QPLATFORMGRAPHICSBUFFER_H
41#define QPLATFORMGRAPHICSBUFFER_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
53#include <QtGui/qtguiglobal.h>
54#include <QtCore/QSize>
55#include <QtCore/QRect>
56#include <QtGui/QPixelFormat>
57#include <QtCore/qflags.h>
58#include <QtCore/QObject>
59
60QT_BEGIN_NAMESPACE
61
62class Q_GUI_EXPORT QPlatformGraphicsBuffer : public QObject
63{
64Q_OBJECT
65public:
66 enum AccessType
67 {
68 None = 0x00,
69 SWReadAccess = 0x01,
70 SWWriteAccess = 0x02,
71 TextureAccess = 0x04,
72 HWCompositor = 0x08
73 };
74 Q_ENUM(AccessType);
75 Q_DECLARE_FLAGS(AccessTypes, AccessType);
76
77 enum Origin {
78 OriginBottomLeft,
79 OriginTopLeft
80 };
81 Q_ENUM(Origin);
82
83 ~QPlatformGraphicsBuffer();
84
85 AccessTypes isLocked() const { return m_lock_access; }
86 bool lock(AccessTypes access, const QRect &rect = QRect());
87 void unlock();
88
89 virtual bool bindToTexture(const QRect &rect = QRect()) const;
90
91 virtual const uchar *data() const;
92 virtual uchar *data();
93 virtual int bytesPerLine() const;
94 int byteCount() const;
95
96 virtual Origin origin() const;
97
98 QSize size() const { return m_size; }
99 QPixelFormat format() const { return m_format; }
100
101Q_SIGNALS:
102 void unlocked(AccessTypes previousAccessTypes);
103
104protected:
105 QPlatformGraphicsBuffer(const QSize &size, const QPixelFormat &format);
106
107 virtual bool doLock(AccessTypes access, const QRect &rect = QRect()) = 0;
108 virtual void doUnlock() = 0;
109
110private:
111 QSize m_size;
112 QPixelFormat m_format;
113 AccessTypes m_lock_access;
114};
115
116QT_END_NAMESPACE
117
118#endif //QPLATFORMGRAPHICSBUFFER_H
119