Decided to try writing a Wayland compositor for fun. Took me a few days to get things going to a video-able state.

This is scrollable tiling, heavily inspired by PaperWM (which I'm still using and very much enjoying). You've got an infinite strip of windows that you can scroll through.

It's also got dynamic workspaces which work like in GNOME Shell (the Correct™ way to do workspaces), but all monitors have workspaces.

The repo is https://github.com/YaLTeR/niri if you want to peek at the code

GitHub - YaLTeR/niri: A scrollable-tiling Wayland compositor.

A scrollable-tiling Wayland compositor. Contribute to YaLTeR/niri development by creating an account on GitHub.

GitHub

Added quite a number of things into the compositor since then. It's at the point where I can somewhat-comfortably use it for working or (Wayland-only) gaming sessions.

Today I figured out how to make it run as a proper session, launched from GDM, with systemd integration and all. It even mostly works!

Also finally implemented the ability to take screenshots—this one is from a real session.

Kinda want to try my hand at the screencast portal for OBS. How hard can it be, right? 🙃

Almost done adding touchpad gesture support to Smithay!

Here you can see the pinch zoom/rotate gesture visually in gtk4-demo, then the swipe gesture only in WAYLAND_DEBUG on the right, then the hold gesture by stopping the kinetic scrolling by putting a finger on the touchpad.

After adding dmabuf feedbacks to niri, I stumbled upon an extremely strange performance problem when using overlay planes. One specific animation, with a GTK 4 window open, stutters, but only when going into one direction.

Spent half a day debugging it with Smithay developers. Couldn't crack it yet; for some reason an AMDGPU kernel worker just... takes a while under those specific conditions, causing delayed frames. Seems to be doing the same thing as in the normal case, just... slower somehow.

Aaand my touchpad gesture support has been merged into Smithay! 

I'm quite enjoying playing with the Tracy profiler. Turns out when you run the program with sudo, it records a ton of extra useful info, like CPU core scheduling, monitor VSync events, kernel context switches, what your process is blocked on.

I also annotated my compositor with Tracy Frame events for monitor VBlank cycles. I can then set a target FPS in Tracy and instantly see which frames were too slow! Both in the bar at the top, and in the main area highlighted in red.

lol a few days ago someone posted niri on the orange site and now it surpassed all my other projects by star count 🫠
aaaaaaaaahhhhhhhhhhh these two days were a grind but I somehow got monitor streaming working! with pipewire and dmabufs and dbus and screencast portal and everything! and it wooorkssssssssss woooooooooooooo
I just streamed for an hour from this and nothing crashed??

Dmabuf screencasting is crazy good. Here's a histogram of the screencasting overhead on my 2560×1600@165 screen—the median is 300 microseconds, and the worst across 12,669 frames was just below 1 ms. Most of that time is spent rendering the frame, perhaps something could even be further optimized in Smithay.

And yeah, if you look at the profiling timeline, I zoomed it in such a way that almost the entire width is taken by one frame, that is 6.05 ms long. Most of it is completely empty!

@YaLTeR one day I need to ask you how to make it work on my system again. With mutter tho :3
@alice hmm it doesn't? Maybe you're talking about hardware encoding? Because this is about getting frames from the compositor to OBS, not the subsequent encoding step :)
@YaLTeR I mean if you remember it slows down a lot when obs is just running and not recording anything
@YaLTeR for posterity, I was indeed wrong, it works now. Welp.
×
A few latency tests before release confirm that niri's still doing good (at least on idle; I don't have any repaint scheduling yet but on idle it doesn't matter). The compositors are pretty much within the noise threshold from each other. Except some sway fullscreen bug and Shell losing one frame somewhere.

Well, I'm happy to release the first stable version of niri, my scrollable-tiling compositor: https://github.com/YaLTeR/niri/releases/tag/v0.1.0

Very satisfied with the current state, even though there's plenty left to do. Took a lot of time and work but I've certainly learned a lot, and I'm glad to have contributed a bit to Smithay too!

#wayland #rust #smithay

Release v0.1.0 · YaLTeR/niri

Here it is. The first real release, after five months of work. Let's do a recap for the occasion. This is niri, a scrollable-tiling Wayland compositor inspired by PaperWM. Windows are tiled on an i...

GitHub

Before adding more animations into niri, I'm making a "visual tests" application. It shows a set of hardcoded scenarios which I can quickly go through and visually check that everything looks right.

It uses solid color rectangles as "windows", but otherwise this is the real niri layout code and real niri + Smithay rendering code, drawing to a GTK GL area.

For example, on the last test you can see that my offscreen code currently clips CSD shadows (during the open animation).

visual tests are such a lifesaver, so glad I stole that idea from osu!lazer

The window opening animation is now live as part of niri v0.1.2: https://github.com/YaLTeR/niri/releases/tag/v0.1.2

