[WIP] Add Wayland backend to generic_unix #27463

ddevault · 2019-03-27T18:51:05Z

Depends on #27266.

I started with @toger5's work on #23426 and cleaned things up a bit, then picked up the mantle of implementing more of the OS API for Wayland. This is still a WIP, but feedback is welcome.

Major todo items:

Future work:

xdg-decoration support (borderless & bordered windows)
Adjust editor DPI auto-selection as the window moves between outputs of various DPIs
Key repeat
Pointer frames
Virtual keyboard (OSK) rigging
Custom cursor images

Decorations is probably going to be tough, as it will require Godot to render window decorations itself. The only Wayland compositor which requires this, iiuc, is GNOME. We can probably get away with fixing it separately from the main patch.

platform/generic_unix/wayland/context_egl_wayland.cpp

toger5 · 2019-03-28T13:26:47Z

About client side decorations. I think that is a nice to have thing for Godot in general. I would not do it in this specific PR. But having the option to run the editor with client side decorations is a great option also for windows/macos (gives a tiny amount of additional screen space). It also does not require much. just adding a close + minimize + fullscreenbutton in the toplft/right corner and maybe optionally choose the style based on the os.

ddevault · 2019-04-01T18:02:42Z

platform/generic_unix/wayland/os_wayland.cpp

@@ -487,8 +487,14 @@ int OS_Wayland::get_screen_dpi(int p_screen) const {
 	return outputs[p_screen]->scale * 96;
 }

