Difference between pages "Package:Radeon Video Drivers" and "Package:Compton"

(Difference between pages)
(Created page with "{{Ebuild |Summary=Open source drivers for AMD video cards. |CatPkg=x11-drivers/xf86-video-ati |Maintainer= |Homepage=http://cgit.freedesktop.org/xorg/driver/xf86-video-ati/ }}...")
 
(Added a troubleshooting section)
 
Line 1: Line 1:
 
{{Ebuild
 
{{Ebuild
|Summary=Open source drivers for AMD video cards.
+
|Summary=A compositor for X.
|CatPkg=x11-drivers/xf86-video-ati
+
|CatPkg=x11-misc
 
|Maintainer=
 
|Maintainer=
|Homepage=http://cgit.freedesktop.org/xorg/driver/xf86-video-ati/
+
|Homepage=https://www.github.com/chjj/compton/
 
}}
 
}}
If you have become frustrated by the somewhat poorly maintained <code>ati-drivers</code> (the closed source video drivers for AMD cards) or if you would rather use open source video drivers, this is the package for you. This page outlines how to install and configure the open source <code>xf86-video-ati</code> drivers.  
+
== 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
  
== Preparation ==
+
== Installation ==
=== Check to see if your card is an AMD card ===
+
To install compton, just emerge it:
If you do not know if you have an AMD graphics card or not, you can run the following command:
+
 
<console>
 
<console>
###i## lspci | grep VGA
+
###i## emerge -av compton
 
</console>
 
</console>
  
If the output produces information that contains something like "01:00.0 VGA compatible controller: Advanced Micro Devices, Inc. [AMD/ATI] Pitcairn PRO [Radeon HD 7850]," then you have an AMD graphics card and continue to the next step in the install process. If <code>lspci</code> does not provide you with something like this, and instead contains intel or nvidia, read about installing drivers for those elsewhere on the wiki.
+
== Configuration ==
 +
=== Creating a custom blur kernel ===
 +
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.  
 +
<code>compton-convgen</code> takes the following switches:
 +
* <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>
 +
* <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.
 +
* <code>type</code>: The type of blur kernel to use. Options include box and gaussian.
 +
* <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.
 +
* <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.}}
  
=== Preparing the kernel ===
+
To build a blur (convolution) kernel of type gaussian with a sigma of three and a height of 13, run the following:
Now that you know you have an AMD graphics card, you can prepare the kernel for <code>xf86-video-ati</code>. Begin by ensuring that MTRR is enabled, then enable support for AGP graphics cards (only necessary if your card sits in an AGP slot -- not a PCIe one). After enabling AGP (if you needed it), you should enable support for the DRM and modesetting on radeon.:
+
<console>
{{kernelop|title= |desc=
+
$##i## compton-convgen -f sigma=3 --dump-compton gaussian 13
Processor type and features --->
+
</console>
    [*] MTRR (Memory Type Range Register) support
+
  
Device Drivers --->
+
This should output some long string of values that begins with:
    Graphics support --->
+
<console>
        (If you have an AGP-based graphics card, enable these options)
+
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,
        <*> /dev/agpgart (AGP Support) --->
+
</console>
            <*> AMD Opteron/Athlon64 on-CPU GART support
+
==== Testing different blur kernels ====
        Direct Rendering Manager --->
+
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:
            <*> Direct Rendering Manager (XFree86 4.1.0 and higher DRI support) ----
+
<console>
            <*> ATI Radeon
+
$##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>`
                [*] Enable userspace modesetting on radeon
+
</console>
        Frame buffer Devices --->
+
{{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).}}
            < > ATI Radon display support
+
==== 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 = "
 
}}
 
}}
If you have a graphics cards with HDMI ports that you wish to use for audio, some additional configuration of the kernel is required:
+
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:
{{kernelop|title= |desc=
+
{{file|name=~/.config/compton.conf|desc=|body=
Device Drivers --->
+
blur-kern = "a bunch of numbers and commas that you have pasted in.........";
    <*> Sound card support --->
+
        <*> Advanced Linux Sound Architecture --->
+
            HD Audio --->
+
                <*>HD Audio PCI
+
                    (64) Pre-allocated buffer size for HD-audio drivers
+
                    <*> Build HDMI/DisplayPort HD-audio codec support
+
        [*] Dynamic device file minor numbers
+
        (32) Max number of sound cards
+
 
}}
 
}}
 +
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.
  
=== Getting the required firmware ===
+
==== Blur the background of only certain windows ====
Many newer AMD GPU's require that you install firmware for them to function. Install the package <code>radeon-ucode</code> (radeon microcode) for this function:
+
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>
 
<console>
###i## emerge radeon-ucode
+
$##i## xprop | grep WM_CLASS
 
</console>
 
</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.}}
  
=== Installing the firmware into the kernel ===
+
=== Drawing custom shadows ===
{{SectionNeedsUpdates}}
+
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>:
 +
{{file|name=~/.config/compton.conf|desc=|body=
 +
enable-shadows = true;
 +
}}
 +
Some of compton's other settings related to shadows include:
 +
* <code>--no-dnd-shadow</code>: When set to true, Compton will not draw shadows on drag and drop windows.
 +
* <code>--no-dock-shadow</code>: When true, compton will not draw shadows on toolbars and docks.
 +
* <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.
 +
 
 +
== Troubleshooting ==
 +
=== Compton with <code>backend=glx</code> does not work well with <code>ati-drivers</code>
 +
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>:
 +
{{file|name=~/.config/compton.conf|desc= |body=
 +
vsync = "opengl-swc";
 +
paint-on-overlay = true;
 +
....
 +
}}
 +
[[Category:Desktop]]
 
{{EbuildFooter}}
 
{{EbuildFooter}}

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