From 6b94252da601ca7727d474fc78b1905e714d3fd4 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Wed, 13 Dec 2023 18:54:36 -0800 Subject: [PATCH] config: docs --- src/config/Config.zig | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/config/Config.zig b/src/config/Config.zig index 7fcae46b6..1f930ed74 100644 --- a/src/config/Config.zig +++ b/src/config/Config.zig @@ -314,8 +314,11 @@ palette: Palette = .{}, /// clamped to the nearest valid value. @"unfocused-split-opacity": f64 = 0.85, -// The color to dim the unfocused split. -@"unfocused-split-fill": Color = Color{ .r = 255, .g = 255, .b = 255 }, +// The color to dim the unfocused split. Unfocused splits are dimmed by +// rendering a semi-transparent rectangle over the split. This sets +// the color of that rectangle and can be used to carefully control +// the dimming effect. +@"unfocused-split-fill": Color = .{ .r = 255, .g = 255, .b = 255 }, /// The command to run, usually a shell. If this is not an absolute path, /// it'll be looked up in the PATH. If this is not set, a default will @@ -1982,6 +1985,9 @@ pub const OptionAsAlt = enum { }; /// Color represents a color using RGB. +/// +/// This is a packed struct so that the C API to read color values just +/// works by setting it to a C integer. pub const Color = packed struct(u24) { r: u8, g: u8,