<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/config/win32_system_backdrop.md - fork/wezterm @ termwiz-0.23.0</title>
<meta name="description" content="docs/config/lua/config/win32_system_backdrop.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:title" content="docs/config/lua/config/win32_system_backdrop.md - fork/wezterm @ termwiz-0.23.0">
<meta property="og:description" content="docs/config/lua/config/win32_system_backdrop.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.0" data-tip="958804c8ac16b750954b3bcaaf847e7498cd2205">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="35df521f76cc64d7ed9e3957b939799756a29ca1">docs: update for release</span><span class="snapshot-sha sha" data-commit="35df521f76cc64d7ed9e3957b939799756a29ca1">35df521f7</span><time datetime="2023-07-12T07:46:13-07:00" title="2023-07-12 07:46:13 -0700">2023-07-12</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.0</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/lua/config/">config</a> / <span class="cur">win32_system_backdrop.md</span></nav>
<span class="view-stats"><span>1.8 KiB</span><span>62 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/4e4b09bd228f55549cdd8d4889a2e69d67959de3/docs/config/lua/config/win32_system_backdrop.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><hr />
<p>tags:</p>
<ul>
<li>appearance</li>
</ul>
<hr />
<h1><code>win32_system_backdrop = SETTING</code></h1>
<p>{{since('20230712-072601-f4abf8fd')}}</p>
<p>When combined with <code>window_background_opacity</code>, chooses from available
window background effects provided by Windows.</p>
<p>The possible values for <code>win32_system_backdrop</code> are:</p>
<ul>
<li><code>"Auto"</code> - the system chooses. In practice, this is the same as <code>"Disable"</code>. This is the default value.</li>
<li><code>"Disable"</code> - disable backdrop effects.</li>
<li><code>"Acrylic"</code> - enable the <em>Acrylic</em> blur-behind-window effect.  Available on Windows 10 and 11.</li>
<li><code>"Mica"</code> - enable the <em>Mica</em> effect, available on Windows 11 build 22621 and later.</li>
<li><code>"Tabbed"</code> - enable the <em>Tabbed</em> effect, available on Windows 11 build 22621 and later.</li>
</ul>
<p>On Windows systems earlier than build 22621, the <em>Acrylic</em> affect can be
adjusted using <a href="/fork/wezterm/ref/termwiz-0.23.0/blob/docs/config/lua/config/win32_acrylic_accent_color.md">win32_acrylic_accent_color</a>.
More recent versions of Windows do not permit configuring the accent color
for <em>Acrylic</em>, so that option has no effect there.</p>
<p>The <em>Acrylic</em> setting uses more resources than the others.</p>
<p>You need to reduce the <code>window_background_opacity</code> to a value lower than <code>1.0</code>
for the backdrop effect to work.  For best results with both <code>"Mica"</code> and
<code>"Tabbed"</code>, setting <code>window_background_opacity = 0</code> is recommended.</p>
<p>See also <a href="/fork/wezterm/ref/termwiz-0.23.0/blob/docs/config/lua/config/macos_window_background_blur.md">macos_window_background_blur</a> for
a similar effect on macOS.</p>
<h2>Acrylic</h2>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>window_background_opacity</a-v> = <a-n>0</a-n>
<a-v>config</a-v><a-p>.</a-p><a-v>win32_system_backdrop</a-v> = <a-s>&#39;Acrylic&#39;</a-s></pre>
<p><img src="/fork/wezterm/raw/616546bdfb1a78b5ddb9d0d0461f8a7d84d28b04/docs/screenshots/wezterm-acrylic.png" alt="Acrylic Effect" /></p>
<h2>Mica</h2>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>window_background_opacity</a-v> = <a-n>0</a-n>
<a-v>config</a-v><a-p>.</a-p><a-v>win32_system_backdrop</a-v> = <a-s>&#39;Mica&#39;</a-s></pre>
<p><img src="/fork/wezterm/raw/fdda18b429cfa21a4d28eae2d23e25322213e3cf/docs/screenshots/wezterm-mica.png" alt="Mica Effect" /></p>
<h2>Tabbed</h2>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>window_background_opacity</a-v> = <a-n>0</a-n>
<a-v>config</a-v><a-p>.</a-p><a-v>win32_system_backdrop</a-v> = <a-s>&#39;Tabbed&#39;</a-s></pre>
<p><img src="/fork/wezterm/raw/b68bd8b1065c579b461281546df7d5200208db05/docs/screenshots/wezterm-tabbed.png" alt="Tabbed Effect" /></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">  <a-p>-</a-p> <a-s>appearance</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>#</a-p> <a-tt>`win32_system_backdrop = SETTING`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">{{since(&#39;20230712-072601-f4abf8fd&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">When combined with `window_background_opacity`, chooses from available</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">window background effects provided by Windows.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">The possible values for `win32_system_backdrop` are:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>* </a-p>`&quot;Auto&quot;` - the system chooses. In practice, this is the same as `&quot;Disable&quot;`. This is the default value.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>* </a-p>`&quot;Disable&quot;` - disable backdrop effects.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>* </a-p>`&quot;Acrylic&quot;` - enable the *Acrylic* blur-behind-window effect.  Available on Windows 10 and 11.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>* </a-p>`&quot;Mica&quot;` - enable the *Mica* effect, available on Windows 11 build 22621 and later.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>* </a-p>`&quot;Tabbed&quot;` - enable the *Tabbed* effect, available on Windows 11 build 22621 and later.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>On Windows systems earlier than build 22621, the *Acrylic* affect can be</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>adjusted using [win32_acrylic_accent_color](win32_acrylic_accent_color.md).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>More recent versions of Windows do not permit configuring the accent color</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>for *Acrylic*, so that option has no effect there.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>The *Acrylic* setting uses more resources than the others.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>You need to reduce the `window_background_opacity` to a value lower than `1.0`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>for the backdrop effect to work.  For best results with both `&quot;Mica&quot;` and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>`&quot;Tabbed&quot;`, setting `window_background_opacity = 0` is recommended.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>See also [macos_window_background_blur](macos_window_background_blur.md) for</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>a similar effect on macOS.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>## </a-p><a-tt>Acrylic</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>config.</a-p><a-v>window_background_opacity</a-v><a-p> = </a-p><a-n>0</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>config.</a-p><a-v>win32_system_backdrop</a-v><a-p> = </a-p><a-s>&#39;Acrylic&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>![Acrylic Effect](../../../screenshots/wezterm-acrylic.png)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>## </a-p><a-tt>Mica</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>config.</a-p><a-v>window_background_opacity</a-v><a-p> = </a-p><a-n>0</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>config.</a-p><a-v>win32_system_backdrop</a-v><a-p> = </a-p><a-s>&#39;Mica&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>![Mica Effect](../../../screenshots/wezterm-mica.png)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>## </a-p><a-tt>Tabbed</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>config.</a-p><a-v>window_background_opacity</a-v><a-p> = </a-p><a-n>0</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>config.</a-p><a-v>win32_system_backdrop</a-v><a-p> = </a-p><a-s>&#39;Tabbed&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">![Tabbed Effect](../../../screenshots/wezterm-tabbed.png)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
