scratchpads: improve and optimize the show flow

Author: fdev31

RELEASE_NOTES.md

@@ -1,6 +1,4 @@
 - avoid logging when no flag is passed (only most important logs remains, use `--debug` to get the logs)
-- `scratchpads`: Fix initial display
-    - add `show_delay` option to control the pre-show positioning delay
-    - set to `0` to have no forced delay on first display (but leads to unpredictable animations)
-    - needs to match your animations speed! Increase/decrease accordingly (default = 0.3s)
+- `scratchpads`: Fix initial display and remove some old workaround
+- fix some async operations usage
 - misc fixes and improvements

pyprland/plugins/scratchpads/__init__.py

@@ -158,6 +158,11 @@ async def on_reload(self, reason: ReloadReason = ReloadReason.RELOAD) -> None:
                 if not is_lazy:
                     scratches_to_spawn.add(name)
 
+        # Register a noanim windowrule for the pypr_noanim tag.
+        # This is used to skip Hyprland's window animation during offscreen pre-positioning
+        # so that the show transition is instant (no need for show_delay).
+        await self.backend.execute("windowrule no_anim on, match:tag pypr_noanim", base_command="keyword")
+
         for name in scratches_to_spawn:
             if await self.ensure_alive(name):
                 scratch = self.scratches.get(name)

pyprland/plugins/scratchpads/objects.py

@@ -165,7 +165,6 @@ async def initialize(self, ex: "_scratchpads_extension_m.Extension") -> None:
                 raise RuntimeError(msg)
             self.client_info = m_client
         await ex.backend.execute(f"movetoworkspacesilent {mk_scratch_name(self.uid)},address:{self.full_address}")
-        await asyncio.sleep(0.05)  # workaround
         self.meta.initialized = True
 
     async def is_alive(self) -> bool:

pyprland/plugins/scratchpads/schema.py

@@ -65,7 +65,6 @@ def _validate_animation(value: str) -> list[str]:
     ConfigField("restore_excluded", bool, default=False, description="Restore excluded on hide", category="behavior"),
     ConfigField("preserve_aspect", bool, default=False, description="Keep size/position across shows", category="behavior"),
     ConfigField("hide_delay", float, default=0.0, description="Delay before hide animation", category="behavior"),
-    ConfigField("show_delay", float, default=0.3, description="Delay before show animation on first display", category="behavior"),
     ConfigField("force_monitor", str, default="", description="Always show on specific monitor", category="behavior"),
     ConfigField("alt_toggle", bool, default=False, description="Alternative toggle for multi-monitor", category="behavior"),
     ConfigField(

pyprland/plugins/scratchpads/transitions.py

@@ -168,18 +168,24 @@ async def _show_transition(self, scratch: Scratch, monitor: MonitorInfo, was_ali
         await self._handle_multiwindow(scratch, clients)
 
         # FIX: initial animation
-        if needs_offscreen_preposition:
-            await self._update_infos(scratch, clients)
-
-            if scratch.client_info is not None and "size" in scratch.client_info:
-                off_x, off_y = Placement.get_offscreen(
-                    animation_type,
-                    monitor,
-                    scratch.client_info,
-                    scratch.conf.get_int("margin"),
-                )
-                await self.backend.execute(f"movewindowpixel exact {off_x} {off_y},address:{scratch.full_address}")
-                await asyncio.sleep(scratch.conf.get_float("show_delay"))
+        # Tag the window with pypr_noanim to disable Hyprland's animation
+        # during the offscreen pre-positioning move, then untag so the real
+        # slide-in animation plays normally.
+        if needs_offscreen_preposition and scratch.client_info is not None and "size" in scratch.client_info:
+            off_x, off_y = Placement.get_offscreen(
+                animation_type,
+                monitor,
+                scratch.client_info,
+                scratch.conf.get_int("margin"),
+            )
+            await self.backend.execute(
+                [
+                    f"tagwindow +pypr_noanim address:{scratch.full_address}",
+                    f"movewindowpixel exact {off_x} {off_y},address:{scratch.full_address}",
+                ]
+            )
+            await asyncio.sleep(0.001)  # NOTE: let some time to process
+            await self.backend.execute(f"tagwindow -pypr_noanim address:{scratch.full_address}")
 
         # move
         move_commands: list[str] = []

site/scratchpads.md

@@ -84,11 +84,13 @@ Check your window's class with: `hyprctl clients | grep class`
 
 Type of animation to use:
 
-- `null` / `""` (no animation)
-- `fromTop` (stays close to upper screen border)
-- `fromBottom` (stays close to lower screen border)
-- `fromLeft` (stays close to left screen border)
-- `fromRight` (stays close to right screen border)
+- `fromTop` (default) stays close to upper screen border
+- `fromBottom` stays close to lower screen border
+- `fromLeft` stays close to left screen border
+- `fromRight` stays close to right screen border
+- `null` / `""` no sliding animation - also disables positioning relative to the border
+
+It is recommended to set [position](#config-position) when disabling this configuration option.
 
 ### `size` <ConfigBadges plugin="scratchpads" option="size" /> {#config-size}
 

site/scratchpads_advanced.md

@@ -7,7 +7,7 @@
 
 Advanced configuration options
 
-<PluginConfig plugin="scratchpads" linkPrefix="config-" :filter="['use', 'pinned', 'excludes', 'restore_excluded', 'unfocus', 'hysteresis', 'preserve_aspect', 'offset', 'hide_delay', 'show_delay', 'force_monitor', 'alt_toggle', 'allow_special_workspaces', 'smart_focus', 'close_on_hide', 'monitor']" />
+<PluginConfig plugin="scratchpads" linkPrefix="config-" :filter="['use', 'pinned', 'excludes', 'restore_excluded', 'unfocus', 'hysteresis', 'preserve_aspect', 'offset', 'hide_delay', 'force_monitor', 'alt_toggle', 'allow_special_workspaces', 'smart_focus', 'close_on_hide', 'monitor']" />
 
 ### `use` <ConfigBadges plugin="scratchpads" option="use" /> {#config-use}
 
@@ -78,13 +78,6 @@ Rule of thumb, if you have an animation with speed "7", as in:
 ```
 You can divide the value by two and round to the lowest value, here `3`, then divide by 10, leading to `hide_delay = 0.3`.
 
-### `show_delay` <ConfigBadges plugin="scratchpads" option="show_delay" /> {#config-show-delay}
-
-Delay (in seconds) to wait for the initial positioning animation to complete before showing the scratchpad.
-This only affects the first time a scratchpad is displayed (or after its window is respawned) and when it moves across monitors.
-Increase the value if the scratchpad appears to slide diagonally on first show; decrease it for faster response.
-Set to `0` to disable the delay entirely.
-
 ### `force_monitor` <ConfigBadges plugin="scratchpads" option="force_monitor" /> {#config-force-monitor}
 
 If set to some monitor name (eg: `"DP-1"`), it will always use this monitor to show the scratchpad.