https://github.com/kde/layer-shell-qt

Qt component to allow applications to make use of the Wayland wl-layer-shell protocol.
https://github.com/kde/layer-shell-qt

Last synced: 4 days ago
JSON representation

Qt component to allow applications to make use of the Wayland wl-layer-shell protocol.

• Host: GitHub
• URL: https://github.com/kde/layer-shell-qt
• Owner: KDE
• Created: 2021-04-02T11:44:02.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T13:22:45.000Z (23 days ago)
• Last Synced: 2024-10-23T11:35:47.819Z (22 days ago)
• Language: C++
• Homepage: https://invent.kde.org/plasma/layer-shell-qt
• Size: 253 KB
• Stars: 25
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSES/BSD-3-Clause.txt

Awesome Lists containing this project

README

        
# LayerShellQt

This component is meant for applications to be able to easily use clients based on wlr-layer-shell.

Here you can read about what the protocol does and how shells work:

https://drewdevault.com/2018/07/29/Wayland-shells.html

Report issues in this component here:

https://bugs.kde.org/enter_bug.cgi?product=layer-shell-qt

## Usage

### CMake

To use it from a CMake project you'll need to:

```

find_package(LayerShellQt REQUIRED)

```

Then it will offer us the target `LayerShellQt::Interface` that we can link to to get access to this framework.

### C++

You can use `LayerShellQt::Shell::useLayerShell();` to enable it before any clients are created.

The class `LayerShellQt::Window` will give us access to surface-specific settings. We can get it by using `LayerShellQt::Window::get(window)` on whatever `QWindow` we need to tweak.