Skip to content

Commit 8071c59

Browse files
committed
docs: add pause_on_fullscreen to README and config guide
1 parent ee99873 commit 8071c59

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ yay -S gleditor-git
155155
- Pure C, single binary
156156
- GPU does the work, CPU chills
157157
- timerfd/signalfd — no busy loops
158+
- Auto-pauses when fullscreen windows cover wallpaper
158159
- Same code runs everywhere
159160

160161
## vs Others
@@ -168,6 +169,7 @@ yay -S gleditor-git
168169
| X11 |||||
169170
| Wayland |||||
170171
| Interactive |||||
172+
| Fullscreen pause |||||
171173

172174
**NeoWall = only Linux tool for live GPU shader wallpapers.**
173175

config/docs/CONFIG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,26 @@ transition_duration 500 # Smooth
184184
transition_duration 1000 # Slow
185185
```
186186

187+
### Performance Options
188+
189+
#### `pause_on_fullscreen` - Pause When Occluded
190+
191+
Automatically pause rendering when a fullscreen window covers the wallpaper:
192+
193+
```vibe
194+
pause_on_fullscreen true # Pause rendering (default)
195+
pause_on_fullscreen false # Keep rendering behind fullscreen apps
196+
```
197+
198+
Saves GPU/CPU when wallpaper isn't visible (e.g. fullscreen games, videos).
199+
200+
Works per-output — if only one monitor has a fullscreen window, the other monitors keep rendering.
201+
202+
**Compositor support:**
203+
- **Wayland**: Hyprland, Sway, River (via `wlr-foreign-toplevel-management`)
204+
- **X11**: Any EWMH-compliant window manager (i3, bspwm, dwm, etc.)
205+
- **KDE/GNOME**: Not yet supported (gracefully falls back to always rendering)
206+
187207
## Example Configurations
188208

189209
### Matrix Rain (Default)
@@ -404,6 +424,7 @@ Browse shaders: [shadertoy.com](https://www.shadertoy.com/)
404424
- Shaders: ~2% CPU at 60 FPS (GPU accelerated)
405425
- Static images: ~0% CPU (after load)
406426
- Image cycling: Brief spike during transition
427+
- Fullscreen apps: 0% CPU/GPU (auto-paused by default)
407428

408429
### Memory Usage
409430
- Base: ~10-20 MB

0 commit comments

Comments
 (0)