picom.conf 14.5 KB
Newer Older
1
#################################
Jay Ta'ala's avatar
Jay Ta'ala committed
2
#             Shadows           #
3
4
5
#################################


Jay Ta'ala's avatar
Jay Ta'ala committed
6
7
8
# Enabled client-side shadows on windows. Note desktop windows
# (windows with '_NET_WM_WINDOW_TYPE_DESKTOP') never get shadow,
# unless explicitly requested using the wintypes option.
9
#
Jay Ta'ala's avatar
Jay Ta'ala committed
10
# shadow = false
11

Jay Ta'ala's avatar
Jay Ta'ala committed
12
13
# The blur radius for shadows, in pixels. (defaults to 12)
# shadow-radius = 12
14

Jay Ta'ala's avatar
Jay Ta'ala committed
15
16
# The opacity of shadows. (0.0 - 1.0, defaults to 0.75)
# shadow-opacity = .75
17

Jay Ta'ala's avatar
Jay Ta'ala committed
18
19
# The left offset for shadows, in pixels. (defaults to -15)
# shadow-offset-x = -15
20

Jay Ta'ala's avatar
Jay Ta'ala committed
21
22
# The top offset for shadows, in pixels. (defaults to -15)
# shadow-offset-y = -15
23

Jay Ta'ala's avatar
Jay Ta'ala committed
24
25
26
27
28
29
30
31
32
33
34
35
36
# Red color value of shadow (0.0 - 1.0, defaults to 0).
# shadow-red = 0

# Green color value of shadow (0.0 - 1.0, defaults to 0).
# shadow-green = 0

# Blue color value of shadow (0.0 - 1.0, defaults to 0).
# shadow-blue = 0

# Hex string color value of shadow (#000000 - #FFFFFF, defaults to #000000). This option will override options set shadow-(red/green/blue)
# shadow-color = "#000000"

# Specify a list of conditions of windows that should have no shadow.
37
#
Jay Ta'ala's avatar
Jay Ta'ala committed
38
39
# examples:
#   shadow-exclude = "n:e:Notification";
40
#
Jay Ta'ala's avatar
Jay Ta'ala committed
41
# shadow-exclude = []
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
shadow-exclude = [
    "! name~=''",
    "name = 'Notification'",
    "name = 'Plank'",
    "name = 'Docky'",
    "name = 'Kupfer'",
    "name = 'xfce4-notifyd'",
    "name = 'cpt_frame_window'",
    "name *= 'VLC'",
    "name *= 'compton'",
    "name *= 'picom'",
    "name *= 'Chromium'",
    "name *= 'Chrome'",
    "class_g = 'Firefox' && argb",
    "class_g = 'Conky'",
    "class_g = 'Kupfer'",
    "class_g = 'Synapse'",
    "class_g ?= 'Notify-osd'",
    "class_g ?= 'Cairo-dock'",
    "class_g ?= 'Xfce4-notifyd'",
    "class_g ?= 'Xfce4-power-manager'",
    # disables shadows for hidden windows
    "_GTK_FRAME_EXTENTS@:c",
    "_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'",
    # disables shadows on sticky windows:
    "_NET_WM_STATE@:32a *= '_NET_WM_STATE_STICKY'",
    # disables shadows on i3 frames
    "class_g ?= 'i3-frame'",
    # workaround for conky until it provides window properties:
    "override_redirect = 1 && !WM_CLASS@:s"
];

Jay Ta'ala's avatar
Jay Ta'ala committed
74
75
76
77
78
79
80
# Specify a list of conditions of windows that should have no shadow painted over, such as a dock window.
# clip-shadow-above = []

# Specify a X geometry that describes the region in which shadow should not
# be painted in, such as a dock window region. Use
#    shadow-exclude-reg = "x10+0+0"
# for example, if the 10 pixels on the bottom of the screen should not have shadows painted on.
81
#
Jay Ta'ala's avatar
Jay Ta'ala committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# shadow-exclude-reg = ""

# Crop shadow of a window fully on a particular Xinerama screen to the screen.
# xinerama-shadow-crop = false


#################################
#           Fading              #
#################################


# Fade windows in/out when opening/closing and when opacity changes,
#  unless no-fading-openclose is used.
# fading = false
fading = true;

# Opacity change between steps while fading in. (0.01 - 1.0, defaults to 0.028)
# fade-in-step = 0.028
fade-in-step = 0.03;

# Opacity change between steps while fading out. (0.01 - 1.0, defaults to 0.03)
# fade-out-step = 0.03
fade-out-step = 0.03;

