1/****************************************************************************
2**
3** Copyright (C) 2019 The Qt Company Ltd.
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: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#include <QtQml/qqmlextensionplugin.h>
41#include <QtQml/qqmlengine.h>
42
43#include "QtWaylandCompositor/private/qwltexturesharingextension_p.h"
44
45/*!
46 \qmlmodule QtWayland.Compositor.TextureSharingExtension 1
47 \title Qt Wayland Shared Texture Provider
48 \ingroup qmlmodules
49 \brief Adds a mechanism to share GPU memory
50
51 \section2 Summary
52
53 This module lets the compositor export graphical resources that can be used by clients,
54 without allocating any graphics memory in the client.
55
56 \section2 Usage
57
58 This module is imported like this:
59
60 \code
61 import QtWayland.Compositor.TextureSharingExtension 1.0
62 \endcode
63
64 To use this module in a compositor, instantiate the extension object as a child of the compositor object, like this:
65
66
67 \code
68 WaylandCompositor {
69 //...
70 TextureSharingExtension {
71 }
72 }
73 \endcode
74
75 The sharing functionality is provided through a QQuickImageProvider. Use
76 the "image:" scheme for the URL source of the image, followed by the
77 identifier \e wlshared, followed by the image file path. For example:
78
79 \code
80 Image { source: "image://wlshared/wallpapers/mybackground.jpg" }
81 \endcode
82
83*/
84
85QT_BEGIN_NAMESPACE
86
87class QWaylandTextureSharingExtensionPlugin : public QQmlExtensionPlugin
88{
89 Q_OBJECT
90 Q_PLUGIN_METADATA(IID QQmlExtensionInterface_iid)
91public:
92 QWaylandTextureSharingExtensionPlugin(QObject *parent = nullptr) : QQmlExtensionPlugin(parent) {}
93
94 void registerTypes(const char *uri) override
95 {
96 Q_ASSERT(uri == QStringLiteral("QtWayland.Compositor.TextureSharingExtension"));
97 qmlRegisterType<QWaylandTextureSharingExtensionQuickExtension>(uri: "QtWayland.Compositor.TextureSharingExtension", versionMajor: 1, versionMinor: 0, qmlName: "TextureSharingExtension");
98 }
99
100 void initializeEngine(QQmlEngine *engine, const char *uri) override
101 {
102 Q_UNUSED(uri);
103 engine->addImageProvider("wlshared", new QWaylandSharedTextureProvider);
104 }
105};
106
107QT_END_NAMESPACE
108
109#include "plugin.moc"
110

source code of qtwayland/src/imports/texture-sharing-extension/plugin.cpp