Skip to content

Commit

Permalink
config: deprecate resize-damage
Browse files Browse the repository at this point in the history
It only works with the legacy backends, which were removed.

Signed-off-by: Yuxuan Shui <[email protected]>
  • Loading branch information
yshui committed Oct 14, 2024
1 parent 841dca0 commit eaa7723
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
3 changes: 0 additions & 3 deletions man/picom.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,6 @@ May also be one of the predefined kernels: `3x3box` (default), `5x5box`, `7x7box
[[blur-background-exclude]]*--blur-background-exclude* _CONDITION_::
Exclude conditions for background blur.

*--resize-damage* _INTEGER_::
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*. Only works with *--legacy-backends*. Shrinking doesn't function correctly.

[[invert-color-include]]*--invert-color-include* _CONDITION_::
Specify a list of conditions of windows that should be painted with inverted color. Resource-hogging, and is not well tested. Using this is discouraged, see the xref:_window_rules[*WINDOW RULES*] section for the recommended way to do this.

Expand Down
5 changes: 4 additions & 1 deletion src/config_libconfig.c
Original file line number Diff line number Diff line change
Expand Up @@ -1049,7 +1049,10 @@ bool parse_config_libconfig(options_t *opt, const char *config_file) {
}
}
// --resize-damage
config_lookup_int(&cfg, "resize-damage", &opt->resize_damage);
if (config_lookup_int(&cfg, "resize-damage", &opt->resize_damage)) {
log_warn("resize-damage is deprecated. Please remove it from your "
"configuration file.");
}
// --glx-no-stencil
lcfg_lookup_bool(&cfg, "glx-no-stencil", &opt->glx_no_stencil);
// --glx-no-rebind-pixmap
Expand Down
2 changes: 1 addition & 1 deletion src/options.c
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,7 @@ static const struct picom_option picom_options[] = {
[283] = {"blur-background" , FIXED(blur_method, BLUR_METHOD_KERNEL) , "Blur background of semi-transparent / ARGB windows. May impact performance"},
[290] = {"backend" , DO(store_backend) , "Backend. Possible values are: " BACKENDS},
[293] = {"benchmark" , INTEGER(benchmark, 0, INT_MAX) , "Benchmark mode. Repeatedly paint until reaching the specified cycles."},
[302] = {"resize-damage" , INTEGER(resize_damage, INT_MIN, INT_MAX)}, // only used by legacy backends
[302] = {"resize-damage" , WARN_DEPRECATED(INTEGER(resize_damage, INT_MIN, INT_MAX))}, // only used by legacy backends
[309] = {"unredir-if-possible-delay" , INTEGER(unredir_if_possible_delay, 0, INT_MAX) , "Delay before unredirecting the window, in milliseconds. Defaults to 0."},
[310] = {"write-pid-path" , NAMED_STRING(write_pid_path, "PATH") , "Write process ID to a file."},
[322] = {"log-file" , STRING(logpath) , "Path to the log file."},
Expand Down

0 comments on commit eaa7723

Please sign in to comment.