1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtwaylandcompositor-index.html
\title Qt Wayland Compositor
\brief An API to develop display servers that support the Wayland protocol.
The Qt Wayland Compositor is a module that provides convenient and powerful
QML and C++ APIs for developing custom display servers based on the
\l {https://wayland.freedesktop.org/}{Wayland} protocol. The display server,
often called a compositor, displays content from client applications that
support the Wayland protocol.
Wayland's design philosophy is to keep the core protocol simple and minimal.
Developers can then expand on this core protocol with use-case-specific
extensions. Qt Wayland Compositor supports many common extensions by default,
and also has APIs to enable the creation of new, custom extensions.
Typically, a compositor written with Qt Wayland Compositor becomes a
subsystem inside a larger application manager process. Qt Wayland Compositor
provides the APIs to communicate with clients and display their content on
the screen. The QML APIs contain high-level APIs that easily integrate with
the rest of Qt, enabling convenient animations, effects, and UI through
Qt Quick. There are also C++ APIs available - if you need more low-level
access.
An application manager would typically implement additional features such as
application life cycle, virtual keyboard input, security, and Inter-Process
Communication (IPC). Qt provides the APIs that can be used to develop the
remaining parts of an application manager in other modules. The
\l {https://www.qt.io/qt-automotive-suite/}{Qt Automotive Suite} provides
\l{Qt Application Manager}, which is a complete application manager that
includes a compositor developed using Qt Wayland Compositor.
For more information on Wayland, see \l{Wayland and Qt}.
\section1 Features of Qt Wayland Compositor
The Qt Wayland Compositor includes features necessary to create a compositor:
\list
\li A QML API to display and manipulate client content, fully integrated
with all the features in Qt Quick.
\li A C++ API for low-level access and control.
\li Support for common extensions, including XDG Shell and IVI Application.
\li APIs to easily expand the support for custom extensions.
\endlist
\section1 Environment Variables and Command-line Arguments
The Qt Wayland Compositor recognizes the following environment variables and
command-line arguments:
\list
\li Environment variables:
\list
\li \b QT_WAYLAND_HARDWARE_INTEGRATION Selects the hardware integration
plugin to use.
\li \b QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects the client buffer
integration plugin to use.
\li \b QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects the server
integration plugin to use.
\endlist
\li Command-line arguments:
\list
\li \c{--wayland-socket-name} Overrides the default socket name used for
communicating with clients.
\endlist
\endlist
\section1 Examples
Take a look at the \l{Qt Wayland Compositor Examples} to learn how these APIs
can be used to write custom compositors.
\section1 API Reference
The Qt Wayland Compositor can be used from C++ or QML:
\list
\li \l{Qt Wayland Compositor QML Types}
\li \l{Qt Wayland Compositor C++ Classes}
\endlist
\section1 Licenses and Attributions
Qt Wayland Compositor and the Qt Wayland integration plugin
are available under commercial licenses from \l{The Qt Company}.
In addition, they are available under the
\l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
Qt Wayland Compositor and the Qt Wayland integration plugin
use protocol definitions under following permissive licenses:
\generatelist{groupsbymodule attributions-qtwaylandcompositor}
*/
|
