From da4389685e03c6da58895b6121ca0b475c30473f Mon Sep 17 00:00:00 2001 From: Yuxuan Shui Date: Sat, 3 Aug 2024 04:11:37 +0100 Subject: [PATCH] docs: update picom.sample.conf Removed old options that are no long relevant (though not deprecated). Converted all old rules to the new `rules` option. Signed-off-by: Yuxuan Shui --- picom.sample.conf | 339 ++++++++++++++++------------------------------ 1 file changed, 118 insertions(+), 221 deletions(-) diff --git a/picom.sample.conf b/picom.sample.conf index c605af15..ba9e3ddb 100644 --- a/picom.sample.conf +++ b/picom.sample.conf @@ -2,56 +2,45 @@ # Shadows # ################################# - # 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. # -# shadow = false +# Can be set per-window using rules. +# +# Default: false shadow = true; -# The blur radius for shadows, in pixels. (defaults to 12) -# shadow-radius = 12 +# The blur radius for shadows, in pixels. +# +# Default: 12 shadow-radius = 7; -# The opacity of shadows. (0.0 - 1.0, defaults to 0.75) +# The opacity of shadows. +# +# Range: 0.0 - 1.0 +# Default: 0.75 # shadow-opacity = .75 -# The left offset for shadows, in pixels. (defaults to -15) -# shadow-offset-x = -15 +# The left offset for shadows, in pixels. +# +# Default: -15 shadow-offset-x = -7; -# The top offset for shadows, in pixels. (defaults to -15) -# shadow-offset-y = -15 +# The top offset for shadows, in pixels. +# +# Default: -15 shadow-offset-y = -7; -# 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) +# Hex string color value of shadow. Formatted like "#RRGGBB", e.g. "#C0FFEE". +# +# Default: #000000 # shadow-color = "#000000" -# Specify a list of conditions of windows that should have no shadow. -# shadow-exclude = [] -shadow-exclude = [ - "name = 'Notification'", - "class_g = 'Conky'", - "class_g ?= 'Notify-osd'", - "class_g = 'Cairo-clock'", - "_GTK_FRAME_EXTENTS@" -]; - -# Specify a list of conditions of windows that should have no shadow painted over, such as a dock window. -# clip-shadow-above = [] - # Crop shadow of a window fully on a particular monitor to that monitor. This is # currently implemented using the X RandR extension. +# +# Default: false # crop-shadow-to-monitor = false @@ -59,26 +48,21 @@ shadow-exclude = [ # Fading # ################################# - # Fade windows in/out when opening/closing and when opacity changes, -# unless no-fading-openclose is used. -# fading = false +# unless no-fading-openclose is used. Can be set per-window using rules. +# +# Default: 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 -# 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 @@ -90,41 +74,16 @@ fade-out-step = 0.03; # Transparency / Opacity # ################################# - -# Opacity of inactive windows. (0.1 - 1.0, defaults to 1.0) -# inactive-opacity = 1 -inactive-opacity = 0.8; - -# Opacity of window titlebars and borders. (0.1 - 1.0, disabled by default) -# frame-opacity = 1.0 +# Opacity of window titlebars and borders. +# +# Range: 0.1 - 1.0 +# Default: 1.0 (disabled) frame-opacity = 0.7; -# Let inactive opacity set by -i override the '_NET_WM_WINDOW_OPACITY' values of windows. -# inactive-opacity-override = true -inactive-opacity-override = false; - -# 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'" ]; # -# opacity-rule = [] - +# Default: false +# inactive-dim-fixed = true ################################# # Corners # @@ -133,21 +92,15 @@ focus-exclude = [ "class_g = 'Cairo-clock'" ]; # Sets the radius of rounded window corners. When > 0, the compositor will # round the corners of windows. Does not interact well with # `transparent-clipping`. +# +# Default: 0 (disabled) corner-radius = 0 -# Exclude conditions for rounded corners. -rounded-corners-exclude = [ - "window_type = 'dock'", - "window_type = 'desktop'" -]; - - ################################# -# Background-Blurring # +# Blur # ################################# - -# Parameters for background blurring, see the *BLUR* section for more information. +# Parameters for background blurring, see BLUR section in the man page for more information. # blur-method = # blur-size = 12 # @@ -156,108 +109,96 @@ rounded-corners-exclude = [ # 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. +# Can be set per-window using rules. # +# Default: false # 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. # +# Default: false # blur-background-frame = false - # Use fixed blur strength rather than adjusting according to window opacity. +# +# Default: false # 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"; +# Can also be a pre-defined kernel, see the man page. # -# blur-kern = "" +# Default: "" blur-kern = "3x3box"; - -# Exclude conditions for background blur. -# blur-background-exclude = [] -blur-background-exclude = [ - "window_type = 'dock'", - "window_type = 'desktop'", - "_GTK_FRAME_EXTENTS@" -]; - ################################# # General Settings # ################################# # Enable remote control via D-Bus. See the man page for more details. +# +# Default: false # dbus = true # Daemonize process. Fork to background after initialization. Causes issues with certain (badly-written) drivers. # daemon = false -# Specify the backend to use: `xrender`, `glx`, `egl` or `xr_glx_hybrid`. -# `xrender` is the default one. +# Specify the backend to use: `xrender`, `glx`, or `egl`. # -# backend = "glx" -backend = "xrender"; +# Default: "xrender" +backend = "glx" # Use higher precision during rendering, and apply dither when presenting the -# rendered screen. Reduces banding artifacts, but might cause performance +# rendered screen. Reduces banding artifacts, but may cause performance # degradation. Only works with OpenGL. dithered-present = false; # Enable/disable VSync. -# vsync = false -vsync = true; - -# 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 -mark-wmwin-focused = true; - -# Mark override-redirect windows that doesn't have a child window with 'WM_STATE' focused. -# mark-ovredir-focused = false -mark-ovredir-focused = true; +# Default: false +vsync = true; # 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 +# Has nothing to do with `corner-radius`. +# +# Default: false detect-rounded-corners = true; # Detect '_NET_WM_WINDOW_OPACITY' on client windows, useful for window managers # not passing '_NET_WM_WINDOW_OPACITY' of client windows to frame windows. # -# detect-client-opacity = false +# Default: false detect-client-opacity = true; # Use EWMH '_NET_ACTIVE_WINDOW' to determine currently focused window, -# rather than listening to 'FocusIn'/'FocusOut' event. Might have more accuracy, +# rather than listening to 'FocusIn'/'FocusOut' event. May be more accurate, # provided that the WM supports it. # +# Default: false # use-ewmh-active-win = false # 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. # +# Default: false # unredir-if-possible = false -# Delay before unredirecting the window, in milliseconds. Defaults to 0. +# Delay before unredirecting the window, in milliseconds. +# +# Default: 0. # unredir-if-possible-delay = 0 -# Conditions of windows that shouldn't be considered full-screen for unredirecting screen. -# unredir-if-possible-exclude = [] - # Use 'WM_TRANSIENT_FOR' to group windows, and consider windows # in the same group focused at the same time. # -# detect-transient = false +# Default: false detect-transient = true; # Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same @@ -265,102 +206,67 @@ detect-transient = true; # will be considered focused or unfocused at the same time. # 'WM_TRANSIENT_FOR' has higher priority if detect-transient is enabled, too. # +# Default: false # detect-client-leader = false -# 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. +# Use of damage information for rendering. This cause the only the part of the +# screen that has actually changed to be redrawn, instead of the whole screen +# every time. Should improve performance. # -# resize-damage = 1 - -# Specify a list of conditions of windows that should be painted with inverted color. -# Resource-hogging, and is not well tested. -# -# invert-color-include = [] - -# 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. -# -# 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. -# -# glx-no-rebind-pixmap = false - -# 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 changed. Potentially degrades the performance, but might fix some artifacts. -# The opposing option is use-damage -# -# no-use-damage = false +# Default: 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. +# Use X Sync fence to wait for the completion of rendering of other windows, +# before using their content to render the current screen. # +# Required for explicit sync drivers, such as nvidia. +# +# Default: false # xrender-sync-fence = false # GLX backend: Use specified GLSL fragment shader for rendering window # contents. Read the man page for a detailed explanation of the interface. # +# Can be set per-window using rules. +# # window-shader-fg = "default" -# Use rules to set per-window shaders. Syntax is SHADER_PATH:PATTERN, similar -# to opacity-rule. SHADER_PATH can be "default". This overrides window-shader-fg. -# -# window-shader-fg-rule = [ -# "my_shader.frag:window_type != 'dock'" -# ] - # Force all windows to be painted with blending. Useful if you -# have a glx-fshader-win that could turn opaque pixels transparent. +# have a `window-shader-fg` that could turn opaque pixels transparent. # +# Default: false # 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. # +# Default: false # 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) +# Setting this to 1.0 disables this behaviour. Requires --use-damage to be disabled. # +# Default: 1.0 (disabled) # max-brightness = 1.0 # 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. e.g. placing a transparent window on top +# of another window will cut a "hole" in that window, and show the desktop background +# underneath. # +# Default: false # transparent-clipping = false -# Specify a list of conditions of windows that should never have transparent -# clipping applied. Useful for screenshot tools, where you need to be able to -# see through transparent parts of the window. -# -# transparent-clipping-exclude = [] - # Set the log level. Possible values are: # "trace", "debug", "info", "warn", "error" -# in increasing level of importance. Case doesn't matter. +# in increasing level of importance. Case insensitive. # 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"; +# Default: "warn" +# log-level = "warn"; # Set the log file. # If *--log-file* is never specified, logs will be written to stderr. @@ -370,51 +276,42 @@ log-level = "warn"; # # 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 +# Rule-based per-window options. # -# '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". +# See WINDOW RULES section in the man page for how these work. +rules: ({ + match = "window_type = 'tooltip'"; + fade = false; + shadow = true; + opacity = 0.75; + full-shadow = false; +}, { + match = "window_type = 'dock' || " + "window_type = 'desktop' || " + "_GTK_FRAME_EXTENTS@"; + blur-background = false; +}, { + match = "window_type != 'dock'"; + # shader = "my_shader.frag"; +}, { + match = "window_type = 'dock' || " + "window_type = 'desktop'"; + corner-radius = 0; +}, { + match = "name = 'Notification' || " + "class_g = 'Conky' || " + "class_g ?= 'Notify-osd' || " + "class_g = 'Cairo-clock' || " + "_GTK_FRAME_EXTENTS@"; + shadow = false; +}) + +# `@include` directive can be used to include additional configuration files. +# Relative paths are search either in the parent of this configuration file +# (when the configuration is loaded through a symlink, the symlink will be +# resolved first). Or in `$XDG_CONFIG_HOME/picom/include`. # -# 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 whether 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; } - popup_menu = { opacity = 0.8; } - dropdown_menu = { opacity = 0.8; } -}; +# @include "extra.conf"