mutter/doc/clutter-frame-scheduling.md

# Clutter Frame scheduling

`ClutterFrameClock` state diagram.

```mermaid
stateDiagram
    Init --> Scheduled : schedule update() -> now
    Idle --> Scheduled : schedule update() -> given presentation time
    Scheduled --> Dispatching : target time hit
    Dispatching --> PendingPresented : queued page flip
    Dispatching --> Idle : no queued page flip
    PendingPresented --> Scheduled : page flipped, if recent schedule update
    PendingPresented --> Idle : page flipped
```
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 21:30:16 +00:00			`# Clutter Frame scheduling`
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 16:30:53 +00:00
			`ClutterFrameClock` state diagram.

			```mermaid
			`stateDiagram`
			`Init --> Scheduled : schedule update() -> now`
			`Idle --> Scheduled : schedule update() -> given presentation time`
			`Scheduled --> Dispatching : target time hit`
			`Dispatching --> PendingPresented : queued page flip`
			`Dispatching --> Idle : no queued page flip`
			`PendingPresented --> Scheduled : page flipped, if recent schedule update`
			`PendingPresented --> Idle : page flipped`
			```