Difference between pages "Welcome" and "Package:Compton"

(Difference between pages)
 
(Added a troubleshooting section)
 
Line 1: Line 1:
<div class="container" style="font-family: Open Sans; font-size: 14px; line-height: 20px;"><div class="row"><div class="col-xs-12 col-md-8 col-lg-8">
+
{{Ebuild
{{Slideshow}}
+
|Summary=A compositor for X.
Want to submit a screenshot? [http://forums.funtoo.org/index.php?/topic/180-screenshots/ See here.]
+
|CatPkg=x11-misc
</div><div class="col-xs-12 col-md-4 col-lg-4">
+
|Maintainer=
'''Funtoo Linux''' is a Linux-based operating system that is a variant of [http://www.gentoo.org Gentoo Linux], led by [[User:Drobbins|Daniel Robbins]], the creator and former Chief Architect of [http://en.wikipedia.org/wiki/Gentoo_Linux Gentoo Linux], who serves as benevolent dictator for life (BDFL) of the project. You are welcome to assist us in developing Funtoo Linux. Goals include developing production-ready technology, innovating and improving reliability and maintainability of the software, and most importantly, creating a fun, user-centric community for all.
+
|Homepage=https://www.github.com/chjj/compton/
 +
}}
 +
== 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
  
<div class="bs-callout bs-callout-warning">
+
== Installation ==
[[Support Funtoo]] to help us grow! '''Donate $15 per month and get a free [[Funtoo Hosting|Funtoo Virtual Container]].'''
+
To install compton, just emerge it:
</div>
+
<console>
 +
###i## emerge -av compton
 +
</console>
  
=== News ===
+
== Configuration ==
{{NewsList|1}}
+
=== Creating a custom blur kernel ===
[[News|View More News...]]
+
The version of compton in the Funtoo repositories comes with another application called <code>compton-convgen</code>. <code>compton-convgen</code> allows you to generate custom blurs for the backgrounds of transparent window borders, menus, etc.  
</div>
+
<code>compton-convgen</code> takes the following switches:
</div><div class="row">
+
* <code>-f</code>: 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: <code>-f sigma=3</code>
<div class="col-xs-12 col-md-4 col-lg-4">
+
* <code>--dump-compton</code>: If you add this switch, <code>compton-convgen</code> will format the output in a way that can be used with compton. This is recommended.
=== Resources ===
+
* <code>type</code>: The type of blur kernel to use. Options include box and gaussian.
__NOTOC__
+
* <code>width</code>: 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.
'''View the [[Funtoo Linux FAQ]] for answers to common questions.'''
+
* <code>height</code>: Not required if you enter height (so long as you want width and height to be equivalent).
 +
{{fancynote|The <code>height</code> and <code>width</code> parameters must be odd-numbered.}}
  
{{#ask: [[Category:People]] [[Gravatar MD5::+]]
+
To build a blur (convolution) kernel of type gaussian with a sigma of three and a height of 13, run the following:
| limit=22
+
<console>
| order=random
+
$##i## compton-convgen -f sigma=3 --dump-compton gaussian 13
| format=template
+
</console>
| template=GravatarDisplay
+
 
| link=none
+
This should output some long string of values that begins with:
| searchlabel=
+
<console>
 +
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,
 +
</console>
 +
==== Testing different blur kernels ====
 +
Instead of somewhat tediously copying the output of <code>compton-convgen</code> into the <code>.config/compton.conf</code> (see below for more info), you can easily test the blur kernel you have generated by running the following:
 +
<console>
 +
$##i## compton --backend=glx --blur-background-frame --frame-opacity=0.5 --blur-kern=`compton-convgen -f sigma=<your sigma preference> --dump-compton gaussian <kernel size>`
 +
</console>
 +
{{note|The <code>`</code> is not the apostrophe (<code>'</code>) rather, it is found in the upper left of your keyboard on the <code>~</code> 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 <code>.config/compton.conf</code> so that our transparent windows have blurred backgrounds. To do this, create a line of text in your compton.conf that says:
 +
{{file|name=~/.config/compton.conf|desc=|body=
 +
blur-kern = "
 
}}
 
}}
 +
Then, copy the output of <code>compton-convgen</code> (minus the trailing comma at the end) to the right side of this line in your <code>.config/compton.conf</code>. After you have copied it over, go back into your <code>compton.conf</code> and add a quote and semicolon to the end of the <code>blur-kern</code> entry. For example:
 +
{{file|name=~/.config/compton.conf|desc=|body=
 +
blur-kern = "a bunch of numbers and commas that you have pasted in.........";
 +
}}
 +
Now that the blur-kern is in our <code>compton.conf</code>, we can test it out. Go into your <code>compton.conf</code> again and add the following lines to make window borders transparent:
 +
{{file|name=~/.config/compton.conf|desc=|body=
 +
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 <code>backend = "glx";</code> to your <code>compton.conf</code>. If, after relaunching compton, this does not fix the issue, you may need to look into if your graphics drivers support such features.
  
Join us - {{CreateAccount}}, and then add yourself to our [[Usermap]]!
+
==== 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 <code>xprop</code> utility. In a terminal, type
 +
<console>
 +
$##i## xprop | grep WM_CLASS
 +
</console>
 +
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 <code>WM_CLASS</code> of the different windows that we want transparent, we can configure compton to only blur the backgrounds of these windows. Open your <code>.config/compton.conf</code> and add the following:
 +
{{file|name=~/.config/compton.conf|desc=|body=
 +
...
 +
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 <code>WM_CLASS</code>. 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.}}
  
'''Our resources:''' -- also see the <code>Go</code> menu:
+
=== Drawing custom shadows ===
* '''{{CreateAccount}}''' ([[Funtoo Authentication FAQ|Auth FAQ]])
+
Compton supports casting drop shadows on windows. To enable the default shadows on compton, you can either run it with the <code>-C</code> flag, or you can add the following to your <code>compton.conf</code>:
* '''[http://forums.funtoo.org forums.funtoo.org]''' - our new forums!
+
{{file|name=~/.config/compton.conf|desc=|body=
* '''[http://bugs.funtoo.org bugs.funtoo.org]''', our bug tracker ([[Reporting Bugs|Instructions]]).
+
enable-shadows = true;
* [http://larrythecow.org larrythecow.org], Gentoo blog service.
+
}}
* [http://kernel-seeds.org kernel-seeds.org], kernel build help.
+
Some of compton's other settings related to shadows include:
* [http://git.funtoo.org git.funtoo.org], our cgit repository browser.
+
* <code>--no-dnd-shadow</code>: When set to true, Compton will not draw shadows on drag and drop windows.
* '''[[Support Funtoo]]''' to help our project grow.
+
* <code>--no-dock-shadow</code>: When true, compton will not draw shadows on toolbars and docks.  
* '''[[Funtoo Hosting|Get a Funtoo Virtual Container]]'''.
+
* <code>--shadow-radius</code>: Takes an integer value. This option, coupled with the <code>--shadow-{x,y}-offset</code> options allows you to change how your shadows are centered / sized around windows.  
 +
* <code>--shadow-x-offset</code>: 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.  
 +
* <code>--shadow-y-offset</code>: Similar in function to the <code>--shadow-x-offset</code> 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.
 +
* <code>--shadow-opacity</code>: A value between 0 and 1 that controls how easy it is to "see through" shadows cast by compton.
 +
* <code>--clear-shadow</code>: 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 <code>compton.conf</code>, relaunch compton, and see how things look.
  
'''Ebuild pages recently updated:''' {{#ask: [[Category:Ebuilds]]
+
== Troubleshooting ==
| order=descending
+
=== Compton with <code>backend=glx</code> does not work well with <code>ati-drivers</code>
| sort=Modification date
+
If you are having strange rendering issues on compton with <code>backend=glx</code> and <code>x11-drivers/ati-drivers</code>, consider adding the following two lines to your <code>compton.conf</code>:
| format=list
+
{{file|name=~/.config/compton.conf|desc= |body=
| limit=10
+
vsync = "opengl-swc";
| searchlabel=more...
+
paint-on-overlay = true;
 +
....
 
}}
 
}}
</div><div class="col-sm-12 col-xs-12 col-md-4 col-lg-4">
+
[[Category:Desktop]]
=== Getting Started ===
+
{{EbuildFooter}}
 
+
We encourage you to '''[[Funtoo Linux Installation|install Funtoo Linux]]''', and get involved in our user community. Get to know fellow Funtoo Linux users on our '''[http://forums.funtoo.org forums]'''. If you have any improvements or find any bugs in Funtoo Linux, you are strongly encouraged to report them on our '''[http://bugs.funtoo.org bug tracker]'''. We take all bugs seriously, and all work performed on Funtoo Linux is tracked on our bug tracker, for purposes of transparency.
+
 
+
Funtoo Linux has a very active [http://en.wikipedia.org/wiki/IRC IRC] community on Freenode, in the <code>#funtoo</code> channel, and you are encouraged to hang out online with us.
+
 
+
=== Expand the wiki! ===
+
 
+
The [[:Help:Funtoo_Editing_Guidelines | How to 'wiki']] will help get you started on wiki editing. Have a look at [[Requested-Documents]] and [[:Category:Needs_Updates | pages that need to be updated.]]  
+
 
+
See [[:Category:Ebuilds|Ebuilds]] for a list of all ebuild pages, and [[Adding an Ebuild to the Wiki]] for information on how to add one.
+
 
+
</div><div class="col-sm-12 col-xs-12 col-md-4 col-lg-4">
+
=== Distinctives ===
+
 
+
'''Funtoo Linux  is optimized for your CPU, whether Intel Core i7 or AMD FX or A-Series APU. We offer fully optimized installation images. [[Subarches|Pick the right one for your CPU]] to get the most out of your hardware.'''
+
 
+
After install, Funtoo Linux packages are installed from source code, automatically, thanks to the [http://en.wikipedia.org/wiki/Portage_(software) Portage ports system], inspired by the FreeBSD ports system, but written in Python and with full advanced package management functionality. Funtoo Linux is a meta-distribution, which means it is built (fully automatically) with the functionality and optimizations that ''you'' want, not what some distro maintainer thought was best for you.
+
 
+
We use [http://en.wikipedia.org/wiki/Git_(software) Git] for all our development, and we also use Git to deliver our ports tree to you.
+
 
+
In contrast to Gentoo Linux, we offer a number of innovations, including our extensive use of git, [[Funtoo 1.0 Profile|our profile system]], [[Package:Boot-Update|boot-update]] boot management tool, our incredibly flexible [[Funtoo Linux Networking|template-based networking scripts]], [[Metro Quick Start Tutorial|Metro]] distribution build system, support of Debian, RHEL and other kernels, [[Creating_Python-related_Ebuilds|enhanced Python support]], Portage mini-manifests, user-centric distribution model, and a large number of community infrastructure improvements.
+
</div></div></div>
+
 
+
__NOTITLE__
+
__NOEDITSECTION__
+
{{#subobject:|slideIndex=0|slideCaption=
+
== [[User:Drobbins|drobbins]] ==
+
 
+
[[GNOME First Steps|GNOME 3.12]]
+
([[Funtoo_Linux_FAQ#Do_you_support_systemd.3F|without systemd]], because that's how we roll.)
+
 
+
Note: Badgers optional.
+
|slideImage=File:gnome3122.jpg|slideLink=GNOME First Steps}}
+
{{#subobject:|slideIndex=1|slideCaption=
+
== [[User:Anak1n|anak1n]] ==
+
 
+
flux box
+
|slideImage=File:fluxbox-09.02.14.jpg}}
+
{{#subobject:|slideIndex=2|slideCaption=
+
== spectromas ==
+
 
+
[[Package:Awesome_(Window_Manager)|Awesome WM]]
+
|slideImage=File:awesome.jpg|slideLink=Package:Awesome (Window Manager)}}
+
{{#subobject:|slideIndex=3|slideCaption=
+
== [[User:Anak1n|anak1n]] ==
+
 
+
KDE
+
|slideImage=File:anak1n-kde.jpg}}
+

Revision as of 22:51, November 22, 2014

x11-misc


Source Repository:Gentoo Portage Tree
Homepage

Summary: A compositor for X.

Compton

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:

# 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:

$ 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:

$ 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

$ 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;
....