hyprland-wiki/pages/Configuring/Variables.md
2022-10-20 22:28:00 +02:00

12 KiB

For basic syntax info, see Configuring Hyprland.

This page documents all the "options" of Hyprland. For binds, monitors, animations, etc. see the sidebar. For anything else, see Keywords.

Please keep in mind some options that are layout-specific will be documented in the layout pages and not here. (See the Sidebar for Dwindle and Master layouts)

Variable types

type description
int integer
bool boolean, true or false (yes or no, 0 or 1) - any numerical value that is not 0 or 1 will cause undefined behaviour.
float floating point number
color color (see hint below for color info)
vec2 vector with 2 values (float), separated by a space (e.g. 0 0 or -10.9 99.1)
MOD a string modmask (e.g. SUPER or SUPERSHIFT or SUPER + SHIFT or SUPER and SHIFT or CTRL_SHIFT or empty for none. You are allowed to put any separators you please except for a ,)
str a string

{{< hint type=info >}}

Colors:

You have 3 options:

rgba(), e.g. rgba(b3ff1aee)

rgb(), e.g. rgb(b3ff1a)

legacy, e.g. 0xeeb3ff1a -> ARGB order

Mod list:

SHIFT CAPS CTRL/CONTROL ALT MOD2 MOD3 SUPER/WIN/LOGO/MOD4 MOD5

{{< /hint >}}

Sections

General

name description type default
sensitivity mouse sensitivity (legacy, may cause bugs if not 1, prefer input:sensitivity) float 1.0
border_size self-explanatory int 1
no_border_on_floating disable borders for floating windows bool false
gaps_in gaps between windows int 5
gaps_out gaps between windows and monitor edges int 20
col.inactive_border self-explanatory color 0xffffffff
col.active_border self-explanatory color 0xff444444
cursor_inactive_timeout in seconds, after how many seconds of cursor's inactivity to hide it. Set to 0 for never. int 0
damage_tracking Makes the compositor redraw only the needed bits of the display. Saves on resources by not redrawing when not needed. Available modes: none, monitor, full. You don't need to know what different modes do, just always use full. str full
layout which layout to use. (Available: dwindle, master) str dwindle
no_cursor_warps if true, will not warp the cursor in many cases (focusing, keybinds, etc) bool false
apply_sens_to_raw if on, will also apply the sensitivity to raw mouse output (e.g. sensitivity in games) NOTICE: really not recommended. bool false

{{< hint type=warning >}} Prefer using input:sensitivity over general:sensitivity to avoid bugs, especially with Wine/Proton apps. {{< /hint >}}

Decoration

name description type default
rounding rounded corners' radius (in layout px) int 0
multisample_edges enable antialiasing (no-jaggies) for rounded corners bool true
active_opacity self-explanatory, only for windows. (0.0 - 1.0) float 1.0
inactive_opacity self-explanatory, only for windows. (0.0 - 1.0) float 1.0
fullscreen_opacity self-explanatory, only for windows. (0.0 - 1.0) float 1.0
blur enable kawase window background blur bool true
blur_size blur size (distance) int 8
blur_passes the amount of passes to perform int 1
blur_ignore_opacity make the blur layer ignore the opacity of the window bool false
blur_new_optimizations whether to enable further optimizations to the blur. Recommended to turn on, as it will massively improve performance, but some people have experienced graphical issues bool false
drop_shadow enable drop shadows on windows bool true
shadow_range Shadow range ("size") in layout px int 4
shadow_render_power (1 - 4), in what power to render the falloff (more power, the faster the falloff) int 3
shadow_ignore_window if true, the shadow will not be rendered behind the window itself, only around it. bool true
col.shadow shadow's color. Alpha dictates shadow's opacity. color 0xee1a1a1a
col.shadow_inactive inactive shadow color. (if not set, will fall back to col.shadow) color unset
shadow_offset shadow's rendering offset. vec2 [0, 0]
dim_inactive enables dimming of inactive windows bool false
dim_strength how much inactive windows should be dimmed, 0.0 - 1.0 float 0.5

{{< hint type=info >}}

blur_size and blur_passes have to be at least 1.

Increasing blur_passes is necessary to prevent blur looking wrong on higher blur_size values, but remember that higher blur_passes will require more strain on the GPU.

It will, however, cause zero overhead on tiled windows if using blur_new_optimizations.

{{< /hint >}}

{{< hint type=warning >}}

Using blur_new_optimizations with an animated wallpaper may actually increase GPU usage.

{{< /hint >}}

Animations

name description type default
enabled enable animations bool true

{{< hint type=info >}}

More about Animations.

{{< /hint >}}

Input

Input