+OS_GenericUnix *OS_Wayland::detect() {
+	if (!getenv("WAYLAND_DISPLAY") && !getenv("WAYLAND_SOCKET")) {


Strictly speaking, a better solution would be to actually attempt to establish a connection with the display (ditto for X11), but that would move this task much earlier in the startup process than it was before. Open to feedback on this approach.

ddevault · 2019-04-01T18:12:59Z

I moved the code generation into the build system and pulled in my scons module for Wayland protocols as a git subtree:

https://git.sr.ht/~sircmpwn/scons-wayland-scanner

Not sure if this is entirely couth, but it fixes CI issues where checked-in generated protocol files were causing linter errors for code style. Generating Wayland protocols during the build is generally the appropriate way to do it throughout the rest of the Wayland community as well.

For those unfamiliar with a git subtree, it pulls in commits from an external repository and rewrites them under a subdirectory in this repository. The files are actually checked into the repo and don't require a second step or reliable access to a second git remote to download the module on git clone. The subtree can be updated from upstream in the future with a command like git subtree pull -P platform/generic_unix/tools/wayland-scanner https://git.sr.ht/~sircmpwn/scons-wayland-scanner master.

Part two is relative pointer

…7b153d0b3d8196b811e3c6d5cc5b0020fc3' git-subtree-dir: platform/generic_unix/tools/wayland-scanner git-subtree-mainline: 004b50d git-subtree-split: 66bbb7b

toger5 · 2019-04-11T22:39:39Z

Just to make testing for others quicker.
These additional libs are needed on fedora:
mesa-libEGL-devel
egl-wayland-devel
libxkbcommon-devel
wayland-devel

toger5 · 2019-04-11T23:51:42Z

I have issues when running:

wl_registry@2: error 0: invalid version for global wl_output (4): have 2, wanted 3
WARNING: _get: Property not found: rendering/quality/driver/driver_fallback
   At: core/project_settings.cpp:193.
ERROR: is_viable: Error initializing GLAD
   At: drivers/gles3/rasterizer_gles3.cpp:142.
WARNING: _get: Property not found: rendering/quality/driver/driver_fallback
   At: core/project_settings.cpp:193.
**ERROR** OS_Unix::execute - Could not create child process while executing: xmessage

dont have that much addional information. (fedora 29)

toger5 · 2019-06-16T19:08:06Z

what is the status on this pr?

ddevault · 2019-06-16T19:09:27Z

Been radio silence from upstream, I dunno.

qarmin · 2020-04-20T06:00:25Z

Will work on this PR still continue?
If not, would it be possible to rebase pr with already implemented functions to the master branch?
In the meantime a significant part of the code was moved to displayerver class and x11 was changed to linuxbsd (of course where it did not refer to xorg).

akien-mga · 2020-04-20T07:47:25Z

This would likely be very difficult to rebase given the extent of the changes in the master branch for the OS / DisplayServer split. (Which is also why this and other related PRs have not been reviewed for merging, as they were all pending on this DisplayServer split to happen for 4.0.)

The better approach here would likely be to restart from scratch, copying code from this PR to the relevant new files (platform/linuxbsd/display_server_wayland.cpp, etc.).

I'd personally favor a focus on first fixing new issues that we're having with X11 since the DisplayServer split (as some might be in DisplayServer or Window code and would impact Wayland too), but re-starting the work on Wayland now would be appropriate too.

aaronfranke · 2020-05-26T14:47:03Z

Closing this and adding "salvageable" due to the above comment.

Godot is still fairly buggy from the DisplayServer split, it might be advisable to wait a few months to work on this to avoid chasing bugs that aren't your fault.

akien-mga · 2020-06-02T09:01:06Z

See godotengine/godot-proposals#990 for the new reference proposal (please help flesh it out with technical details, I just opened it as a base for further discussion about the implementation).

ddevault added 3 commits February 26, 2019 11:55

Initial commit

deece81

Add README.md

ecf21c5

Export WaylandScanner psuedo-builder

66bbb7b

ddevault requested review from akien-mga, karroffel, neikeq and reduz as code owners March 27, 2019 18:51

ddevault mentioned this pull request Mar 27, 2019

Rename x11 platform to 'linuxbsd' #27266

Closed

groud added feature proposal topic:core labels Mar 27, 2019

toger5 reviewed Mar 28, 2019

View reviewed changes

platform/generic_unix/wayland/context_egl_wayland.cpp Outdated Show resolved Hide resolved

Chaosus added this to the 4.0 milestone Mar 30, 2019

ddevault commented Apr 1, 2019

View reviewed changes

toger5 and others added 15 commits April 2, 2019 12:46

Rename x11 to generic_unix; add OS_GenericUnix

5fef563

Make OS_X11 inherit from OS_GenericUnix

646ddd8

Move x11 code to dedicated folder

1a135d8

add xdg_shell protocol

62b8804

add wayland context

a7f144b

add os_wayland

2ea0cac

scons: add libs for wayland, egl + add wayland source files

50485bc

temp godot_linux use wayland

0ded1cd

Fix up main loop & threading

382f94e

General cleanup

6ee8965

Handle xdg_toplevel resizing

36df661

Fix set_window_title

6af2711

Implement axis events and focus

808b702

Use global names instead of hardcoded strings

b1c900f

Send pointer motion events on surface enter

08c0fbd

ddevault added 9 commits April 2, 2019 12:46

Cursor capture/confinement, part one

77a90ff

Part two is relative pointer

Add libegl1-mesa-dev to Travis deps

004b50d

Add 'platform/generic_unix/tools/wayland-scanner/' from commit '66bbb…

c4b5886

…7b153d0b3d8196b811e3c6d5cc5b0020fc3' git-subtree-dir: platform/generic_unix/tools/wayland-scanner git-subtree-mainline: 004b50d git-subtree-split: 66bbb7b

Implement relative pointer events

441ece0

Improve keyboard event handling to match X11

1a11745

Fix corner case w/hidden cursor & relative pointer

e4697e5

Implement idle inhibit (keep screen on)

7388ec6

Add TODO for custom cursors on Wayland

b8dce1b

Initial riggings for data device (clipboard)

0dc193c

akien-mga added platform:linuxbsd topic:porting labels Apr 7, 2019

akien-mga requested review from hpvb and removed request for karroffel and neikeq May 28, 2019 10:46

aaronfranke mentioned this pull request Nov 5, 2019

Add Wayland support #576

Closed

aaronfranke marked this pull request as draft April 9, 2020 00:36

aaronfranke closed this May 26, 2020

aaronfranke added archived salvageable labels May 26, 2020

aaronfranke mentioned this pull request May 26, 2020

[WIP] Wayland implementation #23426

Closed

akien-mga mentioned this pull request Jun 2, 2020

Add support for the Wayland display server godotengine/godot-proposals#990

Closed

Riteo mentioned this pull request Jan 21, 2022

[WIP] Implement a Wayland DisplayServer #57025

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Add Wayland backend to generic_unix #27463

[WIP] Add Wayland backend to generic_unix #27463

ddevault commented Mar 27, 2019 •

edited

Loading

toger5 commented Mar 28, 2019

ddevault Apr 1, 2019

ddevault commented Apr 1, 2019 •

edited

Loading

toger5 commented Apr 11, 2019 •

edited

Loading

toger5 commented Apr 11, 2019

toger5 commented Jun 16, 2019

ddevault commented Jun 16, 2019

qarmin commented Apr 20, 2020

akien-mga commented Apr 20, 2020

aaronfranke commented May 26, 2020 •

edited

Loading

akien-mga commented Jun 2, 2020

[WIP] Add Wayland backend to generic_unix #27463

[WIP] Add Wayland backend to generic_unix #27463

Conversation

ddevault commented Mar 27, 2019 • edited Loading

toger5 commented Mar 28, 2019

ddevault Apr 1, 2019

Choose a reason for hiding this comment

ddevault commented Apr 1, 2019 • edited Loading

toger5 commented Apr 11, 2019 • edited Loading

toger5 commented Apr 11, 2019

toger5 commented Jun 16, 2019

ddevault commented Jun 16, 2019

qarmin commented Apr 20, 2020

akien-mga commented Apr 20, 2020

aaronfranke commented May 26, 2020 • edited Loading

akien-mga commented Jun 2, 2020

ddevault commented Mar 27, 2019 •

edited

Loading

ddevault commented Apr 1, 2019 •

edited

Loading

toger5 commented Apr 11, 2019 •

edited

Loading

aaronfranke commented May 26, 2020 •

edited

Loading