1/****************************************************************************
2**
3** Copyright (C) 2017 Jolla Ltd, author: <giulio.camuffo@jollamobile.com>
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWaylandCompositor module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL$
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 General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 or (at your option) any later version
20** approved by the KDE Free Qt Foundation. The licenses are as published by
21** the Free Software Foundation and appearing in the file LICENSE.GPL3
22** included in the packaging of this file. Please review the following
23** information to ensure the GNU General Public License requirements will
24** be met: https://www.gnu.org/licenses/gpl-3.0.html.
25**
26** $QT_END_LICENSE$
27**
28****************************************************************************/
29
30#ifndef QWAYLANDSURFACEVIEW_H
31#define QWAYLANDSURFACEVIEW_H
32
33#include <QtWaylandCompositor/QWaylandBufferRef>
34#include <QtWaylandCompositor/qtwaylandcompositorglobal.h>
35
36#include <QtCore/QPointF>
37#include <QtCore/QObject>
38
39QT_BEGIN_NAMESPACE
40
41class QWaylandSurface;
42class QWaylandViewPrivate;
43class QWaylandOutput;
44
45class Q_WAYLAND_COMPOSITOR_EXPORT QWaylandView : public QObject
46{
47 Q_OBJECT
48 Q_DECLARE_PRIVATE(QWaylandView)
49 Q_PROPERTY(QObject *renderObject READ renderObject CONSTANT)
50 Q_PROPERTY(QWaylandSurface *surface READ surface WRITE setSurface NOTIFY surfaceChanged)
51 Q_PROPERTY(QWaylandOutput *output READ output WRITE setOutput NOTIFY outputChanged)
52 Q_PROPERTY(bool bufferLocked READ isBufferLocked WRITE setBufferLocked NOTIFY bufferLockedChanged)
53 Q_PROPERTY(bool allowDiscardFrontBuffer READ allowDiscardFrontBuffer WRITE setAllowDiscardFrontBuffer NOTIFY allowDiscardFrontBufferChanged)
54public:
55 QWaylandView(QObject *renderObject = nullptr, QObject *parent = nullptr);
56 ~QWaylandView() override;
57
58 QObject *renderObject() const;
59
60 QWaylandSurface *surface() const;
61 void setSurface(QWaylandSurface *surface);
62
63 QWaylandOutput *output() const;
64 void setOutput(QWaylandOutput *output);
65
66 virtual void bufferCommitted(const QWaylandBufferRef &buffer, const QRegion &damage);
67 virtual bool advance();
68 virtual void discardCurrentBuffer();
69 virtual QWaylandBufferRef currentBuffer();
70 virtual QRegion currentDamage();
71
72 bool isBufferLocked() const;
73 void setBufferLocked(bool locked);
74
75 bool allowDiscardFrontBuffer() const;
76 void setAllowDiscardFrontBuffer(bool discard);
77
78 void setPrimary();
79 bool isPrimary() const;
80
81 struct wl_resource *surfaceResource() const;
82
83Q_SIGNALS:
84 void surfaceChanged();
85 void surfaceDestroyed();
86 void outputChanged();
87 void bufferLockedChanged();
88 void allowDiscardFrontBufferChanged();
89};
90
91QT_END_NAMESPACE
92
93#endif
94

source code of qtwayland/src/compositor/compositor_api/qwaylandview.h