Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
/ scenefx Public

A drop-in replacement for the wlroots scene API that allows wayland compositors to render surfaces with eye-candy effects

License

Notifications You must be signed in to change notification settings

wlrfx/scenefx

Open more actions menu

Repository files navigation

scenefx

wlroots is the de-facto library for building wayland compositors, and its scene api is a great stride in simplifying wayland compositor development. The problem with the scene api (for compositors looking for eye candy), however, is that it forces you to use the wlr renderer, which is powerful yet simple. SceneFX is a project that takes the scene api and replaces the wlr renderer with our own fx renderer, capable of rendering surfaces with eye-candy effects including blur, shadows, and rounded corners, while maintaining the benefits of simplicity gained from using the scene api.

Please note: while SceneFX is in use by SwayFX version 0.4, it is not yet ready for usage by other compositors. Please refer to the 1.0 milestone to track the remaining tasks for our stable 1.0 release

Compositors Using SceneFX

Plenty of popular wayland compositors are using SceneFX to render eyecandy, including:

Installation

Compiling From Source

Install dependencies:

  • meson *
  • wlroots
  • wayland
  • wayland-protocols *
  • EGL and GLESv2
  • libdrm
  • pixman

* Compile-time dep

Run these commands:

meson setup build/
ninja -C build/

Install like so:

sudo ninja -C build/ install

Troubleshooting

Using scenefx features breaks the compositor

This issue might be caused by compiling scenefx and wlroots with Clang compiler and thin LTO(-flto=thin) option enabled. Try to compile the libraries without LTO optimizations or with GCC compiler instead.


Join our Discord

About

A drop-in replacement for the wlroots scene API that allows wayland compositors to render surfaces with eye-candy effects

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 11

Morty Proxy This is a proxified and sanitized view of the page, visit original site.