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.
×
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

I have this monitor connected through HDMI, and if I enable VRR then it starts modesetting every frame (lol). Guessing some AMDGPU issue.

But today I finally found a DisplayPort → USB C dongle, and this way VRR works perfectly, yay! Even bumped the refresh rate from 144 Hz to 170 Hz, which this monitor supports only through DP.

Anyway, #niri has VRR now 

I also have smoother magic trackpad gestures now since it reports at 100 Hz, and before I had to deal with framerate aliasing. Too bad I don't use it much because mouse more convenient

Window movement across columns is now animated too!

These weren't complex per se, but very *finicky*. Spent quite a bit of time chasing down all the offsets and coordinates to add and subtract to avoid jumps, but it seems to all work well now!

#niri

All the animations, plus VRR, today in niri 0.1.5: https://github.com/YaLTeR/niri/releases/tag/v0.1.5

I also remade the demo video to showcase the animations and some of the newer features!

#niri #smithay #rust #wayland

Release v0.1.5 · 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. This time I de...

GitHub
@YaLTeR woah! this looks really nice and also satisfying to use. great job!!
@YaLTeR Just updated on my laptop with @EndeavourOS now
@YaLTeR this looks like a lot of fun to use. :)
@YaLTeR
..think about getting an extra touchpad for my desktop pc. 🤔
Could be cool!
@YaLTeR good to hear! Has proper XWayland support been baked in yet?
@etrigan63 you still need to use rootful, same as before
@YaLTeR it was cage, last time I tried.
@YaLTeR
What is this, an #hyprland style wm?
@dnkl

@deedend @dnkl niri is its own compositor in its own style. :)

I certainly look at, and consider, how Hyprland does certain things, just like I look at GNOME, sway and others. Then I make a decision that makes the most sense for niri.

@YaLTeR Im about to ask you for this! Because after getting window resize anim, moving windows looked flat. Great work #niri . Window resize animation is buttery smooth. 
@YaLTeR
Looks good. Niri might be what finally gets me to try wayland.
@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 :)
@tbernard hmm, the pill backgrounds give some weight to the area. Otherwise it looks even more like empty space that uncenters the windows
@YaLTeR Not sure, I think the bigger factor there is that the padding around the windows is so tight in comparison to the height of the top bar. Increasing the outer padding a bit might help with that.
@tbernard @YaLTeR Looks nice with Amber dark 
@tbernard @YaLTeR Well, besides the fullcolor icons 

@kramo @YaLTeR I'd not increase the top margin as much to balance it out a bit better, since it's adjacent to the top bar.

But yeah, otherwise this looks pretty good.

@tbernard There's no way to adjust the top margin specifically AFAIK but I may be wrong? @YaLTeR
@kramo @tbernard you can increase it with https://github.com/YaLTeR/niri/wiki/Configuration:-Layout#struts and decrease in the Waybar config
Configuration: Layout

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

GitHub
@YaLTeR @tbernard Ah, I didn't notice struts, thanks 
@YaLTeR Nice!! It would be really cool if Mutter did that.
@CleoMenezesJr but Mutter already does a crossfade on keyboard resize? I.e. Super+Left/Right/Up. Should be pretty similar to what I've got
@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