This page hosts the documentation for the crates of the wayland-rs repository.
wayland-client API docs. API documentation of the wayland-client crate. It is the core crate for writing wayland client apps.
wayland-server API docs. API documentation of the wayland-server crate. It is the core crate for writing wayland compositors.
wayland-protocols API docs. API documentation of the wayland-protocols crate. This crate provides generated bindings for various classic wayland protocol extensions. To be used with wayland-client or wayland-server.
wayland-commons API docs. API documentation of the wayland-commons crate. This crate contains various type and trait definitions used by the other crates.
These crates are not meant to be used by everyone wanting to make wayland apps. You'll mostly need them if you want to bind a protocol extention that is not (yet) provided by wayland-protocols.
wayland-sys API docs. API documentation of the wayland-sys crate. It contains raw FFI bindings to the C libwayland-*.so libraries.
wayland-scanner API docs. API documentation of the wayland-scanner crate. It contains all the necessary logic to parxe an XML protocol extension specification and generate the associated rust code to use with wayland-client or wayland-server.