1
1
mirror of https://github.com/wez/wezterm.git synced 2024-11-13 07:22:52 +03:00
wezterm/docs
Wez Furlong 7f82f333f1 wezterm: revise opacity configuration
This commit revises the opacity configuration to make it more
consistently applied.

* `window_background_opacity` controls the overall window capacity,
  whether a background image is present or not.
* When a background image is present, or if the window is transparent,
  then text whose background color is the default background is
  changed to have a fully transparent background.
* `text_background_opacity` controls the alpha channel value for
  text whose background color is NOT the default background.
  It defaults to 1.0 (fully opaque), but can be set to be
  transparent by setting it to a number between 0.0 and 1.0.
* The inactive pane hue, saturation, brightness multipliers
  have been factored out into their own struct which changes
  that set of options to:

```lua
return {
  inactive_pane_hsb = {
    hue = 1.0,
    saturation = 1.0,
    brightness = 1.0,
  },
}
```

* `window_background_image_hsb` is a new option that can apply
  a hue, saturation, brightness transformation to a background
  image.  This is primarily useful to make a background image
  darker:

```lua
return {
  window_background_image = "/some/pic.png",
  window_background_image_hsb = {
    brightness = 0.3,
  },
}
```

refs: #302
refs: #297
2020-10-23 23:16:00 -07:00
..
colorschemes docs: adjust screenshots to include cursor color 2020-10-20 09:55:32 -07:00
config wezterm: revise opacity configuration 2020-10-23 23:16:00 -07:00
install docs: fix typo 2020-07-18 10:16:51 -07:00
screenshots docs: add a screenshot demonstrating background image 2020-10-19 08:59:53 -07:00
_config.yml docs: switch to the "Hacker" theme which is darker 2019-12-18 09:25:36 -08:00
book.toml default to darker styling 2019-12-29 22:05:49 -08:00
changelog.markdown Update color schemes 2020-10-19 22:51:48 -07:00
contributing.markdown docs: link to the contributing file in the repo 2020-06-20 13:09:04 -07:00
copymode.markdown docs: update released version info for some newer features 2020-06-17 00:08:43 -07:00
custom.css style download buttons a bit better 2019-12-29 21:39:23 -08:00
faq.markdown docs: add some input troubleshooting info the FAQ 2020-06-25 07:15:57 -07:00
features.markdown docs: add splits/panes to features list 2020-10-10 10:52:15 -07:00
help.markdown docs: add a bit about contributing 2020-06-16 22:16:56 -07:00
hyperlinks.markdown docs: update for lua configuration syntax 2020-04-06 16:32:16 -07:00
imgcat.markdown add screenshot of imgcat 2019-12-31 18:33:24 -08:00
index.markdown docs: add splits/panes to features list 2020-10-10 10:52:15 -07:00
installation.markdown docs: split install page into pages by platform 2020-05-30 10:30:32 -07:00
lua.js docs: enable syntax highlighting for lua 2020-04-06 17:39:57 -07:00
multiplexing.markdown docs: more changelog updates 2020-10-13 20:26:27 -07:00
scrollback.markdown docs: update released version info for some newer features 2020-06-17 00:08:43 -07:00
serial.markdown docs: update for lua configuration syntax 2020-04-06 16:32:16 -07:00
shell-integration.markdown docs: more tweaks 2020-04-07 08:45:57 -07:00
ssh.markdown docs: update for lua configuration syntax 2020-04-06 16:32:16 -07:00