hyprland-wiki/pages/Configuring/Monitors.md
levnikmyskin 2cfac6c3af
Added documentation for workspace rules (#208)
* added documentation for workspace rules

* added ref from Monitors.md + fixed reflinks

* fixed workspace-rules table

---------

Co-authored-by: Alessio Molinari <alessiomolinari@gmail.com>
2023-05-01 22:28:16 +01:00

4.8 KiB

Table of contents

{{< toc format=html >}}

General

The general config of a monitor looks like this

monitor=name,resolution,position,scale

A common example:

monitor=DP-1,1920x1080@144,0x0,1

will tell Hyprland to make the monitor on DP-1 a 1920x1080 display, at 144Hz, 0x0 off from the top left corner, with a scale of 1 (unscaled).

To list available monitors:

hyprctl monitors

Monitors are positioned on a virtual "layout". The position is the position of said display in the layout. (calculated from the top-left corner)

For example:

monitor=DP-1, 1920x1080, 0x0, 1
monitor=DP-2, 1920x1080, 1920x0, 1

will tell hyprland to make DP-1 on the left of DP-2, while

monitor=DP-1, 1920x1080, 1920x0, 1
monitor=DP-2, 1920x1080, 0x0, 1

will tell hyprland to make DP-1 on the right.

{{< hint type=tip >}}

The position is calculated with the scaled (and transformed) resolution, meaning if you want your 4K monitor with scale 2 to the left of your 1080p one, you'd use the position 1920x0 for the second screen. (3840 / 2) If the monitor is also rotated 90 degrees (vertical) you'd use 1080x0.

{{</ hint >}}

Leaving the name empty will define a fallback rule to use when no other rules match.

You can use preferred as a resolution to use the display's preferred size, and auto as a position to let Hyprland decide on a position for you.

You can also use auto as a scale to let Hyprland decide on a scale for you. These depend on the PPI of the monitor.

Recommended rule for quickly plugging in random monitors:

monitor=,preferred,auto,1

Will make any monitor that was not specified with an explicit rule automatically placed on the right of the other(s) with its preferred resolution.

Alternatively you can use the highres or highrr rules in order to get the best possible resolution or refreshrate mix.

for a focus on refreshrate use this:

monitor=,highrr,auto,1

for a focus on resolution this:

monitor=,highres,auto,1

For more specific rules, you can also use the output's description (see hyprctl monitors) like this:

monitor=desc:SDC 0x4154,preferred,auto,1.5

remember to remove the (portname)!

Disabling a monitor

To disable a monitor, use

monitor=name,disable

{{< hint type=tip >}}

Disabling a monitor will literally remove it from the layout, moving all windows and workspaces to any remaining ones. If you want to disable your monitor in a screensaver style (just turn off the monitor) use the dpms dispatcher.

{{</ hint >}}

Custom reserved area

If your workflow requires custom reserved area, you can add it with

monitor=name,addreserved,TOP,BOTTOM,LEFT,RIGHT

Where TOP BOTTOM LEFT RIGHT are integers in pixels of the reserved area to add. This does stack on top of the calculated one, (e.g. bars) but you may only use one of these rules per monitor in the config.

Extra args

Mirrored displays

If you want to mirror a display, add a ,mirror,[NAME] at the end of the monitor rule, examples:

monitor=DP-3,1920x1080@60,0x0,1,mirror,DP-2
monitor=,preferred,auto,1,mirror,DP-1

Please remember that mirroring displays will not "re-render" everything for your second monitor, so if mirroring a 1080p screen onto a 4K one, the resolution will still be 1080p on the 4K display. This also means squishing and stretching will occur on non-matching resolutions.

10 bit support

If you want to enable 10 bit support for your display, add a ,bitdepth,10 at the end of the monitor rule, e.g.:

monitor=eDP-1,2880x1800@90,0x0,1,bitdepth,10

Please be aware that colors registered in Hyprland (e.g. the border color) do not support 10 bit.

Rotating

If you want to rotate a monitor, add a ,transform,X at the end of the monitor rule, where X corresponds to a transform number, e.g.:

monitor=eDP-1,2880x1800@90,0x0,1,transform,1

Transform list:

normal (no transforms) -> 0
90 degrees -> 1
180 degrees -> 2
270 degrees -> 3
flipped -> 4
flipped + 90 degrees -> 5
flipped + 180 degrees -> 6
flipped + 270 degrees -> 7

Default workspace

You can set the default workspace for a monitor with the workspace keyword, e.g.:

workspace = DP-1, 1
workspace = DP-2, name:work

Please remember only one default workspace can be created per monitor, subsequent sets for the same monitor will overwrite the previous.
Notice, you can also use this keyword to set workspace-specific rules. See Workspace Rules.

Binding workspaces to a monitor

A workspace can be bound to a monitor, meaning by default it will ALWAYS open on the selected monitor. You can do this with

wsbind=WORKSPACE,MONITOR

for example:

wsbind=5,DP-1
wsbind=name:secret,DP-2