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 documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
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 Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file. Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29    \class QEglFSFunctions
30    \inmodule QtPlatformHeaders
31
32    \brief The QEglFSFunctions class is an inline class containing
33    platform-specific functionality for the eglfs platform plugin that is
34    typically used on systems running Embedded Linux or Android.
35
36    \note There is no binary compatibility guarantee for this class,
37    meaning that an application using it is only guaranteed to work with the Qt
38    version it was developed against.
39*/
40
41/*!
42    \typedef QEglFSFunctions::LoadKeymapType
43
44    Function type for loadKeymap.
45*/
46
47/*!
48    \fn QByteArray QEglFSFunctions::loadKeymapTypeIdentifier()
49
50    \return the identifier that can be passed to
51    QGuiApplication::platformFunction() to query the entry point for the
52    loadKeymap function implementation.
53*/
54
55/*!
56    \fn void QEglFSFunctions::loadKeymap(const QString &filename)
57
58    Loads and switches to the keymap from \a filename. When \a filename is
59    empty, the default keymap, which is either the built-on one or the keymap
60    given in the plugin specification, is restored.
61
62    \note This is functional only when the evdev keyboard support code is
63    compiled in to the platform plugin. When using external generic plugins via
64    the \c{-plugin} argument, or when the environment variable
65    \c{QT_QPA_EGLFS_DISABLE_INPUT} is set or when building Qt without evdev
66    support, this function will have no effect.
67*/
68
69/*!
70    \fn void QEglFSFunctions::switchLang()
71
72    Switches between English and other language when the keymap is loaded.
73    Usually the keymap contains two languages: English and national. When
74    you load the keymap, English is selected by default. This function allows
75    to switch between these languages.
76
77    \note This is functional only when the evdev keyboard support code is
78    compiled in to the platform plugin. When using external generic plugins via
79    the \c{-plugin} argument, or when the environment variable
80    \c{QT_QPA_EGLFS_DISABLE_INPUT} is set or when building Qt without evdev
81    support, this function will have no effect.
82*/
83
84/*!
85    \fn int QEglFSFunctions::vsp2AddLayer(const QScreen *screen, int dmabufFd, const QSize &size, const QPoint &position, uint drmPixelFormat, uint bytesPerLine)
86    \internal
87    \preliminary
88*/
89
90/*!
91    \fn bool QEglFSFunctions::vsp2RemoveLayer(const QScreen *screen, int id)
92    \internal
93    \preliminary
94*/
95
96/*!
97    \fn void QEglFSFunctions::vsp2SetLayerBuffer(const QScreen *screen, int id, int dmabufFd)
98    \internal
99    \preliminary
100*/
101
102/*!
103    \fn bool QEglFSFunctions::vsp2SetLayerPosition(const QScreen *screen, int id, const QPoint &position)
104    \internal
105    \preliminary
106*/
107
108/*!
109    \fn bool QEglFSFunctions::vsp2SetLayerAlpha(const QScreen *screen, int id, qreal alpha)
110    \internal
111    \preliminary
112*/
113
114/*!
115    \fn void QEglFSFunctions::vsp2AddBlendListener(const QScreen *screen, void(*callback)())
116    \internal
117    \preliminary
118*/
119
120/*!
121    \typedef QEglFSFunctions::Vsp2AddBlendListenerType
122    \internal
123*/
124
125/*!
126    \typedef QEglFSFunctions::Vsp2AddLayerType
127    \internal
128*/
129
130/*!
131    \typedef QEglFSFunctions::Vsp2RemoveLayerType
132    \internal
133*/
134
135/*!
136    \typedef QEglFSFunctions::Vsp2SetLayerBufferType
137    \internal
138*/
139
140/*!
141    \typedef QEglFSFunctions::Vsp2SetLayerPositionType
142    \internal
143*/
144
145/*!
146    \typedef QEglFSFunctions::Vsp2SetLayerAlphaType
147    \internal
148*/
149
150/*! \fn QByteArray QEglFSFunctions::vsp2AddBlendListenerTypeIdentifier()
151    \internal
152 */
153
154/*! \fn QByteArray QEglFSFunctions::vsp2AddLayerTypeIdentifier()
155    \internal
156 */
157
158/*! \fn QByteArray QEglFSFunctions::vsp2RemoveLayerTypeIdentifier()
159    \internal
160 */
161
162/*! \fn QByteArray QEglFSFunctions::vsp2SetLayerBufferTypeIdentifier()
163    \internal
164 */
165
166/*! \fn QByteArray QEglFSFunctions::vsp2SetLayerPositionTypeIdentifier()
167    \internal
168 */
169
170/*! \fn QByteArray QEglFSFunctions::vsp2SetLayerAlphaTypeIdentifier()
171    \internal
172 */
173