jay-compositor 1.13.0

The Jay compositor
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# Xwayland

Xwayland provides compatibility with legacy X11 applications inside a Wayland
session. Jay starts Xwayland automatically by default.

## Configuration

The `[xwayland]` table controls Xwayland behavior:

`enabled`
: Whether Xwayland is started. Default: `true`.

`scaling-mode`
: How X11 windows are scaled on HiDPI outputs. Default: `default`.

```toml
[xwayland]
enabled = true
scaling-mode = "default"
```

### Scaling Modes

`default`
: Render at the lowest scale, then upscale to other outputs

`downscaled`
: Render at the highest integer scale, then downscale to match each output

The `downscaled` mode produces sharper text and UI on HiDPI monitors but has a
significant performance cost. For example, on a 3840x2160 output at 1.5x scale,
a fullscreen X11 window would be rendered at 5120x2880 (integer scale 2) and
then downscaled -- roughly doubling the pixel count. This mode also requires
X11 applications to handle scaling themselves (e.g. `GDK_SCALE=2`).

## CLI

You can inspect and change Xwayland settings from the command line:

```shell
~$ jay xwayland status
~$ jay xwayland set-scaling-mode default
~$ jay xwayland set-scaling-mode downscaled
```

Xwayland settings are also available in the control center's **Xwayland** pane.

## Disabling Xwayland

If you don't need X11 compatibility, disabling Xwayland avoids starting the
X server entirely:

```toml
[xwayland]
enabled = false
```

## Matching X11 Windows in Rules

Window rules can target X11 windows using properties that only exist on X
clients. These fields are available in the `match` table of `[[windows]]`
rules:

`x-class` / `x-class-regex`
: Match the X11 WM_CLASS class (verbatim or regex)

`x-instance` / `x-instance-regex`
: Match the X11 WM_CLASS instance (verbatim or regex)

`x-role` / `x-role-regex`
: Match the X11 WM_WINDOW_ROLE (verbatim or regex)

For example, to float all GIMP tool windows:

```toml
[[windows]]
match.x-class = "Gimp"
match.x-role-regex = "gimp-(toolbox|dock)"
initial-tile-state = "floating"
```

### Matching at the Client Level

Client rules support the `is-xwayland` field to match (or exclude) the
Xwayland client itself:

```toml
[[clients]]
match.is-xwayland = true
# ... grant capabilities, etc.
```