I'm really looking forward to more animations, but wow they sure do need a lot of care to get right in all the edge cases.

Also, I added a way to programmatically invoke compositor actions, and turns out that's quite useful for making video demos!

#wayland #rust #smithay

Release v0.1.2 · YaLTeR/niri

Thanks everyone for 1000 stars! 🥳 Niri is a scrollable-tiling Wayland compositor. Windows are arranged in columns on an infinite strip going to the right. Opening a new window never causes existing...

GitHub
For a bit of fun I added gradient borders to niri. One of the visual tests for it turned out a bit mesmerizing to look at

Tagged niri v0.1.3: https://github.com/YaLTeR/niri/releases/tag/v0.1.3

This one has much improved touchpad gestures with inertia, springs, rubberbanding and everything else I copied from libadwaita, my primary source for things that feel good  

Also thanks @alice for helping and giving feedback on the gestures and for giving a try to the touch support!

#wayland #rust #smithay

Release v0.1.3 · YaLTeR/niri

Niri is a scrollable-tiling Wayland compositor. Windows are arranged in columns on an infinite strip going to the right. Opening a new window never causes existing windows to resize. Here are the i...

GitHub
Just implemented something I've had in mind for a while: compositor-side blocking out of windows from screencasts! The compositor is the perfect place to do this since it can replace the window contents in the render tree, which will work fine with any kind of overlapping, transparency, etc. AND it will work with anything that records the screen through the portal, be it OBS or video meeting, or whatever.
There's actually an important edge case here: if you open the screenshot UI while recording the monitor, then the screenshot UI preview will show the window, and OBS, recording the screenshot UI preview, will hence also show the window. There are trade-offs here for how you want this to work; for now I put a big warning around the option, and added a stricter mode that blocks out the window from ANY screen capture (which means you can't screenshot it).
I think for the built-in screenshot UI this is solvable with one more layer of indirection (render the screenshot UI preview itself twice, once for screencasts, and once for the monitor). However, for third-party screenshot annotation tools, this will still be a problem.

Implemented this idea. It means rendering each monitor 3 times always for the screenshot but maybe it's fine? On this laptop 3 monitors × 3 renders takes 2 ms, and there's some unnecessary blocking I forgot to remove.

On the video, note how for me the screenshot UI has Secrets visible, but on the recording afterwards it's always blocked out.

I may be having too much fun recording a demo for the release notes

Amidst all the fires being put out, niri 0.1.4 which can block out windows from screencasts! https://github.com/YaLTeR/niri/releases/tag/v0.1.4

And also gamma control, focus follows mouse, warp mouse to focus, wheel and touchpad scroll bindings, xdp-gnome 46 support.

Also, every single config option is now documented on the wiki! Which took like an entire week of work (even though I was reusing a lot of my previously written docs in the config). Check it out here: https://github.com/YaLTeR/niri/wiki/Configuration:-Overview

#wayland #smithay #rust #niri

Release v0.1.4 · YaLTeR/niri

Before we begin: downgrade xz to v5.4. Done? Good, let's get to the release. Niri is a scrollable-tiling Wayland compositor. Windows are arranged in columns on an infinite strip going to the right....

GitHub
Today: horizontal column movement is now animated!

Took the whole yesterday and a bit of today, but I've got window closing animations working! These turned out to be tricky because they need storing a snapshot of the surface render tree to draw once the app is gone.

Some apps may start destroying their subsurfaces before the main surface, like alacritty with its sctk CSD, making it very easy to miss parts of the window in the snapshot, and therefore in the closing animation.

Also, windows closing to the left no longer shift the view!

#niri

..i can't even enjoy these properly because my brain already stopped noticing them since now things act *as they should* (and also the settings are as usual copied from gnome shell)
@YaLTeR Niri looks very good! Window managers don't really attract me but this one does!
@YaLTeR long way to go. keep it up! 

Definitely one of the most complex animations yet: window resizing.

Just the crossfade effect itself took a while to get working with all the window geometries and buffer offsets, and then there's the whole multiple window orchestration with Wayland's asynchronous nature. (I don't do animation transactions yet, that'll be a whole other level of complexity on top.)

Happy with the result though, and it's cool that it seamlessly works with block-out-from screencast.

#niri

@YaLTeR that is super duper smooth, holy cow. nice job!!
@nano looks even better at 144 Hz 
@YaLTeR i cant believe its real desktop :0
@su quite real and usable :)
@YaLTeR im gonna try it out on my laptop 
.config/niri · main · sharkler / sharkler dots · GitLab

GitLab.com

