blob: d30627c2be7ce99ccbb0747d65e824f5f74d2c85 (
plain)
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
|
# Unstable Wayland Module
This module is available since version 0.62.0.
This module provides helper functions to find wayland protocol
xmls and to generate .c and .h files using wayland-scanner
**Note**: this module is unstable. It is only provided as a technology
preview. Its API may change in arbitrary ways between releases or it
might be removed from Meson altogether.
## Quick Usage
```meson
project('hello-wayland', 'c')
wl_dep = dependency('wayland-client')
wl_mod = import('unstable-wayland')
xml = wl_mod.find_protocol('xdg-shell')
xdg_shell = wl_mod.scan_xml(xml)
executable('hw', 'main.c', xdg_shell, dependencies : wl_dep)
```
## Methods
### find_protocol
```meson
xml = wl_mod.find_protocol(
'xdg-decoration',
state : 'unstable',
version : 1,
)
```
This function requires one positional argument: the protocol base name.
- `state` Optional arg that specifies the current state of the protocol.
Either stable, staging, or unstable.
The default is stable.
- `version` The backwards incompatible version number.
Required for staging or unstable. An error is raised for stable.
### scan_xml
```meson
generated = wl_mod.scan_xml(
'my-protocol.xml',
side : 'client',
scope : 'private',
)
```
This function accepts one or more arguments of either string or file type.
- `side` Optional arg that specifies if client or server side code is generated.
The default is client side.
- `scope` Optional arg that specifies the scope of the generated code.
Either public or private.
The default is private.
## Links
- [Official Wayland Documentation](https://wayland.freedesktop.org/docs/html/)
- [Wayland GitLab](https://gitlab.freedesktop.org/wayland)
- [Wayland Book](https://wayland-book.com/)
|
