Package:Radeon Video Drivers

Compton

   Tip

We welcome improvements to this page. To edit this page, Create a Funtoo account. Then log in and then click here to edit this page. See our editing guidelines to becoming a wiki-editing pro.

History and background

Compton was originally created as a fork of Dana Jansen's fork of Xcompmgr. It was refactored and bugs were fixed as it grew into a standalone project. Today it has many improvements and unique features when compared with other lightweight compositors such as Xcompmgr. Here are some of them:

• OpenGL backend
• Inactive window transparency
• Create your own blur kernel and use it to blur unopaque window backgrounds
• Custom-colored window drop shadows

Installation

To install compton, just emerge it:

root # emerge -av compton

Configuration

Creating a custom blur kernel

The version of compton in the Funtoo repositories comes with another application called compton-convgen. compton-convgen allows you to generate custom blurs for the backgrounds of transparent window borders, menus, etc. compton-convgen takes the following switches:

• -f: This option allows you to changes factors such as the sigma (standard deviation) of the blur kernel. A sigma of three to five looks nice and generates blurs similar to those seen in Windows 7 Aero and in the Ubuntu Unity launcher. To set the sigma value, enter something like: -f sigma=3
• --dump-compton: If you add this switch, compton-convgen will format the output in a way that can be used with compton. This is recommended.
• type: The type of blur kernel to use. Options include box and gaussian.
• width: The width of the blur kernel. As mentioned earlier, if you want an appearance like that of Windows Aero or Ubuntu Unity, a sigma of three to five accompanied by a gaussian with a width and height of 13 does the trick.
• height: Not required if you enter height (so long as you want width and height to be equivalent).

   Note

The height and width parameters must be odd-numbered.

To build a blur (convolution) kernel of type gaussian with a sigma of three and a height of 13, run the following:

user $ compton-convgen -f sigma=3 --dump-compton gaussian 13

This should output some long string of values that begins with:

13,13,0.018316,0.033746,0.055638,0.082085,0.108368,0.128022,0.135335,0.128022,0.108368,0.082085,0.055638,0.033746,0.018316,0.033746,0.062177,0.102512,0.151240,0.199666,0.235877,0.249352,0.235877,0.199666,0.151240,0.102512,0.062177,

Testing different blur kernels

Instead of somewhat tediously copying the output of compton-convgen into the .config/compton.conf (see below for more info), you can easily test the blur kernel you have generated by running the following:

user $ compton --backend=glx --blur-background-frame --frame-opacity=0.5 --blur-kern=`compton-convgen -f sigma=<your sigma preference> --dump-compton gaussian <kernel size>`

   Note

The ` is not the apostrophe (') rather, it is found in the upper left of your keyboard on the ~ key (assuming that you have an english layout on your keyboard).

Applying the custom blur kernel to compton

Now that we have generated our own custom blur kernel, we can add it to our .config/compton.conf so that our transparent windows have blurred backgrounds. To do this, create a line of text in your compton.conf that says:

   ~/.config/compton.conf

blur-kern = "

Then, copy the output of compton-convgen (minus the trailing comma at the end) to the right side of this line in your .config/compton.conf. After you have copied it over, go back into your compton.conf and add a quote and semicolon to the end of the blur-kern entry. For example:

   ~/.config/compton.conf

blur-kern = "a bunch of numbers and commas that you have pasted in.........";

Now that the blur-kern is in our compton.conf, we can test it out. Go into your compton.conf again and add the following lines to make window borders transparent:

   ~/.config/compton.conf

blur-kern = "a bunch of numbers and commas that you have pasted in.........";
frame-opacity = 0.50;
blur-background = true;

After adding these lines, try launching compton. If you see that the borders of windows are now transparent and blurred, congratulations! If the borders are transparent, but not blurred, check that you entered the lines correctly and then relaunch compton. If that does not work, try adding the line backend = "glx"; to your compton.conf. If, after relaunching compton, this does not fix the issue, you may need to look into if your graphics drivers support such features.

Blur the background of only certain windows

If you only want to blur the background of certain windows, say, Conky, Tint2, and URxvt, and not blur the background of all other windows on the desktop, you can do that. First, find the class of the window by installing and running the xprop utility. In a terminal, type

user $ xprop | grep WM_CLASS

and then click on a window that you want to find details about. The line that is printed in the console tells you the class of the window you have selected. Now that we know the WM_CLASS of the different windows that we want transparent, we can configure compton to only blur the backgrounds of these windows. Open your .config/compton.conf and add the following:

   ~/.config/compton.conf

...
blur-background-exclude = "!(class_g = 'First WM_CLASS you want to have a transparent background' || 'Second WM_CLASS' || 'Third WM_CLASS')";
...

   Note

You can add more than three classes you want to blur backgrounds on, or you can add only one. Also, you can identify windows using means of ID other than WM_CLASS. Check out https://github.com/chjj/compton/blob/master/man/compton.1.asciidoc to learn more about this. Read the text below Format of Conditions, in particular.

Drawing custom shadows

Compton supports casting drop shadows on windows. To enable the default shadows on compton, you can either run it with the -C flag, or you can add the following to your compton.conf:

   ~/.config/compton.conf

enable-shadows = true;

Some of compton's other settings related to shadows include:

• --no-dnd-shadow: When set to true, Compton will not draw shadows on drag and drop windows.
• --no-dock-shadow: When true, compton will not draw shadows on toolbars and docks.
• --shadow-radius: Takes an integer value. This option, coupled with the --shadow-{x,y}-offset options allows you to change how your shadows are centered / sized around windows.
• --shadow-x-offset: This setting allows you to configure how much the shadow will be shifted to the left or the right. If the value is negative, the shadow will be on the left, if the value is positive, the shadow will be shifted to the right.
• --shadow-y-offset: Similar in function to the --shadow-x-offset switch, except that it controls the vertical shifting of the shadow. Negative values lead to a shadow cast below a window, while positive values lead to a shadow cast above a window.
• --shadow-opacity: A value between 0 and 1 that controls how easy it is to "see through" shadows cast by compton.
• --clear-shadow: If you were interested in the transparent and blurred windows above, this option is very useful for you. If this option is set to true, compton will try to remove shadows behind transparent windows.

As always, choose the options that you are interested in, add them to your compton.conf, relaunch compton, and see how things look.

Troubleshooting

=== Compton with backend=glx does not work well with ati-drivers If you are having strange rendering issues on compton with backend=glx and x11-drivers/ati-drivers, consider adding the following two lines to your compton.conf:

   ~/.config/compton.conf

vsync = "opengl-swc";
paint-on-overlay = true;
....