mutter/doc/code-overview.md

# Code Overview

Mutter consists of four relatively distinguished and isolated parts.

## Cogl

Hardware acceleration pipeline abstraction layer. Handles things like allocating framebuffer, allocating, importing and drawing textures, internally using OpenGL. Originally a fork of [the Cogl project](https://gitlab.gnome.org/GNOME/cogl).

## Clutter

Compositing toolkit, containing an actor and render node based scene graph, and has features such as input event routing, transformation and animation. Handles compositing, both Wayland surfaces, X11 windows, and is the basis of the UI toolkit implemented by [GNOME Shell](https://gitlab.gnome.org/GNOME/gnome-shell). Originally a fork of [the Clutter project](https://gitlab.gnome.org/GNOME/clutter).

* [Frame Scheduling](clutter-frame-scheduling.md)

## Mtk

The Meta Toolkit containing utilities shared by other parts of mutter.

## Mutter

The display server and window manager library. Contains a X11 window manager and compositing manager implementation, as well as a Wayland display server implementation.

* [Compositor stage and hardware relationships](mutter-relationships.md)
* [Window constraints](mutter-constraints.txt)
* [How to get focus right](mutter-focus.txt)
docs: Move the gitlab wiki and other docs to the docs/ directory Let's try to consolidate our documentation in doc/ in the repo. This includes some documentation from README.md, the HACKING.md coding style and the gitlab wiki. The README.md file now links to all top-level topics (i.e. not reachable via other topics). This also includes a few small changes to make things more consistent. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3465> 2023-12-18 11:30:53 -05:00			`# Code Overview`

			`Mutter consists of four relatively distinguished and isolated parts.`

			`## Cogl`

			`Hardware acceleration pipeline abstraction layer. Handles things like allocating framebuffer, allocating, importing and drawing textures, internally using OpenGL. Originally a fork of [the Cogl project](https://gitlab.gnome.org/GNOME/cogl).`

			`## Clutter`

			`Compositing toolkit, containing an actor and render node based scene graph, and has features such as input event routing, transformation and animation. Handles compositing, both Wayland surfaces, X11 windows, and is the basis of the UI toolkit implemented by [GNOME Shell](https://gitlab.gnome.org/GNOME/gnome-shell). Originally a fork of [the Clutter project](https://gitlab.gnome.org/GNOME/clutter).`

docs: Prefix code documentation files with the subsystem they belong to. This makes it easier to see which files belong where. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3485> 2024-01-03 16:30:16 -05:00			`* [Frame Scheduling](clutter-frame-scheduling.md)`
docs: Move the gitlab wiki and other docs to the docs/ directory Let's try to consolidate our documentation in doc/ in the repo. This includes some documentation from README.md, the HACKING.md coding style and the gitlab wiki. The README.md file now links to all top-level topics (i.e. not reachable via other topics). This also includes a few small changes to make things more consistent. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3465> 2023-12-18 11:30:53 -05:00
			`## Mtk`

			`The Meta Toolkit containing utilities shared by other parts of mutter.`

			`## Mutter`

			`The display server and window manager library. Contains a X11 window manager and compositing manager implementation, as well as a Wayland display server implementation.`

			`* [Compositor stage and hardware relationships](mutter-relationships.md)`
docs: Prefix code documentation files with the subsystem they belong to. This makes it easier to see which files belong where. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3485> 2024-01-03 16:30:16 -05:00			`* [Window constraints](mutter-constraints.txt)`
			`* [How to get focus right](mutter-focus.txt)`