-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into wlr_scene_blur
- Loading branch information
Showing
9 changed files
with
215 additions
and
169 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,36 @@ | ||
| # 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](https://github.com/wlrfx/scenefx/milestone/2) to track the remaining tasks for our stable 1.0 release** | ||
|
|
||
| ## Installation | ||
| <a href="https://repology.org/project/scenefx/versions"><img src="https://repology.org/badge/vertical-allrepos/scenefx.svg"/></a> | ||
|
|
||
|
|
||
| ## Compiling From Source | ||
| Install dependencies: | ||
| * meson \* | ||
| * wlroots | ||
| * wayland | ||
| * wayland-protocols \* | ||
| * EGL and GLESv2 | ||
| * libdrm | ||
| * pixman | ||
|
|
||
| _\* Compile-time dep_ | ||
|
|
||
| Run these commands: | ||
| ```sh | ||
| meson setup build/ | ||
| ninja -C build/ | ||
| ``` | ||
|
|
||
| Install like so: | ||
| ```sh | ||
| sudo ninja -C build/ install | ||
| ``` | ||
|
|
||
|
|
||
| --- | ||
| [Join our Discord](https://discord.gg/qsSx397rkh) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,84 @@ | ||
| { | ||
| description = "scenefx development environment"; | ||
|
|
||
| inputs = { | ||
| flake-compat = { | ||
| url = "github:edolstra/flake-compat"; | ||
| flake = false; | ||
| }; | ||
|
|
||
| nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable"; | ||
| }; | ||
|
|
||
| outputs = { self, nixpkgs, flake-compat, ... }: | ||
| description = "Scenefx development environment"; | ||
| inputs.nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable"; | ||
| outputs = | ||
| { self, nixpkgs, ... }: | ||
| let | ||
| pkgsFor = system: | ||
| import nixpkgs { | ||
| inherit system; | ||
| overlays = [ ]; | ||
| }; | ||
|
|
||
| targetSystems = [ "aarch64-linux" "x86_64-linux" ]; | ||
| in { | ||
| devShells = nixpkgs.lib.genAttrs targetSystems (system: | ||
| let pkgs = pkgsFor system; | ||
| in { | ||
| default = pkgs.mkShell { | ||
| name = "scenefx-shell"; | ||
|
|
||
| inputsFrom = [ pkgs.wlroots_0_17 ]; | ||
| mkPackages = pkgs: { | ||
| scenefx = pkgs.callPackage ( | ||
| { wlroots_0_17, ... }: | ||
| pkgs.stdenv.mkDerivation { | ||
| pname = "scenefx"; | ||
| version = "0.1.0-git"; | ||
| src = ./.; | ||
| outputs = [ | ||
| "out" | ||
| "lib" | ||
| ]; | ||
|
|
||
| nativeBuildInputs = with pkgs; [ | ||
| cmake | ||
| pkg-config | ||
| meson | ||
| cmake | ||
| ninja | ||
| scdoc | ||
| pkg-config | ||
| hwdata | ||
| ]; | ||
|
|
||
| shellHook = with pkgs; ''( | ||
| mkdir -p "$PWD/subprojects" | ||
| cd "$PWD/subprojects" | ||
| cp -R --no-preserve=mode,ownership ${wlroots_0_17.src} wlroots | ||
| buildInputs = with pkgs; [ | ||
| libdrm | ||
| libxkbcommon | ||
| pixman | ||
| libGL # egl | ||
| mesa # gbm | ||
| wayland # wayland-server | ||
| wayland-protocols | ||
| wlroots_0_17 | ||
| ]; | ||
|
|
||
| meta = with pkgs.lib; { | ||
| description = "A drop-in replacement for the wlroots scene API that allows wayland compositors to render surfaces with eye-candy effects"; | ||
| homepage = "https://github.com/wlrfx/scenefx"; | ||
| license = licenses.mit; | ||
| platforms = platforms.linux; | ||
| }; | ||
| } | ||
| ) { }; | ||
| }; | ||
|
|
||
| targetSystems = [ | ||
| "aarch64-linux" | ||
| "x86_64-linux" | ||
| ]; | ||
| pkgsFor = system: import nixpkgs { inherit system; }; | ||
| forEachSystem = f: nixpkgs.lib.genAttrs targetSystems (system: f (pkgsFor system)); | ||
| in | ||
| { | ||
| overlays = rec { | ||
| default = insert; | ||
| override = _: prev: mkPackages prev; | ||
| insert = _: prev: mkPackages (pkgsFor prev.system); | ||
| }; | ||
|
|
||
| packages = forEachSystem ( | ||
| pkgs: (mkPackages pkgs) // { default = self.packages.${pkgs.system}.scenefx; } | ||
| ); | ||
|
|
||
| devShells = forEachSystem (pkgs: { | ||
| default = pkgs.mkShell { | ||
| name = "scenefx-shell"; | ||
| inputsFrom = [ | ||
| self.packages.${pkgs.system}.scenefx | ||
| pkgs.wlroots_0_17 | ||
| ]; | ||
| shellHook = '' | ||
| ( | ||
| # Copy the nix version of wlroots into the project | ||
| mkdir -p "$PWD/subprojects" && cd "$PWD/subprojects" | ||
| cp -R --no-preserve=mode,ownership ${pkgs.wlroots_0_17.src} wlroots | ||
| )''; | ||
| }; | ||
| }); | ||
| }; | ||
| }); | ||
|
|
||
| formatter = forEachSystem (pkgs: pkgs.nixfmt-rfc-style); | ||
| }; | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.