adds basic dimming functionality

- option to dim colors of unfocused views
- option to dim buffer background behind overlay components

helix-term/src/ui/overlay.rs

@@ -45,6 +45,10 @@ fn clip_rect_relative(rect: Rect, percent_horizontal: u8, percent_vertical: u8)
 
 impl<T: Component + 'static> Component for Overlay<T> {
  fn render(&mut self, area: Rect, frame: &mut Buffer, ctx: &mut Context) {
+ if let Some(op) = &ctx.editor.config().dim.overlay_backdrops {
+ // TODO: optimise. we don't need to dim behind the child content
+ frame.dim(area, op);
+ }
  let dimensions = (self.calc_child_size)(area);
  self.content.render(dimensions, frame, ctx)
  }

helix-tui/Cargo.toml

@@ -16,6 +16,7 @@ include = ["src/**/*", "README.md"]
 default = ["crossterm"]
 
 [dependencies]
+palette = "0.6"
 bitflags = "1.3"
 cassowary = "0.3"
 unicode-segmentation = "1.9"

helix-tui/src/buffer.rs

@@ -1,10 +1,11 @@
 use crate::text::{Span, Spans};
 use helix_core::unicode::width::UnicodeWidthStr;
+use helix_view::graphics::{Color, DimFunction, DimOperation, Modifier, Rect, Style};
+use palette::Shade;
 use std::cmp::min;
+use std::collections::HashMap;
 use unicode_segmentation::UnicodeSegmentation;
 
-use helix_view::graphics::{Color, Modifier, Rect, Style};
-
 /// A buffer cell
 #[derive(Debug, Clone, PartialEq)]
 pub struct Cell {
@@ -583,6 +584,58 @@ impl Buffer {
  }
  updates
  }
+
+ /// Apply DimOperation to all cells in area
+ pub fn dim(&mut self, area: Rect, op: &DimOperation) {
+ use DimFunction::*;
+
+ type Srgb8 = palette::rgb::Rgb<palette::encoding::Srgb, u8>;
+
+ let mut cache: HashMap<Color, Color> = HashMap::new();
+ let intensity = op.intensity as f32 / 100.0; // TODO: clamp
+
+ let mut modify = |col| {
+ let result = cache.entry(col).or_insert_with(|| {
+ if let Color::Rgb(r, g, b) = col {
+ let mut rgb = Srgb8::new(r, g, b).into_format().into_linear();
+ rgb = match op.func {
+ Lighten => rgb.lighten(intensity),
+ Darken => rgb.darken(intensity),
+ _ => unimplemented!(),
+ };
+ let rgb = Srgb8::from(rgb).into_components();
+ Color::Rgb(rgb.0, rgb.1, rgb.2)
+ } else {
+ col
+ }
+ });
+ *result
+ };
+ for y in area.top()..area.bottom() {
+ for x in area.left()..area.right() {
+ let cell = &mut self[(x, y)];
+
+ match op.func {
+ Dim => {
+ cell.modifier.insert(Modifier::DIM);
+ }
+ Lighten | Darken => {
+ match cell.fg {
+ Color::Rgb(..) => {
+ cell.fg = modify(cell.fg);
+ }
+ _ => {
+ // cell.modifier.insert(Modifier::DIM);
+ }
+ };
+ if let Color::Rgb(..) = cell.bg {
+ cell.bg = modify(cell.bg);
+ }
+ }
+ }
+ }
+ }
+ }
 }
 
 impl std::ops::Index<(u16, u16)> for Buffer {

helix-view/src/editor.rs

@@ -1,7 +1,7 @@
 use crate::{
  clipboard::{get_clipboard_provider, ClipboardProvider},
  document::{Mode, SCRATCH_BUFFER_NAME},
- graphics::{CursorKind, Rect},
+ graphics::{CursorKind, DimOperation, Rect},
  info::Info,
  input::KeyEvent,
  theme::{self, Theme},
@@ -109,6 +109,15 @@ impl Default for FilePickerConfig {
  }
 }
 
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case", default, deny_unknown_fields)]
+pub struct DimConfig {
+ /// dim function for margin around content of dimmable overlays
+ pub overlay_backdrops: Option<DimOperation>,
+ /// dim function for unfocused editor views
+ pub unfocused_views: Option<DimOperation>,
+}
+
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "kebab-case", default, deny_unknown_fields)]
 pub struct Config {
@@ -163,6 +172,9 @@ pub struct Config {
  pub indent_guides: IndentGuidesConfig,
  /// Whether to color modes with different colors. Defaults to `false`.
  pub color_modes: bool,
+ /// Dim configuration
+ #[serde(default)]
+ pub dim: DimConfig,
 }
 
 #[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
@@ -417,6 +429,7 @@ impl Default for Config {
  whitespace: WhitespaceConfig::default(),
  indent_guides: IndentGuidesConfig::default(),
  color_modes: false,
+ dim: DimConfig::default(),
  }
  }
 }

helix-view/src/graphics.rs

@@ -5,6 +5,35 @@ use std::{
  str::FromStr,
 };
 
+#[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum DimFunction {
+ // Set text modifier DIM
+ Dim,
+ // Lighten the shade of an RGB color
+ Lighten,
+ // Darken the shade of an RGB color
+ Darken,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case", default, deny_unknown_fields)]
+pub struct DimOperation {
+ /// Function to perform on cells
+ pub func: DimFunction,
+ /// 0-100 Instensity of the applied function. Has no effect with DimFunction.Dim
+ pub intensity: u8,
+}
+
+impl Default for DimOperation {
+ fn default() -> Self {
+ Self {
+ func: DimFunction::Darken,
+ intensity: 50,
+ }
+ }
+}
+
 #[derive(Debug, Clone, Copy, PartialEq, Deserialize, Serialize)]
 #[serde(rename_all = "lowercase")]
 /// UNSTABLE
@@ -262,7 +291,7 @@ impl Rect {
  }
 }
 
-#[derive(Debug, Clone, Copy, PartialEq)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Color {
  Reset,