Skip to content

Commit 6e5994d

Browse files
committed
docs: Update Wayland documentation
Note that windows may not report the minimized state, and update the cursor warp documentation to note the newly supported protocol.
1 parent da6e9bb commit 6e5994d

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/README-wayland.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,15 @@ encounter limitations or behavior that is different from other windowing systems
4747

4848
### Warping the mouse cursor to or from a point outside the window doesn't work
4949

50-
- The cursor can be warped only within the window with mouse focus, provided that the `zwp_pointer_confinement_v1`
51-
protocol is supported by the compositor.
50+
- Warping the cursor on Wayland requires that either the `wp_pointer_warp_v1` or `zwp_pointer_confinement_v1` protocol
51+
is supported by the compositor. Compositors typically restrict pointer warps to be within the window that currently
52+
has mouse focus.
53+
54+
### Minimize/Restored window events are not sent, and the ```SDL_WINDOW_MINIMIZED``` flag is not set.
55+
56+
- Wayland windows do not currently report the minimized state, aside from when it is activated programmatically via
57+
```SDL_MinimizeWindow()```. Minimizing a window from the window controls or a desktop shortcut will not send a
58+
minimized event or flag the window as being minimized.
5259

5360
### The application icon can't be set via ```SDL_SetWindowIcon()```
5461

0 commit comments

Comments
 (0)