• 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.0-217-gd18e2704c0 documentation
Mir v2.22.0-217-gd18e2704c0 documentation
  • Tutorials
    • Write your first Wayland compositor
  • How-to guides
    • Developing a Wayland Compositor using Mir
    • How to integrate a custom Wayland protocol
    • How to Handle Keyboard Input
    • Specifying CSD/SSD Preference
  • Explanation
    • Libraries
    • Mir graphics support
    • Security
    • Performance
    • Energy Efficiency
    • Window positions under Wayland
    • Mir component reports
    • Accessibility Methods
  • Reference
    • Mir API
      • Namespace mir
      • Namespace mir::geometry
      • Namespace mir::geometry::generic
      • Namespace mir::renderer
      • Namespace mir::wayland
      • Namespace miral
      • Namespace miral::detail
      • Namespace miral::live_config
      • Namespace miral::toolkit
      • Namespace miroil
      • Namespace std
      • Struct DeltaXTag
      • Struct DeltaYTag
      • Template Struct Displacement
      • Template Struct Point
      • Template Struct Rectangle
      • Template Struct Size
      • Template Struct Value
      • Struct HeightTag
      • Struct StrideTag
      • Struct WidthTag
      • Struct XTag
      • Struct YTag
      • Struct IntOwnedFd
      • Struct ApplicationInfo
      • Template Struct FunctionType
      • Template Struct FunctionType< Return(Lambda::*)(Arg…) const >
      • Template Struct FunctionType< Return(Lambda::*)(Arg…) >
      • Struct FdHandle
      • Struct Output::PhysicalSizeMM
      • Struct WaylandExtensions::Builder
      • Struct WindowInfo
      • Struct WindowManagerOption
      • Struct WindowSpecification::AspectRatio
      • Struct MirBufferPackage
      • Struct DisplayConfigurationOptions
      • Struct DisplayConfigurationOptions::DisplayMode
      • Struct DisplayId
      • Struct Edid
      • Struct Edid::PhysicalSizeMM
      • Template Struct hash< ::mir::IntWrapper< Tag, ValueType > >
      • Class AbnormalExit
      • Class AnonymousShmFile
      • Class ExitWithOutput
      • Class FatalErrorStrategy
      • Class Fd
      • Class Rectangles
      • Template Class IntWrapper
      • Template Class optional_value
      • Class ProofOfMutexLock
      • Class ShmFile
      • Template Class Synchronised
      • Template Class Synchronised::LockedImpl
      • Class AddInitCallback
      • Class AppendEventFilter
      • Class AppendKeyboardEventFilter
      • Class ApplicationAuthorizer
      • Class ApplicationCredentials
      • Class BasicSetApplicationAuthorizer
      • Class BounceKeys
      • Class CanonicalWindowManagerPolicy
      • Class ConfigFile
      • Class ConfigurationOption
      • Class CursorScale
      • Class CursorTheme
      • Class CustomRenderer
      • Class Decorations
      • Class DisplayConfiguration
      • Class DisplayConfiguration::Node
      • Class ExternalClientLauncher
      • Class HoverClick
      • Class IdleListener
      • Class InputConfiguration
      • Class InputConfiguration::Keyboard
      • Class InputConfiguration::Mouse
      • Class InputConfiguration::Touchpad
      • Class InternalClientLauncher
      • Class Keymap
      • Class IniFile
      • Class Key
      • Class Store
      • Class Magnifier
      • Class MinimalWindowManager
      • Class MirRunner
      • Class MouseKeysConfig
      • Class Output
      • Class OutputFilter
      • Class PrependEventFilter
      • Class SessionLockListener
      • Template Class SetApplicationAuthorizer
      • Class SetCommandLineHandler
      • Class SetTerminator
      • Class SetWindowManagementPolicy
      • Class SimulatedSecondaryClick
      • Class SlowKeys
      • Class StartupInternalClient
      • Class StickyKeys
      • Class WaylandExtensions
      • Class WaylandExtensions::Context
      • Class WaylandExtensions::EnableInfo
      • Class WaylandTools
      • Class Window
      • Class WindowManagementPolicy
      • Class WindowManagerOptions
      • Class WindowManagerTools
      • Class WindowSpecification
      • Class X11Support
      • Class Zone
      • Class Compositor
      • Class DisplayConfigurationControllerWrapper
      • Class DisplayConfigurationPolicy
      • Class DisplayConfigurationStorage
      • Class DisplayListenerWrapper
      • Class EventBuilder
      • Class EventBuilder::EventInfo
      • Class InputDevice
      • Class InputDeviceObserver
      • Class MirPromptSession
      • Class MirServerHooks
      • Class OpenGLContext
      • Class PersistDisplayConfig
      • Class PromptSessionListener
      • Class PromptSessionManager
      • Class SetCompositor
      • Class Surface
      • Class SurfaceObserver
      • Enum
      • Enum FocusStealing
      • Enum MirBufferFlag
      • Enum MirDepthLayer
      • Enum MirEdgeAttachment
      • Enum MirEventType
      • Enum MirFocusMode
      • Enum MirFormFactor
      • Enum MirInputEventModifier
      • Enum MirInputEventType
      • Enum MirKeyboardAction
      • Enum MirLifecycleState
      • Enum MirMirrorMode
      • Enum MirOrientation
      • Enum MirOrientationMode
      • Enum MirOutputFilter
      • Enum MirOutputGammaSupported
      • Enum MirOutputType
      • Enum MirPixelFormat
      • Enum MirPlacementGravity
      • Enum MirPlacementHints
      • Enum MirPointerAcceleration
      • Enum MirPointerAction
      • Enum MirPointerAxis
      • Enum MirPointerAxisSource
      • Enum MirPointerButton
      • Enum MirPointerConfinementState
      • Enum MirPointerHandedness
      • Enum MirPowerMode
      • Enum MirPromptSessionState
      • Enum MirResizeEdge
      • Enum MirShellChrome
      • Enum MirSubpixelArrangement
      • Enum MirTiledEdge
      • Enum MirTouchAction
      • Enum MirTouchAxis
      • Enum MirTouchpadClickMode
      • Enum MirTouchpadScrollMode
      • Enum MirTouchscreenMappingMode
      • Enum MirTouchTooltype
      • Enum MirWindowAttrib
      • Enum MirWindowFocusState
      • Enum MirWindowState
      • Enum MirWindowType
      • Enum MirWindowVisibility
      • Function mir::fatal_error_abort
      • Function mir::fatal_error_except
      • Template Function mir::geometry::as_delta(generic::X<T> const&)
      • Template Function mir::geometry::as_delta(generic::Y<T> const&)
      • Template Function mir::geometry::as_delta(generic::Width<T> const&)
      • Template Function mir::geometry::as_delta(generic::Height<T> const&)
      • Template Function mir::geometry::as_height(generic::DeltaY<T> const&)
      • Template Function mir::geometry::as_height(generic::Y<T> const&)
      • Template Function mir::geometry::as_width(generic::DeltaX<T> const&)
      • Template Function mir::geometry::as_width(generic::X<T> const&)
      • Template Function mir::geometry::as_x(generic::DeltaX<T> const&)
      • Template Function mir::geometry::as_x(generic::Width<T> const&)
      • Template Function mir::geometry::as_y(generic::DeltaY<T> const&)
      • Template Function mir::geometry::as_y(generic::Height<T> const&)
      • Template Function mir::geometry::generic::as_displacement(Size<T> const&)
      • Template Function mir::geometry::generic::as_displacement(Point<T> const&)
      • Template Function mir::geometry::generic::as_point(Displacement<T> const&)
      • Template Function mir::geometry::generic::as_point(Size<T> const&)
      • Template Function mir::geometry::generic::as_size(Displacement<T> const&)
      • Template Function mir::geometry::generic::as_size(Point<T> const&)
      • Template Function mir::geometry::generic::intersection_of
      • Template Function mir::geometry::generic::operator*(Scalar, Width<T> const&)
      • Template Function mir::geometry::generic::operator*(Scalar, Height<T> const&)
      • Template Function mir::geometry::generic::operator*(Scalar, DeltaX<T> const&)
      • Template Function mir::geometry::generic::operator*(Scalar, DeltaY<T> const&)
      • Template Function mir::geometry::generic::operator*(Width<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator*(Height<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator*(DeltaX<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator*(DeltaY<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator*(Scalar, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator*(Displacement<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator*(Scalar, Size<T> const&)
      • Template Function mir::geometry::generic::operator*(Size<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator+(DeltaX<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+(DeltaY<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+(X<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+(Y<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+(Width<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+(Height<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+(Width<T>, Width<T>)
      • Template Function mir::geometry::generic::operator+(Height<T>, Height<T>)
      • Template Function mir::geometry::generic::operator+(Displacement<T> const&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator+(Point<T> const&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator+(Displacement<T> const&, Point<T> const&)
      • Template Function mir::geometry::generic::operator+(Point<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+(Point<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+=(DeltaX<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+=(DeltaY<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+=(X<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+=(Y<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+=(Width<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+=(Height<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator+=(Width<T>&, Width<T>)
      • Template Function mir::geometry::generic::operator+=(Height<T>&, Height<T>)
      • Template Function mir::geometry::generic::operator+=(Point<T>&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator+=(Point<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator+=(Point<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-(DeltaX<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-(DeltaY<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-(DeltaX<T>)
      • Template Function mir::geometry::generic::operator-(DeltaY<T>)
      • Template Function mir::geometry::generic::operator-(X<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-(Y<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-(Width<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-(Height<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-(X<T>, X<T>)
      • Template Function mir::geometry::generic::operator-(Y<T>, Y<T>)
      • Template Function mir::geometry::generic::operator-(Width<T>, Width<T>)
      • Template Function mir::geometry::generic::operator-(Height<T>, Height<T>)
      • Template Function mir::geometry::generic::operator-(Displacement<T> const&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator-(Displacement<T> const&)
      • Template Function mir::geometry::generic::operator-(Point<T> const&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator-(Point<T> const&, Point<T> const&)
      • Template Function mir::geometry::generic::operator-(Point<T>, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-(Point<T>, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-=(DeltaX<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-=(DeltaY<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-=(X<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-=(Y<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-=(Width<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-=(Height<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator-=(Point<T>&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator-=(Point<T>&, DeltaX<T>)
      • Template Function mir::geometry::generic::operator-=(Point<T>&, DeltaY<T>)
      • Template Function mir::geometry::generic::operator/(Width<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator/(Height<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator/(DeltaX<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator/(DeltaY<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator/(X<T> const&, Width<U> const&)
      • Template Function mir::geometry::generic::operator/(Y<T> const&, Height<U> const&)
      • Template Function mir::geometry::generic::operator/(Size<T> const&, Scalar)
      • Template Function mir::geometry::generic::operator<
      • Template Function mir::geometry::generic::operator<<(std::ostream&, Value<T, Tag> const&)
      • Template Function mir::geometry::generic::operator<<(std::ostream&, Displacement<T> const&)
      • Template Function mir::geometry::generic::operator<<(std::ostream&, Point<T> const&)
      • Template Function mir::geometry::generic::operator<<(std::ostream&, Rectangle<T> const&)
      • Template Function mir::geometry::generic::operator<<(std::ostream&, Size<T> const&)
      • Function mir::geometry::operator<<
      • Function mir::mir_depth_layer_get_index
      • Template Function mir::operator!=(optional_value<T> const&, optional_value<T> const&)
      • Template Function mir::operator!=(optional_value<T> const&, T const&)
      • Template Function mir::operator!=(T const&, optional_value<T> const&)
      • Template Function mir::operator<<
      • Template Function mir::operator==(optional_value<T> const&, optional_value<T> const&)
      • Template Function mir::operator==(optional_value<T> const&, T const&)
      • Template Function mir::operator==(T const&, optional_value<T> const&)
      • Template Function miral::add_window_manager_policy
      • Function miral::application_for(wl_client *)
      • Function miral::application_for(wl_resource *)
      • Function miral::apply_lifecycle_state_to
      • Function miral::display_configuration_options
      • Function miral::equivalent_display_area
      • Function miral::kill
      • Template Function miral::lambda_as_function
      • Function miral::name_of
      • Function miral::operator!=(Output::PhysicalSizeMM const&, Output::PhysicalSizeMM const&)
      • Function miral::operator!=(Window const&, Window const&)
      • Function miral::operator!=(std::shared_ptr<mir::scene::Surface> const&, Window const&)
      • Function miral::operator!=(Window const&, std::shared_ptr<mir::scene::Surface> const&)
      • Function miral::operator<
      • Function miral::operator<=
      • Function miral::operator==(Output::PhysicalSizeMM const&, Output::PhysicalSizeMM const&)
      • Function miral::operator==(Window const&, Window const&)
      • Function miral::operator==(std::shared_ptr<mir::scene::Surface> const&, Window const&)
      • Function miral::operator==(Window const&, std::shared_ptr<mir::scene::Surface> const&)
      • Function miral::operator>
      • Function miral::operator>=
      • Function miral::pid_of
      • Function miral::pre_init
      • Function miral::PrintTo
      • Template Function miral::set_window_management_policy
      • Function miral::socket_fd_of
      • Function miral::toolkit::mir_event_get_input_event
      • Function miral::toolkit::mir_event_get_type
      • Function miral::toolkit::mir_input_event_get_event
      • Function miral::toolkit::mir_input_event_get_event_time
      • Function miral::toolkit::mir_input_event_get_keyboard_event
      • Function miral::toolkit::mir_input_event_get_pointer_event
      • Function miral::toolkit::mir_input_event_get_touch_event
      • Function miral::toolkit::mir_input_event_get_type
      • Function miral::toolkit::mir_keyboard_event_action
      • Function miral::toolkit::mir_keyboard_event_input_event
      • Function miral::toolkit::mir_keyboard_event_key_text
      • Function miral::toolkit::mir_keyboard_event_keysym
      • Function miral::toolkit::mir_keyboard_event_modifiers
      • Function miral::toolkit::mir_keyboard_event_scan_code
      • Function miral::toolkit::mir_pointer_event_action
      • Function miral::toolkit::mir_pointer_event_axis_value
      • Function miral::toolkit::mir_pointer_event_button_state
      • Function miral::toolkit::mir_pointer_event_buttons
      • Function miral::toolkit::mir_pointer_event_input_event
      • Function miral::toolkit::mir_pointer_event_modifiers
      • Function miral::toolkit::mir_touch_event_action
      • Function miral::toolkit::mir_touch_event_axis_value
      • Function miral::toolkit::mir_touch_event_id
      • Function miral::toolkit::mir_touch_event_input_event
      • Function miral::toolkit::mir_touch_event_modifiers
      • Function miral::toolkit::mir_touch_event_point_count
      • Function miral::toolkit::mir_touch_event_tooltype
      • Function miral::window_for
      • Function miroil::dispatch_input_event
      • Specialized Template Function std::swap
      • Variable mir::fatal_error
      • Define __has_extension
      • Define __has_feature
      • Define MIR_BYTES_PER_PIXEL
      • Define MIR_VERSION_NUMBER
      • Define MIRAL_MAJOR_VERSION
      • Define MIRAL_MICRO_VERSION
      • Define MIRAL_MINOR_VERSION
      • Define MIRAL_VERSION
      • Typedef mir::EventUPtr
      • Typedef mir::geometry::DeltaX
      • Typedef mir::geometry::DeltaXF
      • Typedef mir::geometry::DeltaY
      • Typedef mir::geometry::DeltaYF
      • Typedef mir::geometry::Displacement
      • Typedef mir::geometry::DisplacementD
      • Typedef mir::geometry::DisplacementF
      • Typedef mir::geometry::generic::DeltaX
      • Typedef mir::geometry::generic::DeltaY
      • Typedef mir::geometry::generic::Height
      • Typedef mir::geometry::generic::Width
      • Typedef mir::geometry::generic::X
      • Typedef mir::geometry::generic::Y
      • Typedef mir::geometry::Height
      • Typedef mir::geometry::HeightF
      • Typedef mir::geometry::Point
      • Typedef mir::geometry::PointD
      • Typedef mir::geometry::PointF
      • Typedef mir::geometry::Rectangle
      • Typedef mir::geometry::RectangleD
      • Typedef mir::geometry::RectangleF
      • Typedef mir::geometry::Size
      • Typedef mir::geometry::SizeD
      • Typedef mir::geometry::SizeF
      • Typedef mir::geometry::Stride
      • Typedef mir::geometry::Width
      • Typedef mir::geometry::WidthF
      • Typedef mir::geometry::X
      • Typedef mir::geometry::XF
      • Typedef mir::geometry::Y
      • Typedef mir::geometry::YF
      • Typedef miral::Application
      • Typedef miral::BufferStreamId
      • Typedef miral::CommandLineOption
      • Typedef miral::WindowManagementPolicyBuilder
      • Typedef MirBufferPackage
      • Typedef MirClientFdCallback
      • Typedef MirDepthLayer
      • Typedef MirEdgeAttachment
      • Typedef MirEvent
      • Typedef MirEvent
      • Typedef MirFocusMode
      • Typedef MirFormFactor
      • Typedef MirInputDeviceId
      • Typedef MirInputEventModifiers
      • Typedef MirLifecycleState
      • Typedef MirMirrorMode
      • Typedef MirNativeBuffer
      • Typedef miroil::CompositorID
      • Typedef miroil::CreateNamedCursor
      • Typedef miroil::OutputId
      • Typedef MirOrientation
      • Typedef MirOrientationMode
      • Typedef MirOutputFilter
      • Typedef MirOutputGammaSupported
      • Typedef MirOutputType
      • Typedef MirPixelFormat
      • Typedef MirPlacementGravity
      • Typedef MirPlacementHints
      • Typedef MirPointerAcceleration
      • Typedef MirPointerButtons
      • Typedef MirPointerConfinementState
      • Typedef MirPointerHandedness
      • Typedef MirPowerMode
      • Typedef MirPromptSession
      • Typedef MirPromptSessionState
      • Typedef MirResizeEdge
      • Typedef MirShellChrome
      • Typedef MirSubpixelArrangement
      • Typedef MirTiledEdge
      • Typedef MirTouchId
      • Typedef MirTouchpadClickMode
      • Typedef MirTouchpadClickModes
      • Typedef MirTouchpadScrollMode
      • Typedef MirTouchpadScrollModes
      • Typedef MirTouchscreenMappingMode
      • Typedef MirWindowAttrib
      • Typedef MirWindowFocusState
      • Typedef MirWindowState
      • Typedef MirWindowType
      • Typedef MirWindowVisibility
    • Introducing the Miral API
    • Linux Kernel Requirements for Mir
  • Configuring Mir
    • Tutorials
    • How-to guides
      • How to calibrate a touchscreen device
      • How to Enable Remote Desktop
      • How to Use On-Screen Keyboards
      • How To Enable Screencasting
    • Explanation
      • Mir component reports
    • Reference
  • Contributing to Mir
    • Tutorials
    • How-to guides
      • 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
      • How to enable gpu-2404 on a device
    • Explanation
      • Architecture
      • Libraries
      • Mir graphics support
      • Security
      • Performance
      • Energy Efficiency
      • Mir component reports
    • Reference
      • A brief guide for versioning symbols in the Mir DSOs
      • Mir Continuous Integration
      • Linux Kernel Requirements for Mir
Back to top
Contribute to this page

How-to guides¶

These how-to guides cover the key aspects of working with Mir.

  • Developing a Compositor: build your own, custom compositor with Mir

  • How to integrate a custom Wayland protocol: extend your compositor with support for a custom protocol extension

  • How to specify start up applications

  • How to handle user input

  • Specifying CSD/SSD Preference

Copyright © 2025, Canonical Ltd.
Last updated on Sep 05, 2025
Contents
  • How-to guides