A lightweight compositor for X11
Go to file
Yuxuan Shui 1d94af4140
backend: document my confusion
See e3e73d7fc1

The reason composing worked without using the mask image is because the
paint region already carves the relevant parts of shaped windows.

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2024-04-08 17:57:08 +01:00
.builds ci: build with --werror on freebsd and openbsd 2024-02-15 00:09:11 +03:00
.circleci ci: use meson setup instead of meson 2024-02-14 00:21:03 +03:00
.github Merge pull request #1194 from yshui/update-clang 2024-02-14 20:37:34 +03:00
LICENSES
bin
dbus-examples
man man: add manpage for picom-inspect 2024-02-20 16:04:10 +00:00
media
meson
src backend: document my confusion 2024-04-08 17:57:08 +01:00
subprojects/test.h test.h: import upstream updates 2024-02-15 13:58:29 +00:00
tests tests: add a repro for #1091 2024-02-19 01:15:53 +00:00
.clang-format
.clang-tidy chore: tweak .clang-tidy 2024-02-16 15:43:52 +00:00
.editorconfig build: add libepoxy 2024-02-10 20:35:24 +00:00
.gitignore
CHANGELOG.md Update CHANGELOG.md 2024-03-11 10:31:45 +00:00
CONTRIBUTORS update contributors list 2024-02-11 21:33:14 +03:00
COPYING
Doxyfile
History.md
LICENSE.spdx
README.md Update README.md and CHANGELOG.md 2024-02-11 02:07:07 +00:00
compton-default-fshader-win.glsl
compton-fake-transparency-fshader-win.glsl
compton.desktop
desc.txt
flake.lock flake: add a dev shell that has frame pointers 2024-04-08 09:42:51 +01:00
flake.nix flake: add a dev shell that has frame pointers 2024-04-08 09:42:51 +01:00
meson.build
meson_options.txt
picom-dbus.desktop
picom.desktop
picom.sample.conf picom.sample.conf: remove shadow-exclude's example 2024-02-29 14:55:35 +03:00

README.md

picom

circleci codecov chat on discord

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, or chat with other users on discord!

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-util
  • xcb-damage
  • xcb-dpms
  • xcb-xfixes
  • xcb-shape
  • xcb-renderutil
  • xcb-render
  • xcb-randr
  • xcb-composite
  • xcb-image
  • xcb-present
  • 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, libEGL, libepoxy (optional, disable with the -Dopengl=false meson configure flag)
  • libpcre2 (optional, disable with the -Dregex=false meson configure flag)
  • libev
  • uthash

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

libconfig-dev libdbus-1-dev libegl-dev libev-dev libgl-dev libepoxy-dev libpcre2-dev libpixman-1-dev libx11-xcb-dev libxcb1-dev libxcb-composite0-dev libxcb-damage0-dev libxcb-dpms0-dev libxcb-glx0-dev libxcb-image0-dev libxcb-present-dev libxcb-randr0-dev libxcb-render0-dev libxcb-render-util0-dev libxcb-shape0-dev libxcb-util-dev libxcb-xfixes0-dev libxext-dev meson ninja-build uthash-dev

On Fedora, the needed packages are

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

To build the documents, you need asciidoc

To build

$ meson setup --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 setup --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 setup --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

All contributions are welcome!

New features you think should be included in picom, a fix for a bug you found - please open a PR!

You can take a look at the Issues.

Contributions to the documents and wiki are also appreciated.

Even if you don't want to add anything to picom, you are still helping by compiling and running this branch, and report any issue you can find.

Become a Collaborator

Becoming a collaborator of picom requires significant time commitment. You are expected to reply to issue reports, reviewing PRs, and sometimes fix bugs or implement new feature. You won't be able to push to the main branch directly, and all you code still has to go through code review.

If this sounds good to you, feel free to contact me.

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.