# The time between steps in fade step, in milliseconds. (> 0, defaults to 10)
# fade-delta = 10
Jay Ta'ala's avatar
Jay Ta'ala committed
108
fade-delta = 4;
Jay Ta'ala's avatar
Jay Ta'ala committed
109
110
111
112
113
114
115
116
117
118
119
120
121

# Specify a list of conditions of windows that should not be faded.
# fade-exclude = []

# Do not fade on window open/close.
# no-fading-openclose = false

# Do not fade destroyed ARGB windows with WM frame. Workaround of bugs in Openbox, Fluxbox, etc.
# no-fading-destroyed-argb = false


#################################
#   Transparency / Opacity      #
122
123
#################################

Jay Ta'ala's avatar
Jay Ta'ala committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

# Opacity of inactive windows. (0.1 - 1.0, defaults to 1.0)
# inactive-opacity = 1

# Opacity of window titlebars and borders. (0.1 - 1.0, disabled by default)
# frame-opacity = 1.0

# Let inactive opacity set by -i override the '_NET_WM_OPACITY' values of windows.
# inactive-opacity-override = true

# Default opacity for active windows. (0.0 - 1.0, defaults to 1.0)
# active-opacity = 1.0

# Dim inactive windows. (0.0 - 1.0, defaults to 0.0)
# inactive-dim = 0.0

# Specify a list of conditions of windows that should never be considered focused.
# focus-exclude = []
focus-exclude = [ "class_g = 'Cairo-clock'" ];

# Use fixed inactive dim value, instead of adjusting according to window opacity.
# inactive-dim-fixed = 1.0

# Specify a list of opacity rules, in the format `PERCENT:PATTERN`,
# like `50:name *= "Firefox"`. picom-trans is recommended 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.
# example:
#    opacity-rule = [ "80:class_g = 'URxvt'" ];
#
154
155
opacity-rule = [
    "90:name = 'alttab'",
156
    "80:name = 'i3-overview'",
157
158
159
160
161
162
    # no opacity on sticky windows
    "99:_NET_WM_STATE@:32a *= '_NET_WM_STATE_STICKY'"
];


#################################
Jay Ta'ala's avatar
Jay Ta'ala committed
163
#           Corners             #
164
165
#################################

Jay Ta'ala's avatar
Jay Ta'ala committed
166
167
168
# Sets the radius of rounded window corners. When > 0, the compositor will
# round the corners of windows. Does not interact well with
# `transparent-clipping`.
Jay Ta'ala's avatar
Jay Ta'ala committed
169
corner-radius = 0;
170

Jay Ta'ala's avatar
Jay Ta'ala committed
171
172
173
174
175
# Exclude conditions for rounded corners.
rounded-corners-exclude = [
  "window_type = 'dock'",
  "window_type = 'desktop'"
];
176

Jay Ta'ala's avatar
Jay Ta'ala committed
177
178
179

#################################
#     Background-Blurring       #
180
#################################
Jay Ta'ala's avatar
Jay Ta'ala committed
181
182
183
184
185


# Parameters for background blurring, see the *BLUR* section for more information.
# blur-method =
# blur-size = 12
186
#
Jay Ta'ala's avatar
Jay Ta'ala committed
187
188
189
190
191
192
193
# blur-deviation = false
#
# blur-strength = 5

# Blur background of semi-transparent / ARGB windows.
# Bad in performance, with driver-dependent behavior.
# The name of the switch may change without prior notifications.
194
#
Jay Ta'ala's avatar
Jay Ta'ala committed
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# blur-background = false

# Blur background of windows when the window frame is not opaque.
# Implies:
#    blur-background
# Bad in performance, with driver-dependent behavior. The name may change.
#
# blur-background-frame = false

# Use fixed blur strength rather than adjusting according to window opacity.
# blur-background-fixed = false

# Specify the blur convolution kernel, with the following format:
# example:
#   blur-kern = "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";
#
# blur-kern = ""
blur-kern = "3x3box";

# Exclude conditions for background blur.
# blur-background-exclude = []
blur-background-exclude = [
  "window_type = 'dock'",
  "window_type = 'desktop'",
  "_GTK_FRAME_EXTENTS@:c"
];

222
223
224
225
226
227
228
229
230
231
232

#################################
#       Colour-inversion        #
#################################

# Specify list of windows or x flag to that will be colour inverted.
invert-color-include = [
    "INVERT_FLAG@:8c"
];


Jay Ta'ala's avatar
Jay Ta'ala committed
233
234
#################################
#       General Settings        #
235
236
#################################

Jay Ta'ala's avatar
Jay Ta'ala committed
237
238
239
240
241
242
# Daemonize process. Fork to background after initialization. Causes issues with certain (badly-written) drivers.
# daemon = false