GitLab
@YaLTeR This would look 98% better with a fully transparent panel / without the pills behind the top bar items. Might require tweaking that particular wallpaper a bit though :)
@YaLTeR If apps unmap subsurfaces before the toplevel that'd a bug - or is it within a single synced commit?
@rmader why would it be a bug? Also, it's destroying the surfaces, there are no commits involved. All in one go; just that the subsurface destroy messages arrive first, so if you don't snapshot at that point, then by the time the toplevel surface is destroyed, there already is no subsurfaces to render.
@rmader fwiw in Mutter it looks fine, but I haven't looked deep into what exactly Mutter is doing to solve this.

@YaLTeR "Destroying a sub-surface takes effect immediately.", see https://wayland.freedesktop.org/docs/html/apa.html#protocol-spec-wl_subsurface

If a client wants to ensure the content gets destroyed in sync it shouldn't start with destroying a subsurface as compositors may schedule a frame directly after that step. Depending on the architecture, it would be good if the client unmapped (by attaching a NULL buffer) or destroyed the toplevel first (no need to wait for anything after either of these steps).

Appendix A. Wayland Protocol Specification

@rmader yeah, I see, that makes sense
wayland: fix CSD decorations glitch when closing by kchibisov · Pull Request #3625 · rust-windowing/winit

In rare cases destroying subsurfaces before the main surface could result in a frame where the window is still shown, but decorations got hidden, right before the window itself disappears. Tested...

GitHub
@YaLTeR nice. please make dialogs and popups float. they all open as new window. and one more thing it takes over thirty minutes to compile niri. if possible please provide precompiled niri bin.

@huilong

> please make dialogs and popups float

There's no floating layer yet, I have an issue at https://github.com/YaLTeR/niri/issues/122

> it takes over thirty minutes to compile niri

Uh oh, which system is that?

> please provide precompiled niri bin

Fedora COPR is pre-compiled, there's also an AUR niri-bin package. I can't really provide a distro-independent one.

Floating window layer · Issue #122 · YaLTeR/niri

I'm thinking always on top, in global coordinate space, similar to the mouse cursor.

GitHub
@YaLTeR im on #voidlinux . maybe because of 4gb ram.but it is much faster to build #Hyprland , #labwc, #SwayFX and #waybar etc..
@huilong 30 min must be a clean build? Recompiling after changes should be much faster
@YaLTeR you are right. clean built 0.1.2 and then 0.1.3.
@huilong what kind of CPU?
@YaLTeR AMD PRO A4-4350B R4 5 COMPUTE CORES 2C+3G
@YaLTeR I still have a todo to switch over and maybe now’s the right time! I’ll just learn to cope with having to move all my windows initially when I first launch or something
@YaLTeR just found this and it is a revelation. Fantastic, thank you. Finally a tiling system that makes sense on a small screen @thelinuxEXP
@YaLTeR this is pretty rad

always fan of window managers that have some different ways of doing things, and 'windows are offscreen but not on a different workspace' seems like an underused concept
@YaLTeR this looks pretty awesome! I’ve been struggling to understand how the desktop portal stuff works so will be sure to give the code a read too.
@vladimir_lu Thanks! Well, in case of xdg-desktop-portal-gnome for screencasting, which I'm using here, I essentially need to provide a few dbus interfaces that look like Mutter's or Shell's, since that's what xdp-gnome is poking. Other portal impls have different requirements, i.e. xdp-wlr will need some wlroots Wayland protocols.
@YaLTeR congrats Ivan! Quite an impressive piece of software you've created here.
@ju thank you and thanks for testing and giving feedback earlier!

@YaLTeR I might even switch to it completely eventually with all the niceties you are putting into this :D

It's great how easy I can switch between GNOME shell and niri.

@YaLTeR
In GNOME this could look something like this (see quick mock-up).
@Scott_Trakker yeah, well, PaperWM already does it in GNOME :)
@YaLTeR
Thanks!!
I just installed PaperWM and it almost works as I would like it to work.
Instead of multiple workspaces, I would like to have just one big horizontal workspace, and only one window should be shown on the screen at a time (unless explicitly grouped).
In PaperWM the windows are shown beneath each other in the overview mode. They should stay horizontal.
Is PaperWM still in active development? If so, I will open a bug report for above issues.
@Scott_Trakker yeah, Paper is in active development. Not by me though; I'm listed as a contributor but I only ever opened issues and gave feedback on some design discussions :)
@YaLTeR
And last: by scrolling over the top bar you should be able to scroll between the horizontal windows.
@YaLTeR why mutter and gnome-shell are separate? Aren't they like, useless without each other?
@a1ba gnome shell is mutter + some overhead, it's useful to see what raw mutter is as the "best possible" result for gnome shell. In this case there's clearly some bug in shell that adds a frame of latency.
@YaLTeR I see. I didn't thought it's possible to run mutter without shell. Last time I saw GNOME was like version 3.4 lol
@a1ba yeah, you can just run mutter on its own. It's very barebones though, intended mostly for testing