Hypr-DarkWindow

Hyprland plugin that adds the possibility to modify the fragment shader of specific windows.

Important

The main branch is always™ up to date with Hyprlands main branch, if you are using a release version of Hyprland check the Readme of the specific tag.

Shaders

Note

You can only have one shader applied at the same time. Applying a shader to a window which already has one applied will override the first one. Shaders that were applied using a dispatcher take priority over windowrule shaders.

There are few shaders already included in this plugin. All of them get loaded with the plugin, if you want to only load specific ones you can limit the shaders that are loaded.

hl.config({
    plugin = {
        darkwindow = {
            load_shaders = "invert, tint" -- defaults to "all"
            load_shaders = "" -- dont load any default shaders
        },
    }
})

Name	Description
invert	No uniforms Applies smart color inversion
tint	tintStrength = float (0-1) tintColor = vec3 Tints the Window
chromakey	bkg = vec3 The background color of the Window similarity = float How many similar colors should be affected amount = float How much similar colors should be changed targetOpacity = float Target opacity for similar colors Applies opacity changes to pixels similar to one color

If you want to use your own Shaders, check this out.

Configuration

Lua

-- hyprland.lua

if hl.plugin.darkwindow ~= nil then
  -- To modify the uniforms of an already existing shader, create a new shader and set the uniforms you want
  hl.plugin.darkwindow.load_shader("tintRed", {
    from = "tint",
    args = "tintColor=[1 0 0] tintStrength=0.1",

    -- the predefined shaders support animations, but they are disabled by default, so
    -- window rules don't get animated, but you can override the animation speeds here
    fade_in_speed = 3 -- value in ds
    fade_out_speed = 3
  })

  -- Use a custom shader, see the section below (#custom-shaders) for how to write one
  hl.plugin.darkwindow.load_shader("chromakeyv2", {
    -- path to the file, relative to the current lua file
    path = "~/path/to/shader.glsl",
    -- or write the source inline
    source = [[
      void windowShader(inout vec4 color) {
          color.r = 1.;
      }
    ]],

    --  default arguments used in all instatiations
    args = {
      wow = { 1.0, 0 }
    },

    -- if you modify the alpha value make sure to set this value to true so hyprland knows it should enable blur
    introduces_transparency = true,

    -- the time it takes for the x_Fade{In, Out} uniforms to reach 1 (in ds)
    fade_in_speed = 3
    fade_out_speed = 3

    -- to stop floating point imprecissions, the x_Time variable has to be reset to 0 ever now and then (value in s)
    -- set this value to a multiple of the duration of one of your animation cycles
    -- (or a very large number if you just want a somewhat imprecise timestamp)
    animation_interval = 86400 -- by default daily
  })

  -- Then to apply the shader to a window you can use window rules
  hl.window_rule({
    match = { class = "pb250.exe" },
    ["darkwindow:shade"] = "invert",
  })

  -- Uniforms can also be passed on the fly
  hl.window_rule({
    match = { fullscreen = true },
    ["darkwindow:shade"] = hl.plugin.darkwindow.build_rule_effect({
      shader = "tint",
      args = {
        tintColor = { 0, .3, 0 }
      }
    })
  })

  -- Same for layers
  hl.layer_rule({
    match = { namespace = "waybar" },
    ["darkwindow:shade"] = hl.plugin.darkwindow.build_rule_effect({
      shader = "tint",
    }),
  })

  -- Or use a dispatcher
  hl.bind(mainMod .. " + I", hl.plugin.darkwindow.dsp_shade({
    shader = "invert",

    -- see https://wiki.hypr.land/Configuring/Basics/Dispatchers/#window
    -- if no window field is specified, it targets the active window
    window = "class:nemo",
  }))

  hl.bind(mainMod .. " + O", hl.plugin.darkwindow.dsp_shade({
    shader = "chromakey",

    -- also works with on the fly overriding
    args = {
      bkg={ 0.234, 0.234, 0.234 },
      targetOpacity=0.5
    }
    fade_in_speed = 3
    fade_out_speed = 3
  }))
end

Hyprlang

DEPRECATED: will get fixes until Hyprland stops supporting Hyprlang configs. But no new features will be backported.

# hyprland.conf

plugin:darkwindow {
  # To modify the uniforms of an already existing shader, create a new shader and set the uniforms you want
  shader[tintRed] {
      from = tint
      args = tintColor=[1 0 0] tintStrength=0.1
  }

  # Use a custom shader from a file
  shader[cool] {
      path = /path/to/shader.glsl # see the section below (#custom-shaders) for the content of this file
      args = wow=[1.0 0 0]
      introduces_transparency = true # if you modify the alpha value make sure to set this value to true so hyprland knows it should enable blur
  }
}

# Then to apply the shader to a window you can use window rules
windowrule = darkwindow:shade invert, match:class (pb170.exe)
# Uniforms can also be passed on the fly, but make sure to not use commas inside the arrays
windowrule = darkwindow:shade tint tintColor=[0 1 0], match:fullscreen true

# Or use a dispatcher
bind = $mainMod, T, darkwindow:shadeactive, tint tintColor=[0 0.5 1] tintStrength=0.3
# There is also a `darkwindow:shade WINDOW_REGEX SHADER_NAME` available (see https://wiki.hypr.land/Configuring/Basics/Dispatchers/#window)

Custom Shaders

To add custom shaders use the plugin:darkwindow:shader config category (see example above). The file at .path is a glsl file that should contain a void windowShader(inout vec4 color) function and uniform declarations for your .args. It can also contain more functions but be careful to not clash with names that are already used by hyprland.

The custom shader code will then be injected into the fragment shader used by hyprland. You can see examples of shaders by looking at the predefined shaders. Feel free to make a pull request to add your own shaders!

Special Variables

You can use these variables anywhere in your shader code. Do not add the uniform declarations. This plugin will automatically detect the used variables and set them at each render.

Name	Type	Description
x_Time	float	Time in seconds since the Shader was applied (mod animation_interval) using this will cause the entire window to rerender every frame
x_FadeIn	float (0 -> 1)	How much the Shader has Faded In, stays 1 after fading in finishes, check out fade_in_speed
x_FadeOut	float (0 -> 1)	How much the Shader has Faded Out, is 0 before starting to fade out, check out fade_out_speed
x_PixelPos	vec2	Position of the current pixel in window space (top left of the window is [0,0], monitor scaling already applied)
x_CursorPos	vec2	Position of the cursor, same coordinate space as x_PixelPos using this will cause the entire window to rerender every time the mouse is moved
x_WindowSize	vec2	Size of the current window, same scaling as x_PixelPos
x_MonitorScale	float	Scaling of the monitor as seen in hyprctl monitors
x_Texture	fn (vec2 texCoord) -> vec4	Gets the color of a pixel (the difference of using this vs. using texture(x_Tex, texCoord) is that this function handles opaque windows)
x_TextureOffset	fn (vec2 pixelOffset) -> vec4	Gets the color at a pixel offset to the currently drawn pixel
x_Tex	sampler2D	The texture that gets sampled from
x_TexCoord	vec2	The coordinate that was used to get the current pixel color

Installation

hyprpm

hyprpm add https://github.com/micha4w/Hypr-DarkWindow
hyprpm enable Hypr-DarkWindow
hyprpm reload

NixOS (home-manager)

You should already have a fully working home-manager setup before adding this plugin.

#flake.nix
inputs = {
    home-manager = { ... };
    hyprland = { ... };
    ...
    hypr-darkwindow = {
      url = "github:micha4w/Hypr-DarkWindow/tags/v0.36.0"; # Make sure to change the tag to match your hyprland version
      inputs.hyprland.follows = "hyprland";
    };
};

outputs = {
  home-manager,
  hypr-darkwindow,
  ...
}: {
  ... = {
    home-manager.users.micha4w = {
      wayland.windowManager.hyprland.plugins = [
        hypr-darkwindow.packages.${pkgs.system}.Hypr-DarkWindow
      ];
    };
  };
}