--- title: Mir support for Wayland description: Whatever the reason you have for developing a Wayland based shell, Mir provides both a great foundation and the tools to build on it. url: https://canonical.com/blog/mir-support-for-wayland?format=md --- 1. [Blog](https://canonical.com/blog) 2. Article --- [Alan Griffiths](https://canonical.com/blog/author/alan-griffiths "More about Alan Griffiths") 24 July 2019 # Mir support for Wayland [mir](https://canonical.com/blog/tag/mir) [mir-kiosk](https://canonical.com/blog/tag/mir-kiosk) [wayland](https://canonical.com/blog/tag/wayland) --- Share the article ## **What is Mir, what is Wayland, do I care?** Shells for graphical interfaces come in many forms, from digital signage and kiosks that just show a single full screen application; to desktop environments that manage multiple applications, multiple screens and multiple workspaces. Traditionally, shells are built from a number of closely coupled components: display servers, compositors, window managers and panels. Mir is a library for developing shells that makes it easier to share common functionality between them while preserving the freedom to be different where it matters. Mir provides window management defaults, but does not impose a particular window management style. It provides some default graphics hardware/driver stacks, but others can be (and are) used. It is possible to customize the compositing, etc. Wayland is a protocol for communication between applications and shells and there are de-facto APIs, libraries and other tools for working with this protocol. There is a very narrow core to this protocol (basically just IPC and a mechanism for adding extensions) and to do anything “real” needs Wayland extension protocols. Mir provides the core and the standard extensions by default, and provides ways to enable and/or implement additional Wayland extension protocols. If you create a shell with Mir you do not need to develop anything it has in common with other shells: window management, support for various hardware, compositing, Wayland. You can concentrate on the features that make it unique. ## How is Mir used? Like any other library, Mir is used by linking it into an application. There are existing applications using Mir… For appliances with a single, full-screen application we provide the [“mir-kiosk”](https://blog.ubuntu.com/2018/10/04/mir-kiosk-uses-mir) snap [UBports](https://ubports.com/) use Mir for the Ubuntu Touch phone operating system and the [Unity8 desktop environment](https://unity8.io/) There is work-in-progress supporting [Wayland in the MATE desktop](https://discourse.ubuntu.com/search?q=mate%20category%3Amir%20order%3Alatest) To help developers get started there is an example desktop, [egmde](https://blog.ubuntu.com/2018/11/19/egmde-uses-mir), with tutorials showing the stages of development and available as both classic and confined snaps ## **Customizing Mir based shells** There are two basic ways to customize Mir: you can supply configuration options when the program is run, or you can write code that works with the Mir library. Mir is structured so that the window management, compositing logic, graphics stacks and communications protocols can be configured independently. You can select a window management style (we provide floating, kiosk, and tiling window management examples) independently of other options such as the Wayland extension protocols supported. In this article we’re going to focus on the options for configuring Wayland support. ## **Customizing Wayland extensions** ### **The built in extensions** Mir comes with a number of Wayland extensions “built in”, the “recommended for every use” ones are enabled by default, others that are disabled by default and must be enabled by configuration or code. | **protocol** | **default** | | --- | --- | | wl\_shell | enabled | | xdg\_wm\_base | enabled | | zxdg\_shell\_v6 | enabled | | zwlr\_layer\_shell\_v1 | disabled | | zxdg\_output\_manager\_v1 | disabled | The simplest way to configure these extensions is to take an existing Mir shell and specify the extensions you want: ``` miral-shell --wayland-extensions wl_shell:zxdg_shell_v6:zxdg_output_manager_v1 ``` Depending on the way you are deploying your shell, the extensions can be specified on the command line, as an environment variable, or in a configuration file. When you write your own shell you can enable and/or disable extensions in the code. You can also write a “filter” so that you can control the extensions available to particular applications. (For example, you probably only want to offer `zwlr_layer_shell_v1` to shell components.) ### **Custom extensions** When writing shells it is common to have client “applications” that need access to features that are provided by the standard extensions. Unity8, for example, uses a richer set of window types so it can handle them well across both phones and desktops. This is where the ability to add Wayland extension protocols is useful: the client and server can exchange information not available by other means. In addition to the built in extensions, shells can add extensions of their own. There are two reasons to do this when writing a shell: * your Wayland extension would be useful for many shells but is not yet ready to upstream to Mir; and, * your Wayland extension is specific to your shell and of no use elsewhere. Once you have added your Wayland extension to your shell it can be controlled in the same ways as the built in extensions. ## **Implementing and testing Wayland extensions** When you implement a custom Wayland extension there are three steps to the process: * First, you generate “wrapper” classes that represent the protocol in Mir; * Then, you code and test the protocol logic for these classes; * Finally, you register and configure the protocol in your shell. Use the development tools the Mir team provides to help with this: * Use the headers and code generator for the wrappers from the “libmirwayland-dev” package; * Test the implementation of your Wayland protocols with the Wayland Conformance Test Suite [“wlcs”](https://github.com/MirServer/wlcs); and, * Register and configure your protocol using the Mir library “libmiral-dev”. For more details on this development process follow the [“worked example”](https://discourse.ubuntu.com/t/developing-wayland-extension-protocols-for-mir-servers/11993) which covers implementing the “primary\_selection” protocol in the example egmde shell. ## **Summary** You might have many reasons to start building a graphical shell environment: you might want to customize the mir-kiosk experience, you might need a more desktop-like experience where multiple applications run on an appliance or you might want to “scratch an itch” and build something better that everything that came before. Wayland provides an extensible way for shell components to communicate with each other, if there is no existing protocol that meets your needs then writing one that is fit for your purpose is well supported. Whatever the reason you have for developing a Wayland based shell, Mir provides both a great foundation and the tools to build on it. [Get in touch Interested in running Ubuntu in your organization?](https://ubuntu.com/about/contact-us/form) ## Sign up for our newsletter Get the latest Canonical news and updates in your inbox. Work email: \*I agree to receive information about Canonical's products and services. By submitting this form, I confirm that I have read and agree to [Canonical's Privacy Policy](https://canonical.com/legal/dataprivacy). Sign up ## Share on --- ## Related posts [### Creating Graphical Shells – Try Mir in a Virtual Machine](https://canonical.com/blog/creating-graphical-shells-try-mir-in-a-virtual-machine) What is Mir? Mir is a set of libraries for creating graphical shells for Linux on a range of hardware. This means that there are a number of shells based on Mir and they work... [Alan Griffiths](https://canonical.com/blog/author/alan-griffiths) 25 February 2021 [### Mir 2.5, incorporating new features to improve the development of embedded graphic applications](https://canonical.com/blog/mir-2-5-enhancing-digital-signage-and-smart-screen-development) With another release of Mir, we have prepared a new blog with the a roundup of the product’s newest features. Mir is our flexible display server that provides a set of... [Gabriel Aguiar Noury](https://canonical.com/blog/author/g-aguiar-noury) 13 October 2021 [### Mir 2.4, enhancing digital signage and smart screen development](https://canonical.com/blog/mir-2-4-enhancing-digital-signage-and-smart-screen-development) Another cycle brings another release of Mir, with new features and new innovative use cases. For those of you new to Mir, our flexible display server provides a set of... [Gabriel Aguiar Noury](https://canonical.com/blog/author/g-aguiar-noury) 18 June 2021 [### A snap confined shell based on Mir: Mircade](https://canonical.com/blog/a-snap-confined-shell-based-on-mir-mircade) Mircade: An example snap confined user shell There are various scenarios and reasons for packaging a Snap confined shell and a selection of applications together in a confined... [Alan Griffiths](https://canonical.com/blog/author/alan-griffiths) 3 July 2020