2018-07-30 14:55:31 -04:00
|
|
|
# Mutter
|
|
|
|
|
|
|
|
|
|
Mutter is a Wayland display server and X11 window manager and compositor library.
|
|
|
|
|
|
|
|
|
|
When used as a Wayland display server, it runs on top of KMS and libinput. It
|
|
|
|
|
implements the compositor side of the Wayland core protocol as well as various
|
|
|
|
|
protocol extensions. It also has functionality related to running X11
|
|
|
|
|
applications using Xwayland.
|
|
|
|
|
|
|
|
|
|
When used on top of Xorg it acts as a X11 window manager and compositing manager.
|
|
|
|
|
|
|
|
|
|
It contains functionality related to, among other things, window management,
|
|
|
|
|
window compositing, focus tracking, workspace management, keybindings and
|
|
|
|
|
monitor configuration.
|
|
|
|
|
|
|
|
|
|
Internally it uses a fork of Cogl, a hardware acceleration abstraction library
|
2022-07-29 15:18:13 -04:00
|
|
|
used to simplify usage of OpenGL pipelines, as well as a fork of Clutter, a
|
2018-07-30 14:55:31 -04:00
|
|
|
scene graph and user interface toolkit.
|
|
|
|
|
|
2018-11-08 10:03:35 -05:00
|
|
|
Mutter is used by, for example, GNOME Shell, the GNOME core user interface, and
|
|
|
|
|
by Gala, elementary OS's window manager. It can also be run standalone, using
|
|
|
|
|
the command "mutter", but just running plain mutter is only intended for
|
|
|
|
|
debugging purposes.
|
2018-07-30 14:55:31 -04:00
|
|
|
|
2019-02-06 05:41:43 -05:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
To contribute, open merge requests at https://gitlab.gnome.org/GNOME/mutter.
|
|
|
|
|
|
2023-12-18 13:12:57 -05:00
|
|
|
It can be useful to first look at the
|
|
|
|
|
[GNOME Handbook](https://handbook.gnome.org/development.html) and the
|
|
|
|
|
documentation and API references below first.
|
2020-10-23 14:43:40 -04:00
|
|
|
|
2023-12-18 11:30:53 -05:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
- [Coding style and conventions](doc/coding-style.md)
|
|
|
|
|
- [Git conventions](doc/git-conventions.md)
|
|
|
|
|
- [Code overview](doc/code-overview.md)
|
2023-12-18 15:31:41 -05:00
|
|
|
- [Building and Running](doc/building-and-running.md)
|
2023-12-18 11:30:53 -05:00
|
|
|
- [Debugging](doc/debugging.md)
|
|
|
|
|
- [Monitor configuration](doc/monitor-configuration.md)
|
|
|
|
|
|
|
|
|
|
## API Reference
|
2023-08-31 03:55:40 -04:00
|
|
|
|
2022-06-03 13:38:57 -04:00
|
|
|
- Meta: <https://gnome.pages.gitlab.gnome.org/mutter/meta/>
|
|
|
|
|
- Clutter: <https://gnome.pages.gitlab.gnome.org/mutter/clutter/>
|
|
|
|
|
- Cally: <https://gnome.pages.gitlab.gnome.org/mutter/cally/>
|
|
|
|
|
- Cogl: <https://gnome.pages.gitlab.gnome.org/mutter/cogl/>
|
|
|
|
|
- CoglPango: <https://gnome.pages.gitlab.gnome.org/mutter/cogl-pango/>
|
2023-08-31 03:55:40 -04:00
|
|
|
- Mtk: <https://gnome.pages.gitlab.gnome.org/mutter/mtk/>
|
2022-06-03 13:38:57 -04:00
|
|
|
|
2018-07-30 14:55:31 -04:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Mutter is distributed under the terms of the GNU General Public License,
|
|
|
|
|
version 2 or later. See the [COPYING][license] file for detalis.
|
|
|
|
|
|
|
|
|
|
[bug-tracker]: https://gitlab.gnome.org/GNOME/mutter/issues
|
|
|
|
|
[license]: COPYING
|