# Specify the backend to use: `xrender`, `glx`, or `xr_glx_hybrid`.
# `xrender` is the default one.
#
Jay Ta'ala's avatar
Jay Ta'ala committed
243
backend = "glx";
Jay Ta'ala's avatar
Jay Ta'ala committed
244
245
246
247
248
249
250
251
252
253
254
255

# Enable/disable VSync.
# vsync = false
vsync = true;

# Enable remote control via D-Bus. See the *D-BUS API* section below for more details.
# dbus = false

# Try to detect WM windows (a non-override-redirect window with no
# child that has 'WM_STATE') and mark them as active.
#
# mark-wmwin-focused = false
256
mark-wmwin-focused = true;
Jay Ta'ala's avatar
Jay Ta'ala committed
257
258
259

# Mark override-redirect windows that doesn't have a child window with 'WM_STATE' focused.
# mark-ovredir-focused = false
260
mark-ovredir-focused = true;
Jay Ta'ala's avatar
Jay Ta'ala committed
261
262
263
264
265

# Try to detect windows with rounded corners and don't consider them
# shaped windows. The accuracy is not very high, unfortunately.
#
# detect-rounded-corners = false
266

Jay Ta'ala's avatar
Jay Ta'ala committed
267
268
269
270
# Detect '_NET_WM_OPACITY' on client windows, useful for window managers
# not passing '_NET_WM_OPACITY' of client windows to frame windows.
#
# detect-client-opacity = false
271
272
detect-client-opacity = true;

Jay Ta'ala's avatar
Jay Ta'ala committed
273
274
275
276
# Specify refresh rate of the screen. If not specified or 0, picom will
# try detecting this with X RandR extension.
#
# refresh-rate = 60
277
278
refresh-rate = 0;

Jay Ta'ala's avatar
Jay Ta'ala committed
279
280
281
282
283
284
# Use EWMH '_NET_ACTIVE_WINDOW' to determine currently focused window,
# rather than listening to 'FocusIn'/'FocusOut' event. Might have more accuracy,
# provided that the WM supports it.
#
# use-ewmh-active-win = false
use-ewmh-active-win = true;
285

Jay Ta'ala's avatar
Jay Ta'ala committed
286
287
288
289
290
# Unredirect all windows if a full-screen opaque window is detected,
# to maximize performance for full-screen windows. Known to cause flickering
# when redirecting/unredirecting windows.
#
# unredir-if-possible = false
291

Jay Ta'ala's avatar
Jay Ta'ala committed
292
293
# Delay before unredirecting the window, in milliseconds. Defaults to 0.
# unredir-if-possible-delay = 0
294

Jay Ta'ala's avatar
Jay Ta'ala committed
295
296
# Conditions of windows that shouldn't be considered full-screen for unredirecting screen.
# unredir-if-possible-exclude = []
297

Jay Ta'ala's avatar
Jay Ta'ala committed
298
299
300
301
# Use 'WM_TRANSIENT_FOR' to group windows, and consider windows
# in the same group focused at the same time.
#
# detect-transient = false
302
303
detect-transient = true;

Jay Ta'ala's avatar
Jay Ta'ala committed
304
305
306
307
# Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same
# group focused at the same time. This usually means windows from the same application
# will be considered focused or unfocused at the same time.
# 'WM_TRANSIENT_FOR' has higher priority if detect-transient is enabled, too.
308
#
Jay Ta'ala's avatar
Jay Ta'ala committed
309
# detect-client-leader = false
Jay Ta'ala's avatar
Jay Ta'ala committed
310
detect-client-leader = true;
Jay Ta'ala's avatar
Jay Ta'ala committed
311
312
313
314
315
316
317
318
319
320
321

# Resize damaged region by a specific number of pixels.
# A positive value enlarges it while a negative one shrinks it.
# If the value is positive, those additional pixels will not be actually painted
# to screen, only used in blur calculation, and such. (Due to technical limitations,
# with use-damage, those pixels will still be incorrectly painted to screen.)
# Primarily used to fix the line 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 you use `--resize-damage 2`, and so on).
# May or may not work with *--glx-no-stencil*. Shrinking doesn't function correctly.
322
#
Jay Ta'ala's avatar
Jay Ta'ala committed
323
# resize-damage = 1
324

Jay Ta'ala's avatar
Jay Ta'ala committed
325
326
327
328
# Specify a list of conditions of windows that should be painted with inverted color.
# Resource-hogging, and is not well tested.
#
# invert-color-include = []
329

