• Logo
    Mir
  • https://canonical.com/mir
  • More resources
    • Discourse
    • Matrix
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Mir v2.22.2-641-g2b7e3ac32c documentation
Mir v2.22.2-641-g2b7e3ac32c documentation
  • Tutorials
    • Getting started with Mir
    • Write your first Wayland compositor
  • How-to guides
    • How to handle keyboard input
    • How to integrate a custom Wayland protocol
    • How to specify startup applications
    • Specifying CSD/SSD preference
  • Explanation
    • Accessibility methods
    • User libraries
    • Using Mir to build a desktop environment
    • Graphics Driver Quriks
    • Energy efficiency
    • Performance
    • Platform support
    • Security
    • Window positions under Wayland
  • Reference
    • Mir C++ API documentation
    • Compositors built with Mir
    • Introducing the Miral API
    • Linux kernel requirements for Mir
  • Configuring Mir
    • How-to guides
      • How to calibrate a touchscreen device
      • How to enable remote desktop
      • How to enable screencasting
      • How to use on-screen keyboards
    • Explanation
      • Mir component reports
    • Reference
      • Mir configuration options
  • Contributing to Mir
    • How-to guides
      • How to debug Mir snaps
      • How to enable gpu-2404 on a device
      • Getting involved in Mir
      • How to test Mir for a release
      • How to update symbols map files
      • Using checkbox-mir to validate your snap graphical environment
    • Explanation
      • Architecture
      • Input Platform APIs
      • Libraries
    • Reference
      • Mir continuous integration
      • Mir C++ style guide
      • A brief guide for versioning symbols in the Mir DSOs
Back to top
Contribute to this page

Reference¶

These pages provide detailed reference to Mir APIs and other interfaces.

API¶

  • API

  • Introducing the MirAL API

Ecosystem¶

  • Compositors Built with Mir

Requirements¶

  • Kernel requirements

Copyright © 2025, Canonical Ltd.
Last updated on Sep 27, 2025
Contents
  • Reference
    • API
    • Ecosystem
    • Requirements