Skip to content
A lightweight compositor for X11 (previously a compton fork)
C C++ Shell Other
Branch: next
Clone or download
Pull request Compare This branch is 847 commits ahead of chjj:master.
yshui Merge pull request #279 from quequotion/patch-2
Create picom-dbus.desktop
Latest commit 37532e5 Dec 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci rename: replace "compton" in the codebase Oct 23, 2019
.github rename: replace "compton" in the codebase Oct 23, 2019
LICENSES More license stuff... Oct 4, 2018
bin rename: replace "compton" in the codebase Oct 23, 2019
dbus-examples Fix example dbus script after TYPE_ENUM change Aug 9, 2019
man backend: allow transparent windows to clip other windows Nov 30, 2019
media Added 48x48px raster of initial Compton logo Sep 18, 2015
meson rename: replace "compton" in the codebase Oct 23, 2019
src backend: allow transparent windows to clip other windows Nov 30, 2019
subprojects/test.h test.h: make sure clang-format doesn't reorder the headers Nov 11, 2019
tests win: delayed release of shadow image Nov 18, 2019
.clang-format file_watch: use kqueue on *BSD platforms Nov 11, 2019
.editorconfig Coding style change Feb 7, 2019
.gitignore Update .gitignore Aug 9, 2019
.gitmodules Vendor test.h Aug 4, 2019
CONTRIBUTORS Update CONTRIBUTORS Jul 19, 2019
COPYING rename: documentation changes Oct 23, 2019
Doxyfile Fix small misspellings Jan 28, 2019
LICENSE.spdx rename: documentation changes Oct 23, 2019
README.md Updated README Nov 4, 2019
README_orig.md update readme Apr 16, 2018
compton-default-fshader-win.glsl Feature: #183 custom window shader & #193 --no-fading-destroyed-argb May 16, 2014
compton-fake-transparency-fshader-win.glsl Feature: #183 custom window shader & #193 --no-fading-destroyed-argb May 16, 2014
compton.desktop added keywords to desktop entry Aug 19, 2019
desc.txt Misc: #49: Add CMake support Oct 3, 2012
meson.build rename: replace "compton" in the codebase Oct 23, 2019
meson_options.txt rename: replace "compton" in the codebase Oct 23, 2019
picom-dbus.desktop Create picom-dbus.desktop Dec 10, 2019
picom.desktop rename: replace "compton" in the codebase Oct 23, 2019
picom.sample.conf parameterize max brightness limit Nov 9, 2019

README.md

picom

This is a development branch, bugs to be expected

This is forked from the original Compton because it seems to have become unmaintained.

The current battle plan of this fork is to refactor it to make the code possible to maintain, so potential contributors won't be scared away when they take a look at the code.

We also try to fix bugs.

The original README can be found here

Call for testers

--experimental-backends

This flag enables the refactored/partially rewritten backends.

Currently, new backends feature better vsync with the xrender backend and improved input lag with the glx backend (for non-NVIDIA users). The performance should be on par with the old backends.

New backend features will only be implemented on the new backends from now on, and the old backends will eventually be phased out after the new backends stabilize.

To test the new backends, add the --experimental-backends flag to the command you use to run picom. This flag is not available from the configuration file.

To report issues with the new backends, please state explicitly you are using the new backends in your report.

Rename

Rationale

Since the inception of this fork, the existence of two compton repositories has caused some number of confusions. Mainly, people will report issues of this fork to the original compton, or report issues of the original compton here. Later, when distros started packaging this fork of compton, some wanted to differentiate the newer compton from the older version. They found themselves having no choice but to invent a name for this fork. This is less than ideal since this has the potential to cause more confusions among users.

Therefore, we decided to move this fork to a new name. Personally, I consider this more than justified since this version of compton has gone through significant changes since it was forked.

The name

The criteria for a good name were

  1. Being short, so it's easy to remember.
  2. Pronounceability, again, helps memorability
  3. Searchability, so when people search the name, it's easy for them to find this repository.

Of course, choosing a name is never easy, and there is no apparent way to objectively evaluate the names. Yet, we have to solve the aforementioned problems as soon as possible.

In the end, we picked picom (a portmanteau of pico and composite) as our new name. This name might not be perfect, but is what we will move forward with unless there's a compelling reason not to.

Migration

Following the deprecation process, migration to the new name will be broken into 3 steps:

  1. All mentions of compton will be updated to picom in the code base. compton will still be installed, but only as a symlink to picom. When picom is launched via the symlink, a warning message is printed, alerting the user to migrate. Similarly, the old configuration file names and dbus interface names will still be accepted but warned.
  2. 3 major releases after step 1, the warning messages will be prompted to error messages and picom will not start when launched via the symlink.
  3. 3 major releases after step 2, the symlink will be removed.

The dbus interface and service names are unchanged, so no migration needed for that.

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
  • pixman
  • libdbus (optional, disable with the -Ddbus=false meson configure flag)
  • libconfig (optional, disable with the -Dconfig_file=false meson configure flag)
  • libxdg-basedir (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 list of 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 libpixman-1-dev libdbus-1-dev libconfig-dev libxdg-basedir-dev libgl1-mesa-dev  libpcre2-dev  libevdev-dev uthash-dev libev-dev

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/include" 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

You can’t perform that action at this time.