Jay Ta'ala's avatar
Jay Ta'ala committed
330
331
332
333
# GLX backend: Avoid using stencil buffer, useful if you don't have a stencil buffer.
# Might cause incorrect opacity when rendering transparent content (but never
# practically happened) and may not work with blur-background.
# My tests show a 15% performance boost. Recommended.
334
#
Jay Ta'ala's avatar
Jay Ta'ala committed
335
336
337
338
339
340
# glx-no-stencil = false

# GLX backend: Avoid rebinding pixmap on window damage.
# Probably could improve performance on rapid window content changes,
# but is known to break things on some drivers (LLVMpipe, xf86-video-intel, etc.).
# Recommended if it works.
341
#
Jay Ta'ala's avatar
Jay Ta'ala committed
342
# glx-no-rebind-pixmap = false
343

Jay Ta'ala's avatar
Jay Ta'ala committed
344
345
346
347
348
349
350
351
352
353
354
355
356
# Disable the use of damage information.
# This cause the whole screen to be redrawn everytime, instead of the part of the screen
# has actually changed. Potentially degrades the performance, but might fix some artifacts.
# The opposing option is use-damage
#
# no-use-damage = false
use-damage = true;

# 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 for some users.
#
# xrender-sync-fence = false
357
xrender-sync-fence = true;
Jay Ta'ala's avatar
Jay Ta'ala committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448

# GLX backend: Use specified GLSL fragment shader for rendering window contents.
# See `compton-default-fshader-win.glsl` and `compton-fake-transparency-fshader-win.glsl`
# in the source tree for examples.
#
# glx-fshader-win = ""

# Force all windows to be painted with blending. Useful if you
# have a glx-fshader-win that could turn opaque pixels transparent.
#
# force-win-blend = false

# Do not use EWMH to detect fullscreen windows.
# Reverts to checking if a window is fullscreen based only on its size and coordinates.
#
# no-ewmh-fullscreen = false

# Dimming bright windows so their brightness doesn't exceed this set value.
# Brightness of a window is estimated by averaging all pixels in the window,
# so this could comes with a performance hit.
# Setting this to 1.0 disables this behaviour. Requires --use-damage to be disabled. (default: 1.0)
#
# max-brightness = 1.0

# Make transparent windows clip other windows like non-transparent windows do,
# instead of blending on top of them.
#
# transparent-clipping = false

# Set the log level. Possible values are:
#  "trace", "debug", "info", "warn", "error"
# in increasing level of importance. 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 of logs.
#
# log-level = "debug"
log-level = "warn";

# Set the log file.
# If *--log-file* is never specified, logs will be written to stderr.
# Otherwise, logs will to written to the given file, though some of the early
# logs might still be written to the stderr.
# When setting this option from the config file, it is recommended to use an absolute path.
#
# log-file = "/path/to/your/log/file"

# Show all X errors (for debugging)
# show-all-xerrors = false

# Write process ID to a file.
# write-pid-path = "/path/to/your/log/file"

# Window type settings
#
# 'WINDOW_TYPE' is one of the 15 window types defined in EWMH standard:
#     "unknown", "desktop", "dock", "toolbar", "menu", "utility",
#     "splash", "dialog", "normal", "dropdown_menu", "popup_menu",
#     "tooltip", "notification", "combo", and "dnd".
#
# Following per window-type options are available: ::
#
#   fade, shadow:::
#     Controls window-type-specific shadow and fade settings.
#
#   opacity:::
#     Controls default opacity of the window type.
#
#   focus:::
#     Controls whether the window of this type is to be always considered focused.
#     (By default, all window types except "normal" and "dialog" has this on.)
#
#   full-shadow:::
#     Controls whether shadow is drawn under the parts of the window that you
#     normally won't be able to see. Useful when the window has parts of it
#     transparent, and you want shadows in those areas.
#
#   clip-shadow-above:::
#     Controls wether shadows that would have been drawn above the window should
#     be clipped. Useful for dock windows that should have no shadow painted on top.
#
#   redir-ignore:::
#     Controls whether this type of windows should cause screen to become
#     redirected again after been unredirected. If you have unredir-if-possible
#     set, and doesn't want certain window to cause unnecessary screen redirection,
#     you can set this to `true`.
#
wintypes:
{
  tooltip = { fade = true; shadow = true; opacity = 0.75; focus = true; full-shadow = false; };
  dock = { shadow = false; clip-shadow-above = true; }
  dnd = { shadow = false; }
Jay Ta'ala's avatar
Jay Ta'ala committed
449
450
  #popup_menu = { opacity = 0.8; }
  #dropdown_menu = { opacity = 0.8; }
Jay Ta'ala's avatar
Jay Ta'ala committed
451
};