🎓 Tutorial

This is a work in progress. In the meantime, you can get started by cloning a base template from the following repository:

https://github.com/CuarzoSoftware/LouvreTemplate

It is well-documented and already implements the scene and views system for efficient rendering and basic server-side decorations.

‍The old tutorial can be found here, however, it is outdated, and many concepts and APIs have changed since then.

Key Concepts

Here are some links to the C++ API documentation to help you navigate it:

• Compositor Initialization and Uninitialization.
• Object Factory.
• Rendering Content to Displays.
• Multithreading.
• Scene and Views.
• Fractional Scaling and Oversampling.
• Gamma Correction.
• Tearing Control.
• Pointer Events and Gestures.
• Pointer Constraints.
• Cursor.
• Keyboard Events.
• Touch Events.
• Configuring Input Devices.
• Screencasting.
• Clipboard and Drag & Drop.
• Surfaces and Roles.
• Session Lock Manager and role.
• Toplevel and Popup surfaces.
• Wlr Layer Shell and Exclusive Zones.
• XDG Activation Tokens.
• Foreign Toplevel Window Management.
• Foreign Toplevel List.
• Idle Listeners and Inhibitors.
• DRM Leasing (VR Headsets).
• Wlr Output Management.