PolytreeDE/picom
1
0
Fork 0
mirror of https://github.com/yshui/picom.git synced 2024-11-18 13:55:36 -05:00
Code Releases Activity
A lightweight compositor for X11
279 commits 57 branches 63 tags 33 MiB
C 92.8%
Python 2.5%
CSS 2%
Shell 1.4%
Meson 0.8%
Other 0.4%
Find a file
Richard Grenville 8ffcf1c1e8 Feature: OpenGL backend 
- Add experimental OpenGL backend (--opengl). --blur-background is
  currently not possible with this backend, because I'm still trying to
  find a proper way to do blur with OpenGL. Flipping backend on-the-fly
  is really hard, so it isn't supported right now. No configuration file
  option exists to enable this, because it isn't stable enough.

- Add `opengl-swc` VSync method that uses SGI_swap_control to control
  buffer swap, with OpenGL backend. (#7)

- Fix a potential read-from-freed-memory issue in paint_all().

- Correctly reattach GLX context after fork.

- Dump error text in error(). Add GLX error code handling.

- Code clean-up.

- Known issues: Region operations take a lot of time in glx_render().
  I'm hesitating about what to do.
2013-03-15 23:16:23 +08:00
bin don't depend on bash, our script is POSIX anyway 2013-01-28 17:31:16 +01:00
dbus-examples Improvement: ARGB window matching & Enable track_focus with D-Bus 2013-03-10 18:45:54 +08:00
man Improvement: ARGB window matching & Enable track_focus with D-Bus 2013-03-10 18:45:54 +08:00
src Feature: OpenGL backend 2013-03-15 23:16:23 +08:00
.gitignore Feature: OpenGL backend 2013-03-15 23:16:23 +08:00
_CMakeLists.txt Merge branch 'master' into richardgv-dev 2012-11-14 18:46:26 +08:00
compton.sample.conf Bug fix #91: Using pkg-config to find drm.h & OpenGL changes 2013-03-01 12:41:16 +08:00
CPackConfig.cmake Bug fix: Window rendered incorrectly if has no border with -e 2012-11-06 11:37:29 +08:00
desc.txt Misc: #49: Add CMake support 2012-10-03 13:34:54 +08:00
Doxyfile Feature #51: Re-initialize when SIGUSR1 is received 2012-11-19 11:44:58 +08:00
LICENSE update readme and man page. 2012-10-22 07:50:18 -05:00
Makefile Feature: OpenGL backend 2013-03-15 23:16:23 +08:00
README.md Improvement: Change VSync mode with D-Bus & Makefile update & Misc 2013-01-31 22:56:54 +08:00

README.md

Compton

Compton is a compositor for X, and a fork of xcompmgr-dana.

I was frustrated by the low amount of standalone lightweight compositors. Compton was forked from Dana Jansens' fork of xcompmgr and refactored. I fixed whatever bug I found, and added features I wanted. Things seem stable, but don't quote me on it. I will most likely be actively working on this until I get the features I want. This is also a learning experience for me. That is, I'm partially doing this out of a desire to learn Xlib.

Changes from xcompmgr:

  • inactive window transparency / dimming
  • titlebar/frame transparency (specified with -e)
  • menu transparency (thanks to Dana)
  • shadows are now enabled for argb windows, e.g. terminals with transparency
  • removed serverside shadows (and simple compositing) to clean the code, the only option that remains is clientside shadows
  • configuration files (see the man page for more details)
  • colored shadows (--shadow-[red/green/blue])
  • a new fade system
  • VSync support (not always working)
  • Blur of background of transparent windows, window color inversion (bad in performance)
  • Some more options...

Fixes from the original xcompmgr:

  • fixed a segfault when opening certain window types
  • fixed a memory leak caused by not freeing up shadows (from the freedesktop repo)
  • fixed the conflict with chromium and similar windows
  • many more

Building

Dependencies:

B for build-time

R for runtime

  • libx11 (B,R)
  • libxcomposite (B,R)
  • libxdamage (B,R)
  • libxfixes (B,R)
  • libXext (B,R)
  • libxrender (B,R)
  • libXrandr (B,R)
  • pkg-config (B)
  • make (B)
  • xproto / x11proto (B)
  • sh (R)
  • xprop,xwininfo / x11-utils (R)
  • libpcre (B,R) (Can be disabled with NO_REGEX_PCRE at compile time)
  • libconfig (B,R) (Can be disabled with NO_LIBCONFIG at compile time)
  • libdrm (B) (Can be disabled with NO_VSYNC_DRM at compile time)
  • libGL (B,R) (Can be disabled with NO_VSYNC_OPENGL at compile time)
  • libdbus (B,R) (Can be disabled with NO_DBUS at compile time)
  • asciidoc (B)

How to build

To build, make sure you have the dependencies above:

# Make the main program
$ make
# Make the man pages
$ make docs
# Install
$ make install

(Compton does include a _CMakeLists.txt in the tree, but we haven't decided whether we should switch to CMake yet. The Makefile is fully usable right now.)

Known issues

  • VSync does not work too well. It's widely reported that tearing still happens on the top of the screen. I do not know how to fix the issue.

  • If --unredir-if-possible is enabled, when compton redirects/unredirects windows, the screen may flicker. Using --paint-on-overlay minimizes the problem from my observation, yet I do not know if there's a cure.

  • compton may not track focus correctly in all situations. The focus tracking code is experimental. --use-ewmh-active-win might be helpful.

  • Compton may give ugly shadow to windows with ARGB background if -z is enabled, because compton cannot determine their real shapes. One may have to disable shadows on those windows with window-type-specific settings in configuration file or --shadow-exclude.

  • The performance of blurring is terrible, probably because of a problem in the X Render implementation. Its behavior is driver-dependent: With nvidia-drivers it works but there are strange 1px lines remaining when you operate on windows (not sure if it's a bug in compton or in the driver); with nouveau it's utterly broken.

Usage

Please refer to the Asciidoc man pages (man/compton.1.asciidoc & man/compton-trans.1.asciidoc) for more details and examples.

Note a sample configuration file compton.sample.conf is included in the repository.

Support

  • Bug reports and feature requests should go to the "Issues" section above.

  • Our (semi?) official IRC channel is #compton on FreeNode.

  • Some information is available on the wiki, including (and presently, only includes) a FAQ.

License

Although compton has kind of taken on a life of its own, it was originally an xcompmgr fork. xcompmgr has gotten around. As far as I can tell, the lineage for this particular tree is something like:

  • Keith Packard (original author)
  • Matthew Hawn
  • ...
  • Dana Jansens
  • chjj and richardgv

Not counting the tens of people who forked it in between.

Compton is distributed under MIT license, as far as I (richardgv) know. See LICENSE for more info.