diff options
Diffstat (limited to 'docs/markdown')
-rw-r--r-- | docs/markdown/Wayland-module.md | 64 | ||||
-rw-r--r-- | docs/markdown/_Sidebar.md | 1 | ||||
-rw-r--r-- | docs/markdown/snippets/wayland-module.md | 4 |
3 files changed, 69 insertions, 0 deletions
diff --git a/docs/markdown/Wayland-module.md b/docs/markdown/Wayland-module.md new file mode 100644 index 0000000..d30627c --- /dev/null +++ b/docs/markdown/Wayland-module.md @@ -0,0 +1,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/) diff --git a/docs/markdown/_Sidebar.md b/docs/markdown/_Sidebar.md index 0ca1762..ce73d5a 100644 --- a/docs/markdown/_Sidebar.md +++ b/docs/markdown/_Sidebar.md @@ -13,3 +13,4 @@ * [i18n](i18n-module.md) * [pkgconfig](Pkgconfig-module.md) * [rust](Rust-module.md) +* [wayland](Wayland-module.md) diff --git a/docs/markdown/snippets/wayland-module.md b/docs/markdown/snippets/wayland-module.md new file mode 100644 index 0000000..cd5e5dc --- /dev/null +++ b/docs/markdown/snippets/wayland-module.md @@ -0,0 +1,4 @@ +## New unstable wayland module + +This module can search for protocol xml files from the wayland-protocols +package, and generate .c and .h files using wayland-scanner. |