docs(picom): adapt file for better markdown export
All checks were successful
deploy / build (push) Successful in 2m34s
All checks were successful
deploy / build (push) Successful in 2m34s
This commit is contained in:
parent
51c68158af
commit
955c9aea3c
114
docs/picom.org
114
docs/picom.org
@ -23,15 +23,19 @@ shadow-radius = 17;
|
|||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Picom can also apply some level of opacity on shadows.
|
Picom can also apply some level of opacity on shadows.
|
||||||
|
|
||||||
| Default value | ~0.75~ |
|
| Default value | ~0.75~ |
|
||||||
| Min value | ~0.0~ |
|
| Min value | ~0.0~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
shadow-opacity = 0.75
|
shadow-opacity = 0.75
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
The left and top offsets for shadows are expressed in pixels.
|
The left and top offsets for shadows are expressed in pixels.
|
||||||
|
|
||||||
| Default value | ~-15~ |
|
| Default value | ~-15~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
shadow-offset-x = -16;
|
shadow-offset-x = -16;
|
||||||
shadow-offset-y = -16;
|
shadow-offset-y = -16;
|
||||||
@ -47,7 +51,9 @@ shadow-color = "#171A20"
|
|||||||
|
|
||||||
It is possible to specify a list of conditions of windows that should
|
It is possible to specify a list of conditions of windows that should
|
||||||
have no shadow.
|
have no shadow.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
shadow-exclude = [
|
shadow-exclude = [
|
||||||
"name = 'Notification'",
|
"name = 'Notification'",
|
||||||
@ -65,7 +71,9 @@ shadows should not be painted in, such as a dock window region. For example,
|
|||||||
#+END_SRC
|
#+END_SRC
|
||||||
would make the 10 pixels at the bottom of the screen not have any shadow painted
|
would make the 10 pixels at the bottom of the screen not have any shadow painted
|
||||||
on.
|
on.
|
||||||
|
|
||||||
| Default value | ~""~ |
|
| Default value | ~""~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf :tangle no
|
#+BEGIN_SRC conf :tangle no
|
||||||
shadow-exclude-reg = ""
|
shadow-exclude-reg = ""
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -86,7 +94,9 @@ Options in this subheader *will not* be exported to my configuration file.
|
|||||||
Thanks to this value, Picom can avoid drawing shadows on dock or panel windows.
|
Thanks to this value, Picom can avoid drawing shadows on dock or panel windows.
|
||||||
This option is deprecated, and users should use the ~wintypes~ option in their
|
This option is deprecated, and users should use the ~wintypes~ option in their
|
||||||
config file instead.
|
config file instead.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
no-dock-shadow = false;
|
no-dock-shadow = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -94,7 +104,9 @@ no-dock-shadow = false;
|
|||||||
This option allows Picom not to draw on drag-and-drop windows. It is
|
This option allows Picom not to draw on drag-and-drop windows. It is
|
||||||
deprecated, and users should use the ~wintypes~ option in their config
|
deprecated, and users should use the ~wintypes~ option in their config
|
||||||
file instead.
|
file instead.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
no-dnd-shadow = false;
|
no-dnd-shadow = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -110,7 +122,9 @@ or
|
|||||||
#+BEGIN_SRC conf :tangle no
|
#+BEGIN_SRC conf :tangle no
|
||||||
shadow-exclude = 'bounding_shaped && !rounded_corners'
|
shadow-exclude = 'bounding_shaped && !rounded_corners'
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
| Default value | ~""~ |
|
| Default value | ~""~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf :tangle no
|
#+BEGIN_SRC conf :tangle no
|
||||||
shadow-ignore-shaped = ""
|
shadow-ignore-shaped = ""
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -134,44 +148,56 @@ Picom has the ability to create some fading effects on windows when
|
|||||||
opening or closing or when the opacity changes. The following
|
opening or closing or when the opacity changes. The following
|
||||||
parameter toggles this feature on or off. However, its behaviour can
|
parameter toggles this feature on or off. However, its behaviour can
|
||||||
be changed with ~no-fading-openclose~.
|
be changed with ~no-fading-openclose~.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
fading = true
|
fading = true
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
These values control the opacity change between steps while fading in
|
These values control the opacity change between steps while fading in
|
||||||
and out.
|
and out.
|
||||||
|
|
||||||
| Default value | ~0.028~ (fade-in), ~0.03~ (fade-out) |
|
| Default value | ~0.028~ (fade-in), ~0.03~ (fade-out) |
|
||||||
| Min value | ~0.01~ |
|
| Min value | ~0.01~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
fade-in-step = 0.25;
|
fade-in-step = 0.25;
|
||||||
fade-out-step = 0.23;
|
fade-out-step = 0.23;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
This value represents the time between steps in fade steps, in milliseconds.
|
This value represents the time between steps in fade steps, in milliseconds.
|
||||||
|
|
||||||
| Default value | ~10~ |
|
| Default value | ~10~ |
|
||||||
| Min value | ~1~ |
|
| Min value | ~1~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
fade-delta = 20;
|
fade-delta = 20;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
It is possible to exclude some windows that should not be faded with a specified
|
It is possible to exclude some windows that should not be faded with a specified
|
||||||
list of conditions.
|
list of conditions.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
fade-exclude = [ "class_g = 'mpv'" ];
|
fade-exclude = [ "class_g = 'mpv'" ];
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
This option allows Picom not to create any fade on windows opening or closing.
|
This option allows Picom not to create any fade on windows opening or closing.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
no-fading-openclose = true;
|
no-fading-openclose = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Finally, this option is a workaround for Openbox, Fluxbox and others by not
|
Finally, this option is a workaround for Openbox, Fluxbox and others by not
|
||||||
fading destroyed ARGB windows with WM frame.
|
fading destroyed ARGB windows with WM frame.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
no-fading-destroyed-argb = false
|
no-fading-destroyed-argb = false
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -180,67 +206,83 @@ no-fading-destroyed-argb = false
|
|||||||
Picom is also able to create some opacity or transparency for windows, depending
|
Picom is also able to create some opacity or transparency for windows, depending
|
||||||
on their state or on some user-defined rules. For instance, the following value
|
on their state or on some user-defined rules. For instance, the following value
|
||||||
describes the opacity of inactive windows.
|
describes the opacity of inactive windows.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
| Min value | ~0.1~ |
|
| Min value | ~0.1~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
inactive-opacity = 0.8;
|
inactive-opacity = 0.8;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
On the other hand, it is possible to declare a default opacity for active
|
On the other hand, it is possible to declare a default opacity for active
|
||||||
windows.
|
windows.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
| Min value | ~0.1~ |
|
| Min value | ~0.1~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
active-opacity = 1;
|
active-opacity = 1;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
This however describes the opacity of window titlebars and borders.
|
This however describes the opacity of window titlebars and borders.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
| Min value | ~0.1~ |
|
| Min value | ~0.1~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
frame-opacity = 1.0;
|
frame-opacity = 1.0;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
~menu-opacity~ describes the opacity for dropdown menus and pop-up
|
~menu-opacity~ describes the opacity for dropdown menus and pop-up
|
||||||
menus.
|
menus.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
| Min value | ~0.1~ |
|
| Min value | ~0.1~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# menu-opacity = 0.9;
|
# menu-opacity = 0.9;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
~inactive-opacity-override~ allows the user to let inactive opacity set by ~-i~
|
~inactive-opacity-override~ allows the user to let inactive opacity set by ~-i~
|
||||||
override the ~_NET_WM_OPACITY_ values of windows.
|
override the ~_NET_WM_OPACITY_ values of windows.
|
||||||
|
|
||||||
| Default value | ~true~ |
|
| Default value | ~true~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
inactive-opacity-override = true;
|
inactive-opacity-override = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
While it is possible to alter opacity on inactive windows, it is also possible
|
While it is possible to alter opacity on inactive windows, it is also possible
|
||||||
to dim them.
|
to dim them.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
| Min value | ~0.1~ |
|
| Min value | ~0.1~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# inactive-dim = 1.0
|
# inactive-dim = 1.0
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
It is also possible to use a fixed inactive dim value, instead of adjusting
|
It is also possible to use a fixed inactive dim value, instead of adjusting
|
||||||
according to window opacity.
|
according to window opacity.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
| Min value | ~0.1~ |
|
| Min value | ~0.1~ |
|
||||||
| Max value | ~1.0~ |
|
| Max value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# inactive-dim-fixed = 1.0
|
# inactive-dim-fixed = 1.0
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
It is also possible to specify a list of conditions of windows that should
|
It is also possible to specify a list of conditions of windows that should
|
||||||
always be considered focused.
|
always be considered focused.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
focus-exclude = [
|
focus-exclude = [
|
||||||
"class_g = 'mpv'",
|
"class_g = 'mpv'",
|
||||||
@ -253,7 +295,9 @@ The user can also specify a list of opacity rules, in the format
|
|||||||
~PERCENT:PATTERN~, like ~50:name *= "Firefox"~ . ~picom-trans~ is recommended
|
~PERCENT:PATTERN~, like ~50:name *= "Firefox"~ . ~picom-trans~ is recommended
|
||||||
over this. Note we don't make any guarantee about possible conflicts with other
|
over this. Note we don't make any guarantee about possible conflicts with other
|
||||||
programs that set ~_NET_WM_WINDOW_OPACITY~ on frame or client windows.
|
programs that set ~_NET_WM_WINDOW_OPACITY~ on frame or client windows.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
opacity-rule = [];
|
opacity-rule = [];
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -275,34 +319,44 @@ This value enables or disables the blur for the background of
|
|||||||
semi-transparent or ARGB windows. It has bad performances though, with
|
semi-transparent or ARGB windows. It has bad performances though, with
|
||||||
driver-dependent behaviour. The name of the switch may change without
|
driver-dependent behaviour. The name of the switch may change without
|
||||||
prior notifications.
|
prior notifications.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
blur-background = true;
|
blur-background = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Blur background of windows when the window frame is not opaque. If true, this
|
Blur background of windows when the window frame is not opaque. If true, this
|
||||||
implies the value ~true~ for ~blur-background~.
|
implies the value ~true~ for ~blur-background~.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
blur-background-frame = true;
|
blur-background-frame = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
The following determines whether to use fixed blur strength rather than
|
The following determines whether to use fixed blur strength rather than
|
||||||
adjusting according to window opacity.
|
adjusting according to window opacity.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
blur-background-fixed = false;
|
blur-background-fixed = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Specify the blur convolution kernel, with the format
|
Specify the blur convolution kernel, with the format
|
||||||
~"5,5,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"~.
|
~"5,5,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"~.
|
||||||
|
|
||||||
| Default value | ~""~ |
|
| Default value | ~""~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# blur-kern = "3x3box";
|
# blur-kern = "3x3box";
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
It is possible to write exclude conditions for background blur.
|
It is possible to write exclude conditions for background blur.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
blur-background-exclude = [
|
blur-background-exclude = [
|
||||||
"window_type = 'desktop'",
|
"window_type = 'desktop'",
|
||||||
@ -315,55 +369,71 @@ blur-background-exclude = [
|
|||||||
** General settings
|
** General settings
|
||||||
Daemonize process. Fork to background after initialization. Can cause
|
Daemonize process. Fork to background after initialization. Can cause
|
||||||
issues with certain (badly-written) drivers.
|
issues with certain (badly-written) drivers.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
daemon = true;
|
daemon = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Picom has three backends it can use: ~xrender~, ~glx~, and ~xr_glx_hybrid~. GLX
|
Picom has three backends it can use: ~xrender~, ~glx~, and ~xr_glx_hybrid~. GLX
|
||||||
backend is typically much faster but depends on a sane driver.
|
backend is typically much faster but depends on a sane driver.
|
||||||
|
|
||||||
| Default value | ~xrender~ |
|
| Default value | ~xrender~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
backend = "glx";
|
backend = "glx";
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
This enables or disables VSync.
|
This enables or disables VSync.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
vsync = true;
|
vsync = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Enable remote control via D-Bus. See the *D-BUS API* section below for more
|
Enable remote control via D-Bus. See the *D-BUS API* section below for more
|
||||||
details.
|
details.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
dbus = false;
|
dbus = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Try to detect WM windows (a non-override-redirect window with no child
|
Try to detect WM windows (a non-override-redirect window with no child
|
||||||
that has ~WM_STATE~) and marks them as active.
|
that has ~WM_STATE~) and marks them as active.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
mark-wmwin-focused = true;
|
mark-wmwin-focused = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Mark override-redirect windows that doesn't have a child window with ~WM_STATE~
|
Mark override-redirect windows that doesn't have a child window with ~WM_STATE~
|
||||||
focused.
|
focused.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
mark-ovredir-focused = true;
|
mark-ovredir-focused = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Try to detect windows with rounded corners and don't consider them shaped
|
Try to detect windows with rounded corners and don't consider them shaped
|
||||||
windows. The accuracy is not very high, unfortunately.
|
windows. The accuracy is not very high, unfortunately.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
detect-rounded-corners = true;
|
detect-rounded-corners = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Detect ~_NET_WM_OPACITY~ on client windows, useful for window managers not
|
Detect ~_NET_WM_OPACITY~ on client windows, useful for window managers not
|
||||||
passing ~_NET_WM_OPACITY~ of client windows to frame windows.
|
passing ~_NET_WM_OPACITY~ of client windows to frame windows.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
detect-client-opacity = true;
|
detect-client-opacity = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -372,7 +442,9 @@ Limit picom to repaint at most once every 1 / ~refresh_rate~ second to
|
|||||||
boost performance. This should not be used with ~vsync
|
boost performance. This should not be used with ~vsync
|
||||||
drm/opengl/opengl-oml~ as they essentially do sw-opti's job already,
|
drm/opengl/opengl-oml~ as they essentially do sw-opti's job already,
|
||||||
unless you wish to specify a lower refresh rate than the actual value.
|
unless you wish to specify a lower refresh rate than the actual value.
|
||||||
|
|
||||||
| Default value | ~""~ |
|
| Default value | ~""~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# sw-opti =;
|
# sw-opti =;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -380,7 +452,9 @@ unless you wish to specify a lower refresh rate than the actual value.
|
|||||||
Use EWMH ~_NET_ACTIVE_WINDOW~ to determine currently focused window, rather than
|
Use EWMH ~_NET_ACTIVE_WINDOW~ to determine currently focused window, rather than
|
||||||
listening to ~FocusIn~/~FocusOut~ event. Might have more accuracy, provided that
|
listening to ~FocusIn~/~FocusOut~ event. Might have more accuracy, provided that
|
||||||
the WM supports it.
|
the WM supports it.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# use-ewmh-active-win = false;
|
# use-ewmh-active-win = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -389,27 +463,35 @@ Unredirect all windows if a full-screen opaque window is detected, to
|
|||||||
maximize performance for full-screen windows. Known to cause
|
maximize performance for full-screen windows. Known to cause
|
||||||
flickering when redirecting/unredirecting windows. =paint-on-overlay=
|
flickering when redirecting/unredirecting windows. =paint-on-overlay=
|
||||||
may make the flickering less obvious.
|
may make the flickering less obvious.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
unredir-if-possible = false;
|
unredir-if-possible = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Delay before unredirecting the window, in milliseconds.
|
Delay before unredirecting the window, in milliseconds.
|
||||||
|
|
||||||
| Default value | ~0~ |
|
| Default value | ~0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
unredir-if-possible-delay = 0;
|
unredir-if-possible-delay = 0;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Conditions of windows that shouldn't be considered full-screen for unredirecting
|
Conditions of windows that shouldn't be considered full-screen for unredirecting
|
||||||
screen.
|
screen.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
unredir-if-possible-exclude = [];
|
unredir-if-possible-exclude = [];
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Use ~WM_TRANSIENT_FOR~ to group windows, and consider windows in the same group
|
Use ~WM_TRANSIENT_FOR~ to group windows, and consider windows in the same group
|
||||||
focused at the same time.
|
focused at the same time.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
detect-transient = true;
|
detect-transient = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -417,7 +499,9 @@ detect-transient = true;
|
|||||||
Use ~WM_CLIENT_LEADER~ to group windows, and consider windows in the same group
|
Use ~WM_CLIENT_LEADER~ to group windows, and consider windows in the same group
|
||||||
focused at the same time. ~WM_TRANSIENT_FOR~ has higher priority if
|
focused at the same time. ~WM_TRANSIENT_FOR~ has higher priority if
|
||||||
detect-transient is enabled, too.
|
detect-transient is enabled, too.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
detect-client-leader = true;
|
detect-client-leader = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -431,14 +515,18 @@ corruption issues of blur, in which case you should use the blur radius value
|
|||||||
here (e.g. with a 3x3 kernel, you should use ~--resize-damage 1~, with a 5x5 one
|
here (e.g. with a 3x3 kernel, you should use ~--resize-damage 1~, with a 5x5 one
|
||||||
you use ~--resize-damage 2~, and so on). May or may not work with
|
you use ~--resize-damage 2~, and so on). May or may not work with
|
||||||
~--glx-no-stencil~. Shrinking doesn't function correctly.
|
~--glx-no-stencil~. Shrinking doesn't function correctly.
|
||||||
|
|
||||||
| Default value | ~1~ |
|
| Default value | ~1~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
resize-damage = 1;
|
resize-damage = 1;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Specify a list of conditions of windows that should be painted with
|
Specify a list of conditions of windows that should be painted with
|
||||||
inverted colour. Resource-hogging, and is not well tested.
|
inverted colour. Resource-hogging, and is not well tested.
|
||||||
|
|
||||||
| Default value | ~[]~ |
|
| Default value | ~[]~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
invert-color-include = [];
|
invert-color-include = [];
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -447,7 +535,9 @@ Disable the use of damage information. This cause the whole screen to
|
|||||||
be redrawn every time, instead of the part of the screen has actually
|
be redrawn every time, instead of the part of the screen has actually
|
||||||
changed. Potentially degrades the performance, but might fix some
|
changed. Potentially degrades the performance, but might fix some
|
||||||
artefacts. The opposing option is use-damage
|
artefacts. The opposing option is use-damage
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
use-damage = false;
|
use-damage = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -455,21 +545,27 @@ use-damage = false;
|
|||||||
Use X Sync fence to sync clients' draw calls, to make sure all draw calls are
|
Use X Sync fence to sync clients' draw calls, to make sure all draw calls are
|
||||||
finished before picom starts drawing. Needed on nvidia-drivers with GLX backend
|
finished before picom starts drawing. Needed on nvidia-drivers with GLX backend
|
||||||
for some users.
|
for some users.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
xrender-sync-fence = false;
|
xrender-sync-fence = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Force all windows to be painted with blending. Useful if you have a
|
Force all windows to be painted with blending. Useful if you have a
|
||||||
glx-fshader-win that could turn opaque pixels transparent.
|
glx-fshader-win that could turn opaque pixels transparent.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
force-win-blend = false;
|
force-win-blend = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Do not use EWMH to detect full-screen windows. Reverts to checking if a window is
|
Do not use EWMH to detect full-screen windows. Reverts to checking if a window is
|
||||||
full-screen based only on its size and coordinates.
|
full-screen based only on its size and coordinates.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
no-ewmh-fullscreen = false;
|
no-ewmh-fullscreen = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -478,14 +574,18 @@ Dimming bright windows so their brightness doesn't exceed this set
|
|||||||
value. Brightness of a window is estimated by averaging all pixels in
|
value. Brightness of a window is estimated by averaging all pixels in
|
||||||
the window, so this could come with a performance hit. Setting this to
|
the window, so this could come with a performance hit. Setting this to
|
||||||
1.0 disables this behaviour. Requires ~--use-damage~ to be disabled.
|
1.0 disables this behaviour. Requires ~--use-damage~ to be disabled.
|
||||||
|
|
||||||
| Default value | ~1.0~ |
|
| Default value | ~1.0~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
max-brightness = 1.0;
|
max-brightness = 1.0;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Make transparent windows clip other windows like non-transparent windows do,
|
Make transparent windows clip other windows like non-transparent windows do,
|
||||||
instead of blending on top of them.
|
instead of blending on top of them.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
transparent-clipping = false;
|
transparent-clipping = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -499,7 +599,9 @@ Set the log level. Possible values in increasing level of importance are:
|
|||||||
Case doesn't matter. If using the "TRACE" log level, it's better to
|
Case doesn't matter. If using the "TRACE" log level, it's better to
|
||||||
log into a file using ~--log-file~, since it can generate a huge stream
|
log into a file using ~--log-file~, since it can generate a huge stream
|
||||||
of logs.
|
of logs.
|
||||||
|
|
||||||
| Default value | ~"debug"~ |
|
| Default value | ~"debug"~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
log-level = "warn";
|
log-level = "warn";
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -509,19 +611,25 @@ written to stderr. Otherwise, logs will to written to the given file,
|
|||||||
though some early logs might still be written to the stderr. When
|
though some early logs might still be written to the stderr. When
|
||||||
setting this option from the config file, it is recommended to use an
|
setting this option from the config file, it is recommended to use an
|
||||||
absolute path.
|
absolute path.
|
||||||
|
|
||||||
| Default value | ~''~ |
|
| Default value | ~''~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# log-file = '/path/to/your/log/file';
|
# log-file = '/path/to/your/log/file';
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Show all X errors (for debugging)
|
Show all X errors (for debugging)
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# show-all-xerrors = false;
|
# show-all-xerrors = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Write process ID to a file.
|
Write process ID to a file.
|
||||||
|
|
||||||
| Default value | ~''~ |
|
| Default value | ~''~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
# write-pid-path = '/path/to/your/log/file';
|
# write-pid-path = '/path/to/your/log/file';
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -574,7 +682,9 @@ Avoid using stencil buffer, useful if you don't have a stencil buffer.
|
|||||||
Might cause incorrect opacity when rendering transparent content (but
|
Might cause incorrect opacity when rendering transparent content (but
|
||||||
never practically happened) and may not work with blur-background.
|
never practically happened) and may not work with blur-background.
|
||||||
Tests show a 15% performance boost. Recommended.
|
Tests show a 15% performance boost. Recommended.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
glx-no-stencil = true;
|
glx-no-stencil = true;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -583,7 +693,9 @@ Avoid rebinding pixmap on window damage. Probably could improve
|
|||||||
performance on rapid window content changes, but is known to break
|
performance on rapid window content changes, but is known to break
|
||||||
things on some drivers (LLVMpipe, xf86-video-intel, etc.). Recommended
|
things on some drivers (LLVMpipe, xf86-video-intel, etc.). Recommended
|
||||||
if it works.
|
if it works.
|
||||||
|
|
||||||
| Default value | ~false~ |
|
| Default value | ~false~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf
|
#+BEGIN_SRC conf
|
||||||
glx-no-rebind-pixmap = false;
|
glx-no-rebind-pixmap = false;
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
@ -592,7 +704,9 @@ Use specified GLSL fragment shader for rendering window contents. See
|
|||||||
~compton-default-fshader-win.glsl~ and
|
~compton-default-fshader-win.glsl~ and
|
||||||
~compton-fake-transparency-fshader-win.glsl~ in the source tree for
|
~compton-fake-transparency-fshader-win.glsl~ in the source tree for
|
||||||
examples.
|
examples.
|
||||||
|
|
||||||
| Default value | ~''~ |
|
| Default value | ~''~ |
|
||||||
|
|
||||||
#+BEGIN_SRC conf :tangle no
|
#+BEGIN_SRC conf :tangle no
|
||||||
glx-fshader-win = '';
|
glx-fshader-win = '';
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
Loading…
Reference in New Issue
Block a user