Animation: part 2

[yshui]

What

This PR adds a scripting system that supports simple easing curves, and simple arithmetic. And a animation system based on scripts.

This PR also adds a shim to support old fading configs on top of this new animation system.

Why

Originally my plan was to implement animations on top of just easing curves, but I slowly realized that this is not flexible enough. Suppose I want to have windows fly out when closed, how do I define the end point of the animation curve? It's not straightforward, because to move the window completely off-screen, the end Y coordinate will depend on the height of the window.

Sure, I can have some predefined values, like "upwards-off-screen", to mean a Y coordinate that will move the window off the top edge of the screen. But it's impossible to anticipate what kind of animation users might want. So I thought, we might as well to go for maximal customizability.

So for this example, you would write a script like this:

animations = ({
    triggers = ["close", "hide"];
    offset-y = {
        timing = "1s linear";
        start = 0;
        end = "-window-height - window-y";
    };
    opacity = 1; # This is needed because when a window is closed, it's opacity automatically becomes 0
})

Showcase

a.mp4

TODO

1. Presets

Although you can define all kinds of animations with this system, I do understand not everybody would want to learn how to use this, if all they want is just some simple animations. The plan is to add a "preset" system, so users can config simple animations, like "fly-out", "fade-out", etc., without needing to write these scripts.

2. Bugs

There are still many bugs to be crushed here.

3. Documentation

We need to explain how the script works. Explain what's the syntax for curves, for simple arithmetic expressions. And warn users about common pitfall (e.g. you need to explicit set opacity = 1;, otherwise your window disappears).

[codecov]

Codecov Report

Attention: Patch coverage is 79.22078% with 272 lines in your changes are missing coverage. Please review.

Project coverage is 44.19%. Comparing base (02a7c71) to head (6624f09).

❗ Current head 6624f09 differs from pull request most recent head 91ffbb4

Please upload reports for the commit 91ffbb4 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #1253      +/-   ##
==========================================
+ Coverage   41.03%   44.19%   +3.15%     
==========================================
  Files          59       60       +1     
  Lines       12277    13256     +979     
==========================================
+ Hits         5038     5858     +820     
- Misses       7239     7398     +159     

Files	Coverage Δ
src/common.h	44.82% <ø> (ø)
src/config.c	51.56% <ø> (ø)
src/config.h	23.52% <ø> (ø)
src/renderer/layout.c	97.97% <100.00%> (+0.95%)	⬆️
src/utils.h	32.07% <100.00%> (+2.66%)	⬆️
src/win.h	97.61% <ø> (-2.39%)	⬇️
src/dbus.c	25.12% <0.00%> (ø)
src/event.c	69.77% <83.33%> (-0.32%)	⬇️
src/renderer/damage.c	89.71% <71.42%> (-0.69%)	⬇️
src/backend/gl/gl_common.h	5.35% <0.00%> (ø)
... and 14 more

... and 7 files with indirect coverage changes

[yshui]

Alright, let's merge this!

[DarioDarko]

[ 20.05.2024 00:08:40.431 c2_parse_target WARN ] Type specifier is deprecated. Type "a" specified on target "_NET_WM_STATE" will be ignored, you can remove it.
[ 20.05.2024 00:08:40.431 c2_parse_target WARN ] Format specifier is deprecated. Format "32" specified on target "_NET_WM_STATE" will be ignored, you can remove it.
[ 20.05.2024 00:08:40.431 c2_parse_target WARN ] Type specifier is deprecated. Type "c" specified on target "_GTK_FRAME_EXTENTS" will be ignored, you can remove it.
BUG_ON: "err != NULL"
zsh: IOT instruction (core dumped) ./picom

im not sure if i did something wrong, i dont compile usually. this is the current next branch

this was my approach of compiling

git clone https://github.com/yshui/picom --branch animation-part2
cd picom
meson setup --buildtype=release build
ninja -C build
cd build
cd src
./picom

i use endeavourOS and openbox

thanks for your work btw <3 looking forward to the animations

[yshui]

@DarioDarko can you provide your config file?

[enderprism]

i have this issue as well. commenting out the animation sections doesn't solve it.

System info

• OS: EndeavourOS
• Picom version: latest picom-git from the Chaotic AUR
• WM: i3-wm
• CPU: 12th Gen Intel(R) Core(TM) i5-12450H (12) @ 4,40 GHz
• GPU: NVIDIA GeForce RTX 4050 Laptop

Picom config

picom.conf

[yshui]

@enderprism hmm, i can't reproduce it. do you mind open an issue? please include a --log-level=trace log if you do.

@DarioDarko can you do the same as well? thanks.

[DarioDarko]

i opened the issue

#1263

FIXED :) works now!