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 QtWaylandClient 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 "sharedtextureprovider.h"
44
45/*!
46 \qmlmodule QtWayland.Client.TextureSharing 1
47 \title Qt Wayland Shared Texture Provider
48 \ingroup qmlmodules
49 \brief Adds an image provider which utilizes shared GPU memory
50
51 \section2 Summary
52
53 This module allows Qt Wayland clients to use graphical resources exported
54 by the compositor, without allocating any graphics memory in the client.
55 \section2 Usage
56
57 To use this module, import it like this:
58 \code
59 import QtWayland.Client.TextureSharing 1.0
60 \endcode
61
62 The sharing functionality is provided through a QQuickImageProvider. Use
63 the "image:" scheme for the URL source of the image, followed by the
64 identifier \e wlshared, followed by the image file path. For example:
65
66 \code
67 Image { source: "image://wlshared/wallpapers/mybackground.jpg" }
68 \endcode
69
70 The shared texture module does not provide any directly usable QML types.
71*/
72
73QT_BEGIN_NAMESPACE
74
75class QWaylandTextureSharingPlugin : public QQmlExtensionPlugin
76{
77 Q_OBJECT
78 Q_PLUGIN_METADATA(IID QQmlExtensionInterface_iid)
79public:
80 QWaylandTextureSharingPlugin(QObject *parent = nullptr) : QQmlExtensionPlugin(parent) {}
81
82 void registerTypes(const char *uri) override
83 {
84 Q_ASSERT(uri == QStringLiteral("QtWayland.Client.TextureSharing"));
85 qmlRegisterModule(uri, versionMajor: 1, versionMinor: 0);
86 }
87
88 void initializeEngine(QQmlEngine *engine, const char *uri) override
89 {
90 Q_UNUSED(uri);
91 engine->addImageProvider(id: "wlshared", new SharedTextureProvider);
92 }
93};
94
95QT_END_NAMESPACE
96
97#include "plugin.moc"
98

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