Allow usage of XWayland #199

alexheretic · 2017-06-21T17:39:26Z

Will prefer X over wayland when the environment variable WINIT_PREFER_UNIX_BACKEND=x11 is set.

This came out as the simplest and least destructive way of actually having winit work under wayland at the moment, without redesigning the API to remove static initialisation of the unix backend see #182.

Will prefer X11 over wayland when the environment variable `WINIT_PREFER_UNIX_BACKEND=x11` is set.

elinorbgr · 2017-06-21T18:05:45Z

src/platform/linux/mod.rs

            match XConnection::new(Some(x_error_callback)) {
                Ok(x) => UnixBackend::X(Arc::new(x)),
                Err(e) => UnixBackend::Error(e),
            }
        }
+        match env::var(BACKEND_PREFERENCE_ENV_VAR) {
+            Ok(ref s) if s == "x11" => {
+                println!("{}: using x11 backend", BACKEND_PREFERENCE_ENV_VAR);


I'm not a fan of such unconditional printing on stdout. It'd be better on stderr imo.

elinorbgr · 2017-06-21T18:07:57Z

If we're going to have an env variable dictate the choice of the backend, maybe we could do it all the way:

If the variable is set to either x11 or wayland, use the designed backend and error if it is not available
If the variable is not set or set to any other value, try to use wayland, if it fails, use x11, if it fails, error

I believe that's the kind of behavior libs like SDL2 do, no?

Using `BACKEND_PREFERENCE_ENV_VAR=$backend` will no longer fallback on any other backend

alexheretic · 2017-06-21T18:43:23Z

Yeah that sounds reasonable. I've changed it to strict mode, ie when WINIT_PREFER_UNIX_BACKEND is

absent => try wayland then x11
present => try selected backend, don't fallback, panic if unknown

With such behaviour printing shouldn't be necessary.

alexheretic · 2017-06-21T18:52:23Z

Maybe better to call it WINIT_UNIX_BACKEND now it is strict...

Rename inline with stricter behaviour Add docs explaining behaviour

elinorbgr · 2017-06-21T18:58:13Z

src/platform/linux/mod.rs

@@ -15,6 +16,10 @@ mod dlopen;
 pub mod wayland;
 pub mod x11;

+/// Environment variable that indicates the X11 backend should be used
+/// even if Wayland is available. In this case XWayland will be used.


Now, this could use a clearer documentation maybe something along the lines of

Environment variable specifying which backend should be used on unix platform.

Legal values are x11 and wayland. If this variable is set only the named backend
will be tried by winit. If it is not set, winit will try to connect to a wayland connection,
and if it fails will fallback on x11.

If this variable is set with any other value, winit will panic.

And refer to this in the main documentation for visibility. Maybe the crate root, of EventsLoop documentation? Not sure which place would be best...

Yes I noticed this too, actually I like your prose.

alexheretic · 2017-06-21T19:12:03Z

I've improved the docs at the sources of static initialisation I'm aware of. How does she look now?

elinorbgr · 2017-06-23T19:41:33Z

I was more thinking of linking the constant's doc from the various points of the doc, rather than copy-pasting the paragraph everywhere. This way if we need to change it at some point, we won't have to worry about finding all the places it needs to be changed.

Other than that, looks good to me.

alexheretic · 2017-06-24T20:26:30Z

My thoughts on the docs are it would be good if they turned up in the actual doc generated site, at the points where it is likely to matter to a consumer of the lib. It also makes sense that they're on the const declaration itself from a winit developer's perspective. I don't think it'll be very hard to remove them if/when the env var is removed.

However, I really don't mind too much how the docs are done. I'm happy for you guys to change them/remove them or whatever you like. If you give me the specifics I can do it myself. Otherwise a maintainer can edit it.

elinorbgr · 2017-06-25T08:39:16Z

Okay, let's not waste more time on this. Indeed we can always update the docs later if needed.

alexheretic · 2017-06-25T09:44:53Z

Thanks for your help with this @vberger

* refactor(windows): `begin_resize_drag` now similar to gtk's (rust-windowing#200) * refactor(windows): `begin_resize_drag` now similart to gtk's * fix * feat(linux): skipping taskbar will now also skip pager (rust-windowing#198) * refactor(linux): clean dummy device_id (rust-windowing#195) * refactor(linux): clean dummy device_id * fmt * feat(linux): allow resizing undecorated window using touch (rust-windowing#199) * refactor(windows): only skip taskbar if needed when `set_visible` is called (rust-windowing#196) * fix: increase borderless resizing inset (rust-windowing#202) * fix: increase borderless resizing inset * update some comments * Replace winapi with windows crate bindings shared with WRY (rust-windowing#206) * fix(deps): update rust crate libayatana-appindicator to 0.1.6 (rust-windowing#190) Co-authored-by: Renovate Bot <bot@renovateapp.com> * Add Windows crate and webview2-com-sys bindings * Initial port to webview2-com-sys * Finish conversion and remove winapi * Fix renamed lint warning * Fix all match arms referencing const variables * Put back the assert instead of expect * Point to the published version of webview2-com-sys * Cleanup slightly weird BOOL handling * Replace mem::zeroed with Default::default * Add a summary in .changes * Remove extra projects not in config.json * Fix clippy warnings * Update to 32-bit compatible webview2-com-sys * Better fix for merge conflict * Fix clippy errors on Windows * Use path prefix to prevent variable shadowing * Fix Windows clippy warnings with nightly toolchain * Fix Linux nightly/stable clippy warnings * Fix macOS nightly/stable clippy warnings * Put back public *mut libc::c_void for consistency * Re-run cargo fmt * Move call_default_window_proc to util mod * Remove unnecessary util::to_wstring calls * Don't repeat LRESULT expression in match arms * Replace bitwise operations with util functions * Cleanup more bit mask & shift with util fns * Prefer from conversions instead of as cast * Implement get_xbutton_wparam * Use *mut libc::c_void for return types Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Renovate Bot <bot@renovateapp.com> * fix(keyboard): add mapping for space key on Windows (rust-windowing#209) * fix(keyboard): add mapping for space key on Windows * change file * feat: impl Clone for EventLoopWindowTarget (rust-windowing#211) * chore: add `on_issue_closed.yml` (rust-windowing#214) * Update tray dependency version (rust-windowing#217) * Delete on_issue_closed.yml (rust-windowing#221) * refactor(linux): event loop (rust-windowing#233) * Use crossbeam::channel * Fix crossbeam channel import * Add check on poll event * Fix deadlock when unregistering shortcut on Linux (rust-windowing#230) * Add fullscreen monitor selection support on Linux (rust-windowing#235) * Add fullscreen monitor support on Linux * Add change file * Remove todo on videomode * Fix clippy * Update to 2021 edition (rust-windowing#236) * Update to 2021 edition * Fix clippy * Add run_return on Linux (rust-windowing#237) * Add run_return on Linux * Add main context * Add run_return trait on Linux (rust-windowing#238) * Fix: rust-windowing#239 Update webview2-com and windows crates (rust-windowing#240) * Replace webivew2-com-sys with prebuilt windows * Use windows utility instead of direct GetLastError * Bump windows version and add changelog * Run cargo fmt * Restore inverted matches macro * Scope constants in match arms * Fix inverted null check * Update src/platform_impl/windows/util.rs Co-authored-by: Amr Bashir <48618675+amrbashir@users.noreply.github.com> * Use env_logger instead of simple_logger (rust-windowing#241) * Use env_logger instead of simple_logger * Make clippy happy * Cherry pick commits to next (rust-windowing#244) * feat(macos): Add `unhide_application` method, closes rust-windowing#182 (rust-windowing#231) * feat(macos): Add `unhide_application` method * Update src/platform/macos.rs Co-authored-by: Amr Bashir <48618675+amrbashir@users.noreply.github.com> * Reanme to `show_application()` * Remove broken doc link Co-authored-by: Amr Bashir <48618675+amrbashir@users.noreply.github.com> * feat: Allow more strings to parse to keycode (rust-windowing#229) * feat: support accelerator key strings `,` `-` `.` `Space` `Tab` and `F13`-`F24` (rust-windowing#228) * feat(macOS): support more accelerator key strings * Move function keys together * Add `,` `-` `.` `Space` `F20-F24` for Windows * Remove support for accelerators not found in `winapi` * Add `,` `-` `.` `Space` `F13-F24` for Linux * Update .changes * Add the rest for Windows * Add the rest for Linux * Add the rest on macOS * Update accelerator-strings.md * Fix git comments Co-authored-by: Kasper <kasperkh.kh@gmail.com> Co-authored-by: Amr Bashir <48618675+amrbashir@users.noreply.github.com> * Add redraw events on Linux (rust-windowing#245) * Add redraw events on Linux * Update doc of RequestRedraw Event * Add change file * Fix missing menu bar on borderless window (rust-windowing#247) Credit goes to irh's work on winit commit f2de847 * refactor: improve `set_skip_taskbar` impl on Windows (rust-windowing#250) * fix: emit errors on parsing an invalid accelerator for string, closes rust-windowing#135 (rust-windowing#252) * chore: update comment * fix(linux): fix focus events not firing properly (rust-windowing#253) * fix(linux): fix focus events not firing properly * add changelog * chore: update focus events error message * chore: fmt * fix: revert windows-rs 0.28 version bump * fix(linux): fix native menu items (rust-windowing#256) * chore: remove examples commited by accident * Update `ReceivedImeText` (rust-windowing#251) * Allow receiving text without Ime on Windows * Avoid panic todo * Receive text without ime on mac * Fix CursorMoved event on Linux * Add ReceivedImeText on Linux This only add Simple IME from GTK for now. We should add the actual IME from system in the future. * Fix redraw event that causes inifinite loop (rust-windowing#260) * Fix redraw event that causes inifinite loop * Refactor event loop * Remove unused function * Add doc comment on linux's run_return * Ignore doc test on run_return * Add non blocking iteration on Linux (rust-windowing#261) * Docs: SystemTrayExtWindows::remove() is gone (rust-windowing#262) Fix docs following rust-windowing#153 * Fix busy loop on Linux (rust-windowing#265) * Update windows crate to 0.29.0 (rust-windowing#266) * Update to windows 0.29.0 * Add change description * Remove clippy check (rust-windowing#267) * refactor(windows): align util function with win32 names * chore: update PR template * fix(linux): fire resized & moved events on min/maximize, closes rust-windowing#219 (rust-windowing#254) * feat(linux): implement `raw_window_handle()` (rust-windowing#269) * chore(deps): update to raw-window-handle 0.4 * add linux raw-window-handle support * update macos/ios/android * fix ios * Fix core-video-sys dependency (rust-windowing#274) * The `cocoa` crate links to AppKit, which made the symbol `CGDisplayCreateUUIDFromDisplayID` from ApplicationServices/ColorSync (which AppKit uses internally) available to us on macOS 10.8 to 10.13. (rust-windowing#275) However, this does not work on macOS 10.7 (where AppKit does not link to ColorSync internally). Instead of relying on this, we should just link to ApplicationServices directly. * Fix some invalid msg_send! usage (rust-windowing#276) * Revert "Fix some invalid msg_send! usage (rust-windowing#276)" (rust-windowing#277) This reverts commit a3a2e0cfc49ddfa8cdf65cf9870fb8e3d45b4bc0. * Revert "The `cocoa` crate links to AppKit, which made the symbol `CGDisplayCreateUUIDFromDisplayID` from ApplicationServices/ColorSync (which AppKit uses internally) available to us on macOS 10.8 to 10.13. (rust-windowing#275)" (rust-windowing#279) This reverts commit 6f9c468f26ddb60e29be2139397bfaf3b30eab1e. * The `cocoa` crate links to AppKit, which made the symbol `CGDisplayCreateUUIDFromDisplayID` from ApplicationServices/ColorSync (which AppKit uses internally) available to us on macOS 10.8 to 10.13. (rust-windowing#280) However, this does not work on macOS 10.7 (where AppKit does not link to ColorSync internally). Instead of relying on this, we should just link to ApplicationServices directly. Co-authored-by: madsmtm <mads@marquart.dk> * Fix some invalid msg_send! usage (rust-windowing#278) Co-authored-by: madsmtm <mads@marquart.dk> * Add exit code to ControlFlow::Exit (rust-windowing#281) * Add exit code to ControlFlow::Exit * Cargo fmt * Add change files Co-authored-by: multisn8 <contact@multisamplednight.com> * Add new_any_thread to Unix event loop (rust-windowing#282) * Update windows crate to 0.30.0 (rust-windowing#283) * Update windows crate to 0.30.0 * Simplify new-type usage * Fix boxing in GWL_USERDATA * Make sure everyone is using Get/SetWindowLongPtrW * build the system_tray module when "ayatana" feature is enabled (rust-windowing#285) Without those cfg feature checks, the "ayatana" feature does actually not enable anything. * Fix click events missing whe tray has menu (rust-windowing#291) * Fix click events missing whe tray has menu * Add change file * Fix crash when tray has no menu (rust-windowing#294) * chore: update pull request commit exmple * fix(windows): send correct position for system tray events, closes rust-windowing#295 (rust-windowing#300) * fix(windows): revert maximized state handling to winit impl, closes rust-windowing#193 (rust-windowing#299) * fix(windows): revet maximized state handling to winit impl, closes rust-windowing#193 * add chanefile [skip ci] * fix: `MenuItem::Quit` on Windows (rust-windowing#303) * fix: `MenuItem::Close` on Windows * use `PostQuitMessage` instead Co-authored-by: amrbashir <amr.bashir2015@gmail.com> * feat: v1 audit by Radically Open Security (rust-windowing#304) * Update to gtk 0.15 (rust-windowing#288) * Update to gtk 0.15 * Fix picky none on set_geometry_hint * Fix CursorMoved position Co-authored-by: Amr Bashir <48618675+amrbashir@users.noreply.github.com> Co-authored-by: Bill Avery <wravery@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: Lucas Fernandes Nogueira <lucasfernandesnog@gmail.com> Co-authored-by: Kasper <kasperkh.kh@gmail.com> Co-authored-by: amrbashir <amr.bashir2015@gmail.com> Co-authored-by: Jay Oster <jay@kodewerx.org> Co-authored-by: madsmtm <mads@marquart.dk> Co-authored-by: multisn8 <contact@multisamplednight.com> Co-authored-by: Aurélien Jacobs <aurel@gnuage.org> Co-authored-by: Lucas Fernandes Nogueira <lucas@tauri.studio>

Allow usage of XWayland

9804cad

Will prefer X11 over wayland when the environment variable `WINIT_PREFER_UNIX_BACKEND=x11` is set.

alexheretic mentioned this pull request Jun 21, 2017

Add 'use-x-over-wayland' feature #182

Closed

elinorbgr reviewed Jun 21, 2017

View reviewed changes

Make usage of env vars strict

7a19ef1

Using `BACKEND_PREFERENCE_ENV_VAR=$backend` will no longer fallback on any other backend

Rename unix backend env var

789598f

Rename inline with stricter behaviour Add docs explaining behaviour

elinorbgr reviewed Jun 21, 2017

View reviewed changes

alexheretic added 2 commits June 21, 2017 19:59

Improve unix backend env var docs

eaa92a4

Add WINIT_UNIX_BACKEND documentation

3a89843

elinorbgr merged commit 05cd9f2 into rust-windowing:master Jun 25, 2017

alexheretic deleted the xwayland-env-var branch June 25, 2017 12:11

tmfink pushed a commit to tmfink/winit that referenced this pull request Jan 5, 2022

Try to work around rust-windowing#199

e727fd9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow usage of XWayland #199

Allow usage of XWayland #199

alexheretic commented Jun 21, 2017

elinorbgr Jun 21, 2017

elinorbgr commented Jun 21, 2017

alexheretic commented Jun 21, 2017 •

edited

Loading

alexheretic commented Jun 21, 2017

elinorbgr Jun 21, 2017

alexheretic Jun 21, 2017

alexheretic commented Jun 21, 2017 •

edited

Loading

elinorbgr commented Jun 23, 2017

alexheretic commented Jun 24, 2017

elinorbgr commented Jun 25, 2017

alexheretic commented Jun 25, 2017

Allow usage of XWayland #199

Allow usage of XWayland #199

Conversation

alexheretic commented Jun 21, 2017

elinorbgr Jun 21, 2017

Choose a reason for hiding this comment

elinorbgr commented Jun 21, 2017

alexheretic commented Jun 21, 2017 • edited Loading

alexheretic commented Jun 21, 2017

elinorbgr Jun 21, 2017

Choose a reason for hiding this comment

alexheretic Jun 21, 2017

Choose a reason for hiding this comment

alexheretic commented Jun 21, 2017 • edited Loading

elinorbgr commented Jun 23, 2017

alexheretic commented Jun 24, 2017

elinorbgr commented Jun 25, 2017

alexheretic commented Jun 25, 2017

alexheretic commented Jun 21, 2017 •

edited

Loading

alexheretic commented Jun 21, 2017 •

edited

Loading