A lightweight compositor for X11
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Yuxuan Shui 5ac8b7fc56
backend: gl: use gaussian blur for shadow
1 week ago
.builds ci: freebsd: add missing dependency 2 years ago
.circleci Make experimental backends the new default 1 month ago
.github issue_template: suggest uploading OpenGL traces 1 month ago
LICENSES More license stuff... 4 years ago
bin picom-trans: Added SPDX-License-Identifier 1 year ago
dbus-examples Update inverter.sh 3 years ago
man Merge pull request #875 from yshui/legacy-backend 1 month ago
media Added 48x48px raster of initial Compton logo 7 years ago
meson Made meson/install.sh executable 6 months ago
src backend: gl: use gaussian blur for shadow 1 week ago
subprojects/test.h string_utils: add trim_both 2 months ago
tests Make experimental backends the new default 1 month ago
.clang-format file_watch: use kqueue on *BSD platforms 3 years ago
.clang-tidy clang-tidy: disable some noisy warnings 1 month ago
.editorconfig Coding style change 4 years ago
.gitignore gitignore: ignore language server indices 2 years ago
.gitmodules Vendor test.h 3 years ago
CONTRIBUTORS Update CONTRIBUTORS 8 months ago
COPYING rename: documentation changes 3 years ago
Doxyfile Fix small misspellings 4 years ago
History.md README: Move old historical info out of main README 6 months ago
LICENSE.spdx rename: documentation changes 3 years ago
README.md Make experimental backends the new default 1 month ago
compton-default-fshader-win.glsl Feature: #183 custom window shader & #193 --no-fading-destroyed-argb 8 years ago
compton-fake-transparency-fshader-win.glsl Feature: #183 custom window shader & #193 --no-fading-destroyed-argb 8 years ago
compton.desktop set .desktop files to NoDisplay=true 2 years ago
desc.txt Misc: #49: Add CMake support 10 years ago
meson.build meson.build: autostart picom 1 month ago
meson_options.txt meson: Allow building without compton compat. 2 years ago
picom-dbus.desktop set .desktop files to NoDisplay=true 2 years ago
picom.desktop meson.build: autostart picom 1 month ago
picom.sample.conf picom.sample.conf: add window-shader-fg and window-shader-fg-rule 1 month ago

README.md

picom

picom is a compositor for X, and a fork of Compton.

This is a development branch, bugs to be expected

You can leave your feedback or thoughts in the discussion tab.

Change Log

See Releases

Build

Dependencies

Assuming you already have all the usual building tools installed (e.g. gcc, python, meson, ninja, etc.), you still need:

  • libx11
  • libx11-xcb
  • libXext
  • xproto
  • xcb
  • xcb-damage
  • xcb-xfixes
  • xcb-shape
  • xcb-renderutil
  • xcb-render
  • xcb-randr
  • xcb-composite
  • xcb-image
  • xcb-present
  • xcb-xinerama
  • xcb-glx
  • pixman
  • libdbus (optional, disable with the -Ddbus=false meson configure flag)
  • libconfig (optional, disable with the -Dconfig_file=false meson configure flag)
  • libGL (optional, disable with the -Dopengl=false meson configure flag)
  • libpcre (optional, disable with the -Dregex=false meson configure flag)
  • libev
  • uthash

On Debian based distributions (e.g. Ubuntu), the needed packages are

libxext-dev libxcb1-dev libxcb-damage0-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-render-util0-dev libxcb-render0-dev libxcb-randr0-dev libxcb-composite0-dev libxcb-image0-dev libxcb-present-dev libxcb-xinerama0-dev libxcb-glx0-dev libpixman-1-dev libdbus-1-dev libconfig-dev libgl1-mesa-dev libpcre2-dev libpcre3-dev libevdev-dev uthash-dev libev-dev libx11-xcb-dev meson

On Fedora, the needed packages are

dbus-devel gcc git libconfig-devel libdrm-devel libev-devel libX11-devel libX11-xcb libXext-devel libxcb-devel mesa-libGL-devel meson pcre-devel pixman-devel uthash-devel xcb-util-image-devel xcb-util-renderutil-devel xorg-x11-proto-devel

To build the documents, you need asciidoc

To build

$ git submodule update --init --recursive
$ meson --buildtype=release . build
$ ninja -C build

Built binary can be found in build/src

If you have libraries and/or headers installed at non-default location (e.g. under /usr/local/), you might need to tell meson about them, since meson doesn't look for dependencies there by default.

You can do that by setting the CPPFLAGS and LDFLAGS environment variables when running meson. Like this:

$ LDFLAGS="-L/path/to/libraries" CPPFLAGS="-I/path/to/headers" meson --buildtype=release . build

As an example, on FreeBSD, you might have to run meson with:

$ LDFLAGS="-L/usr/local/lib" CPPFLAGS="-I/usr/local/include" meson --buildtype=release . build
$ ninja -C build

To install

$ ninja -C build install

Default install prefix is /usr/local, you can change it with meson configure -Dprefix=<path> build

How to Contribute

Code

You can look at the Projects page, and see if there is anything that interests you. Or you can take a look at the Issues.

Non-code

Even if you don't want to contribute code, you can still contribute by compiling and running this branch, and report any issue you can find.

Contributions to the documents and wiki will also be appreciated.

Contributors

See CONTRIBUTORS

The README for the original Compton project can be found here.

Licensing

picom is free software, made available under the MIT and MPL-2.0 software licenses. See the individual source files for details.