name description type default
kb_layout Appropriate XKB keymap parameter str us
kb_variant Appropriate XKB keymap parameter str [EMPTY]
kb_model Appropriate XKB keymap parameter str [EMPTY]
kb_options Appropriate XKB keymap parameter str [EMPTY]
kb_rules Appropriate XKB keymap parameter str [EMPTY]
kb_file If you prefer, you can use a path to an .xkb file. str [EMPTY]
follow_mouse (0/1/2/3) enable mouse following (focus on enter new window) - See the note below for more info int 1
float_switch_override_focus if enabled (1 or 2), focus will follow mouse if changing from tiled to floating and vice versa. 2 will also follow mouse on float -> float switches int 1
repeat_rate in repeats per second, the repeat rate for held keys int 25
repeat_delay in ms, the repeat delay (grace period) before the spam int 600
natural_scroll enable natural scroll bool false
numlock_by_default lock numlock by default bool false
force_no_accel force no mouse acceleration, bypasses most of your pointer settings to get as raw of a signal as possible. bool false
sensitivity set the libinput sensitivity. This HAS to be from -1 to 1, or else it will be clamped. float 0.0
left_handed switches RMB and LMB bool false
accel_profile set the libinput acceleration profile. Can be one of adaptive, flat. str [EMPTY]
scroll_method set the libinput scroll method. Can be one of 2fg (2 fingers), edge, on_button_down, no_scroll. str [EMPTY]

{{< hint type=info >}}

Follow Mouse

  • 0 - disabled
  • 1 - full
  • 2 - loose. Will focus mouse on other windows on focus but not the keyboard.
  • 3 - full loose, will not refocus on click, but allow mouse focus to be detached from the keyboard like in 2. {{< /hint >}}

{{< hint type=info >}} For switchable keyboard configs, take a look at the uncommon tips & tricks page entry. {{< /hint >}}

Touchpad

Subcategory input:touchpad:

name description type default
disable_while_typing disables the touchpad while typing bool true
natural_scroll self-explanatory bool false
clickfinger_behavior self-explanatory bool false
middle_button_emulation self-explanatory bool false
tap-to-click self-explanatory bool true
drag_lock enable dragging with drag lock bool false
scroll_factor control the amount of scroll applied float 1.0

{{< hint type=important >}} A subcategory is a nested category:

input {
    # ...
    # ...

    touchpad {
        # ...
        # ...
    }
}

Doing input:touchpad { is invalid! {{< /hint >}}

Touchdevice

Subcategory input:touchdevice:

name description type default
transform transform the input from touchdevices. The possible transformations are the same as those of the monitors int 0
output the output to bind touch devices. Empty means unset and will use the current / autodetected. string [EMPTY]

Per-device input config

Described here.

Gestures

name description type default
workspace_swipe enable workspace swipe gesture bool false
workspace_swipe_fingers how many fingers for the gesture int 3
workspace_swipe_distance in px, the distance of the gesture int 300
workspace_swipe_invert invert the direction bool true
workspace_swipe_min_speed_to_force minimum speed in px per timepoint to force the change ignoring cancel_ratio. Setting to 0 will disable this mechanic. int 30
workspace_swipe_cancel_ratio (0.0 - 1.0) how much the swipe has to proceed in order to commence it. (0.7 -> if > 0.7 * distance, switch, if less, revert) float 0.5
workspace_swipe_create_new whether a swipe right on the last workspace should create a new one. bool true

Misc

name description type default
disable_hyprland_logo disables the hyprland logo background. :( bool false
disable_splash_rendering disables the hyprland splash rendering. (requires a monitor reload to take effect) bool false
no_vfr disables VFR (variable frame rate) - VFR increases battery life at the expense of possible issues on a few monitors. bool true
damage_entire_on_snapshot (deprecated: do not enable) Damage the entire monitor when rendering snapshots. Recommended with transformed displays. Do not use without transformed displays. bool false
mouse_move_enables_dpms If DPMS is set to off, wake up the monitors if the mouse moves. bool false
always_follow_on_dnd Will make mouse focus follow the mouse when drag and dropping. Recommended to leave it enabled, especially for people using focus follows mouse at 0. bool true
layers_hog_keyboard_focus If true, will make keyboard-interactive layers keep their focus on mouse move (e.g. wofi, bemenu) bool true
animate_manual_resizes If true, will animate manual window resizes/moves bool false
disable_autoreload If true, the config will not reload automatically on save, and instead needs to be reloaded with hyprctl reload. Might save on battery. bool false
enable_swallow Enable window swallowing bool false
swallow_regex The class regex to be used for windows that should be swallowed (usually, a terminal) str [EMPTY]

Binds

name description type default
pass_mouse_when_bound if disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered. bool false
scroll_event_delay in ms, how many ms to wait after a scroll event to allow to pass another one for the binds. int 300
workspace_back_and_forth If enabled, an attempt to switch to the currently focused workspace will instead switch to the previous workspace. Akin to i3's auto_back_and_forth. bool false
allow_workspace_cycles If enabled, workspaces don't forget their previous workspace, so cycles can be created by switching to the first workspace in a sequence, then endlessly going to the previous workspace. bool false

Debug

{{< hint type=warning >}}

Only for developers.

{{< /hint >}}

name description type default
overlay print the debug performance overlay. Disable VFR for accurate results. bool false
damage_blink (epilepsy warning!) flash areas updated with damage tracking bool false
disable_logs self-explanatory bool false
disable_time disables time logging bool true

More

There are more config options described in other pages, which are layout- or circumstance-specific. See the sidebar for more pages.