23a9d2613050a54307c768605d125facbae00bf6
[dotfiles.git] / .config / picom / picom.conf
1 #################################
2 #             Shadows           #
3 #################################
4
5
6 # Enabled client-side shadows on windows. Note desktop windows 
7 # (windows with '_NET_WM_WINDOW_TYPE_DESKTOP') never get shadow, 
8 # unless explicitly requested using the wintypes option.
9 #
10 shadow = false
11
12 # The blur radius for shadows, in pixels. (defaults to 12)
13 # shadow-radius = 12
14 shadow-radius = 7;
15
16 # The opacity of shadows. (0.0 - 1.0, defaults to 0.75)
17 # shadow-opacity = .75
18
19 # The left offset for shadows, in pixels. (defaults to -15)
20 # shadow-offset-x = -15
21 shadow-offset-x = -7;
22
23 # The top offset for shadows, in pixels. (defaults to -15)
24 # shadow-offset-y = -15
25 shadow-offset-y = -7;
26
27 # Avoid drawing shadows on dock/panel windows. This option is deprecated,
28 # you should use the *wintypes* option in your config file instead.
29 #
30 # no-dock-shadow = false
31
32 # Don't draw shadows on drag-and-drop windows. This option is deprecated, 
33 # you should use the *wintypes* option in your config file instead.
34 #
35 # no-dnd-shadow = false
36
37 # Red color value of shadow (0.0 - 1.0, defaults to 0).
38 # shadow-red = 0
39
40 # Green color value of shadow (0.0 - 1.0, defaults to 0).
41 # shadow-green = 0
42
43 # Blue color value of shadow (0.0 - 1.0, defaults to 0).
44 # shadow-blue = 0
45
46 # Do not paint shadows on shaped windows. Note shaped windows 
47 # here means windows setting its shape through X Shape extension. 
48 # Those using ARGB background is beyond our control. 
49 # Deprecated, use 
50 #   shadow-exclude = 'bounding_shaped'
51 # or 
52 #   shadow-exclude = 'bounding_shaped && !rounded_corners'
53 # instead.
54 #
55 # shadow-ignore-shaped = ''
56
57 # Specify a list of conditions of windows that should have no shadow.
58 #
59 # examples:
60 #   shadow-exclude = "n:e:Notification";
61 #
62 # shadow-exclude = []
63 shadow-exclude = [
64   "name = 'Notification'",
65   "class_g = 'Conky'",
66   "class_g ?= 'Notify-osd'",
67   "class_g = 'Cairo-clock'",
68   "_GTK_FRAME_EXTENTS@:c"
69 ];
70
71 # Specify a X geometry that describes the region in which shadow should not
72 # be painted in, such as a dock window region. Use 
73 #    shadow-exclude-reg = "x10+0+0"
74 # for example, if the 10 pixels on the bottom of the screen should not have shadows painted on.
75 #
76 # shadow-exclude-reg = "" 
77
78 # Crop shadow of a window fully on a particular Xinerama screen to the screen.
79 # xinerama-shadow-crop = false
80
81
82 #################################
83 #           Fading              #
84 #################################
85
86
87 # Fade windows in/out when opening/closing and when opacity changes,
88 #  unless no-fading-openclose is used.
89 # fading = false
90 fading = false
91
92 # Opacity change between steps while fading in. (0.01 - 1.0, defaults to 0.028)
93 # fade-in-step = 0.028
94 fade-in-step = 0.03;
95
96 # Opacity change between steps while fading out. (0.01 - 1.0, defaults to 0.03)
97 # fade-out-step = 0.03
98 fade-out-step = 0.03;
99
100 # The time between steps in fade step, in milliseconds. (> 0, defaults to 10)
101 # fade-delta = 10
102
103 # Specify a list of conditions of windows that should not be faded.
104 # fade-exclude = []
105
106 # Do not fade on window open/close.
107 no-fading-openclose = true
108
109 # Do not fade destroyed ARGB windows with WM frame. Workaround of bugs in Openbox, Fluxbox, etc.
110 # no-fading-destroyed-argb = false
111
112
113 #################################
114 #   Transparency / Opacity      #
115 #################################
116
117
118 # Opacity of inactive windows. (0.1 - 1.0, defaults to 1.0)
119 # inactive-opacity = 1
120 inactive-opacity = 0.8;
121
122 # Opacity of window titlebars and borders. (0.1 - 1.0, disabled by default)
123 # frame-opacity = 1.0
124 frame-opacity = 0.7;
125
126 # Default opacity for dropdown menus and popup menus. (0.0 - 1.0, defaults to 1.0)
127 # menu-opacity = 1.0
128
129 # Let inactive opacity set by -i override the '_NET_WM_OPACITY' values of windows.
130 # inactive-opacity-override = true
131 inactive-opacity-override = false;
132
133 # Default opacity for active windows. (0.0 - 1.0, defaults to 1.0)
134 # active-opacity = 1.0
135
136 # Dim inactive windows. (0.0 - 1.0, defaults to 0.0)
137 # inactive-dim = 0.0
138
139 # Specify a list of conditions of windows that should always be considered focused.
140 # focus-exclude = []
141 focus-exclude = [ "class_g = 'Cairo-clock'" ];
142
143 # Use fixed inactive dim value, instead of adjusting according to window opacity.
144 # inactive-dim-fixed = 1.0
145
146 # Specify a list of opacity rules, in the format `PERCENT:PATTERN`, 
147 # like `50:name *= "Firefox"`. picom-trans is recommended over this. 
148 # Note we don't make any guarantee about possible conflicts with other 
149 # programs that set '_NET_WM_WINDOW_OPACITY' on frame or client windows.
150 # example:
151 opacity-rule = [ 
152     "97:class_g = 'St'", 
153     "97:class_g = 'Zathura'"
154 ];
155
156
157 #################################
158 #     Background-Blurring       #
159 #################################
160
161
162 # Parameters for background blurring, see the *BLUR* section for more information.
163 # blur-method = 
164 # blur-size = 12
165 #
166 # blur-deviation = false
167
168 # Blur background of semi-transparent / ARGB windows. 
169 # Bad in performance, with driver-dependent behavior. 
170 # The name of the switch may change without prior notifications.
171 #
172 # blur-background = false
173
174 # Blur background of windows when the window frame is not opaque. 
175 # Implies:
176 #    blur-background 
177 # Bad in performance, with driver-dependent behavior. The name may change.
178 #
179 # blur-background-frame = false
180
181
182 # Use fixed blur strength rather than adjusting according to window opacity.
183 # blur-background-fixed = false
184
185
186 # Specify the blur convolution kernel, with the following format:
187 # example:
188 #   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";
189 #
190 # blur-kern = ''
191 blur-kern = "3x3box";
192
193
194 # Exclude conditions for background blur.
195 # blur-background-exclude = []
196 blur-background-exclude = [
197   "window_type = 'dock'",
198   "window_type = 'desktop'",
199   "_GTK_FRAME_EXTENTS@:c"
200 ];
201
202 #################################
203 #       General Settings        #
204 #################################
205
206 # Daemonize process. Fork to background after initialization. Causes issues with certain (badly-written) drivers.
207 # daemon = false
208
209 # Specify the backend to use: `xrender`, `glx`, or `xr_glx_hybrid`.
210 # `xrender` is the default one.
211 #
212 # backend = 'glx'
213 backend = "xrender";
214
215 # Enable/disable VSync.
216 # vsync = false
217 vsync = true
218
219 # Enable remote control via D-Bus. See the *D-BUS API* section below for more details.
220 # dbus = false
221
222 # Try to detect WM windows (a non-override-redirect window with no 
223 # child that has 'WM_STATE') and mark them as active.
224 #
225 # mark-wmwin-focused = false
226 mark-wmwin-focused = true;
227
228 # Mark override-redirect windows that doesn't have a child window with 'WM_STATE' focused.
229 # mark-ovredir-focused = false
230 mark-ovredir-focused = true;
231
232 # Try to detect windows with rounded corners and don't consider them 
233 # shaped windows. The accuracy is not very high, unfortunately.
234 #
235 # detect-rounded-corners = false
236 detect-rounded-corners = true;
237
238 # Detect '_NET_WM_OPACITY' on client windows, useful for window managers
239 # not passing '_NET_WM_OPACITY' of client windows to frame windows.
240 #
241 # detect-client-opacity = false
242 detect-client-opacity = true;
243
244 # Specify refresh rate of the screen. If not specified or 0, picom will 
245 # try detecting this with X RandR extension.
246 #
247 # refresh-rate = 60
248 refresh-rate = 0
249
250 # Limit picom to repaint at most once every 1 / 'refresh_rate' second to 
251 # boost performance. This should not be used with 
252 #   vsync drm/opengl/opengl-oml
253 # as they essentially does sw-opti's job already, 
254 # unless you wish to specify a lower refresh rate than the actual value.
255 #
256 # sw-opti = 
257
258 # Use EWMH '_NET_ACTIVE_WINDOW' to determine currently focused window, 
259 # rather than listening to 'FocusIn'/'FocusOut' event. Might have more accuracy, 
260 # provided that the WM supports it.
261 #
262 # use-ewmh-active-win = false
263
264 # Unredirect all windows if a full-screen opaque window is detected, 
265 # to maximize performance for full-screen windows. Known to cause flickering 
266 # when redirecting/unredirecting windows.
267 #
268 # unredir-if-possible = false
269
270 # Delay before unredirecting the window, in milliseconds. Defaults to 0.
271 # unredir-if-possible-delay = 0
272
273 # Conditions of windows that shouldn't be considered full-screen for unredirecting screen.
274 # unredir-if-possible-exclude = []
275
276 # Use 'WM_TRANSIENT_FOR' to group windows, and consider windows 
277 # in the same group focused at the same time.
278 #
279 # detect-transient = false
280 detect-transient = true
281
282 # Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same 
283 # group focused at the same time. 'WM_TRANSIENT_FOR' has higher priority if 
284 # detect-transient is enabled, too.
285 #
286 # detect-client-leader = false
287 detect-client-leader = true
288
289 # Resize damaged region by a specific number of pixels. 
290 # A positive value enlarges it while a negative one shrinks it. 
291 # If the value is positive, those additional pixels will not be actually painted 
292 # to screen, only used in blur calculation, and such. (Due to technical limitations, 
293 # with use-damage, those pixels will still be incorrectly painted to screen.) 
294 # Primarily used to fix the line corruption issues of blur, 
295 # in which case you should use the blur radius value here 
296 # (e.g. with a 3x3 kernel, you should use `--resize-damage 1`, 
297 # with a 5x5 one you use `--resize-damage 2`, and so on). 
298 # May or may not work with *--glx-no-stencil*. Shrinking doesn't function correctly.
299 #
300 # resize-damage = 1
301
302 # Specify a list of conditions of windows that should be painted with inverted color. 
303 # Resource-hogging, and is not well tested.
304 #
305 # invert-color-include = []
306
307 # GLX backend: Avoid using stencil buffer, useful if you don't have a stencil buffer. 
308 # Might cause incorrect opacity when rendering transparent content (but never 
309 # practically happened) and may not work with blur-background. 
310 # My tests show a 15% performance boost. Recommended.
311 #
312 # glx-no-stencil = false
313
314 # GLX backend: Avoid rebinding pixmap on window damage. 
315 # Probably could improve performance on rapid window content changes, 
316 # but is known to break things on some drivers (LLVMpipe, xf86-video-intel, etc.).
317 # Recommended if it works.
318 #
319 # glx-no-rebind-pixmap = false
320
321 # Disable the use of damage information. 
322 # This cause the whole screen to be redrawn everytime, instead of the part of the screen
323 # has actually changed. Potentially degrades the performance, but might fix some artifacts.
324 # The opposing option is use-damage
325 #
326 # no-use-damage = false
327 use-damage = true
328
329 # Use X Sync fence to sync clients' draw calls, to make sure all draw 
330 # calls are finished before picom starts drawing. Needed on nvidia-drivers 
331 # with GLX backend for some users.
332 #
333 # xrender-sync-fence = false
334
335 # GLX backend: Use specified GLSL fragment shader for rendering window contents. 
336 # See `compton-default-fshader-win.glsl` and `compton-fake-transparency-fshader-win.glsl` 
337 # in the source tree for examples.
338 #
339 # glx-fshader-win = ''
340
341 # Force all windows to be painted with blending. Useful if you 
342 # have a glx-fshader-win that could turn opaque pixels transparent.
343 #
344 # force-win-blend = false
345
346 # Do not use EWMH to detect fullscreen windows. 
347 # Reverts to checking if a window is fullscreen based only on its size and coordinates.
348 #
349 # no-ewmh-fullscreen = false
350
351 # Dimming bright windows so their brightness doesn't exceed this set value. 
352 # Brightness of a window is estimated by averaging all pixels in the window, 
353 # so this could comes with a performance hit. 
354 # Setting this to 1.0 disables this behaviour. Requires --use-damage to be disabled. (default: 1.0)
355 #
356 # max-brightness = 1.0
357
358 # Make transparent windows clip other windows like non-transparent windows do,
359 # instead of blending on top of them.
360 #
361 # transparent-clipping = false
362
363 # Set the log level. Possible values are:
364 #  "trace", "debug", "info", "warn", "error"
365 # in increasing level of importance. Case doesn't matter. 
366 # If using the "TRACE" log level, it's better to log into a file 
367 # using *--log-file*, since it can generate a huge stream of logs.
368 #
369 # log-level = "debug"
370 log-level = "warn";
371
372 # Set the log file.
373 # If *--log-file* is never specified, logs will be written to stderr. 
374 # Otherwise, logs will to written to the given file, though some of the early 
375 # logs might still be written to the stderr. 
376 # When setting this option from the config file, it is recommended to use an absolute path.
377 #
378 # log-file = '/path/to/your/log/file'
379
380 # Show all X errors (for debugging)
381 # show-all-xerrors = false
382
383 # Write process ID to a file.
384 # write-pid-path = '/path/to/your/log/file'
385
386 # Window type settings
387
388 # 'WINDOW_TYPE' is one of the 15 window types defined in EWMH standard: 
389 #     "unknown", "desktop", "dock", "toolbar", "menu", "utility", 
390 #     "splash", "dialog", "normal", "dropdown_menu", "popup_menu", 
391 #     "tooltip", "notification", "combo", and "dnd".
392
393 # Following per window-type options are available: ::
394
395 #   fade, shadow:::
396 #     Controls window-type-specific shadow and fade settings.
397
398 #   opacity:::
399 #     Controls default opacity of the window type.
400
401 #   focus:::
402 #     Controls whether the window of this type is to be always considered focused. 
403 #     (By default, all window types except "normal" and "dialog" has this on.)
404
405 #   full-shadow:::
406 #     Controls whether shadow is drawn under the parts of the window that you 
407 #     normally won't be able to see. Useful when the window has parts of it 
408 #     transparent, and you want shadows in those areas.
409
410 #   redir-ignore:::
411 #     Controls whether this type of windows should cause screen to become 
412 #     redirected again after been unredirected. If you have unredir-if-possible
413 #     set, and doesn't want certain window to cause unnecessary screen redirection, 
414 #     you can set this to `true`.
415 #
416 wintypes:
417 {
418   tooltip = { fade = true; shadow = true; opacity = 0.75; focus = true; full-shadow = false; };
419   dock = { shadow = false; }
420   dnd = { shadow = false; }
421   popup_menu = { opacity = 0.8; }
422   dropdown_menu = { opacity = 0.8; }
423 };