macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs #9905

coreh · 2023-09-23T01:47:02Z

Objective

Improve compatibility with macOS Sonoma and Xcode 15.0.

Solution

Adds the workaround by @ptxmac to ignore the invalid window sizes provided by winit on macOS 14.0
- This still provides a slightly wrong content size when resizing (it fails to account for the window title bar, so some content gets clipped at the bottom) but it's much better than crashing.
Adds docs on how to work around the bindgen bug on Xcode 15.0.

Related Issues:

coreaudio-sys fails to build under macOS Sonoma (14.0) / Xcode 15.0 RustAudio/coreaudio-sys#85
Wrong size when resizing window on MacOS Sonoma (Beta) rust-windowing/winit#2876

Changelog

Added a workaround for a winit-related crash under macOS Sonoma (14.0)

Vrixyz · 2023-09-23T02:03:49Z

Is there a follow up issue to track when this « hack » + « slightly wrong » resizing can be fixed ?

Maybe next version of winit will help ? In the meantime that PR sounds great 👍

coreh · 2023-09-23T02:11:11Z

The fix for it is already merged to winit. However, there hasn't been a new release with it yet.

It should will be included in 0.29, so perhaps we could just use your PR (#8745) to track that? (By removing the workaround on your branch)

Vrixyz · 2023-09-23T02:34:25Z

I’d rather avoid my PR to be a tracking issue for this fix, because:

Update winit dependency to 0.29 #8745 might not be accepted
Update winit dependency to 0.29 #8745 will probably not get the fix in (the PR is already big, and that’s additional testing…)

I added a link though, so we’re not forgetting it, I’ll create a standalone issue or PR after we’re done with #8745 if need be.

rparrett · 2023-09-23T20:38:54Z

The fix for it is already merged to winit. However, there hasn't been a new release with it yet.

The fix seems relatively simple -- I wonder if they would be willing to backport it for a minor 0.28 release.

simlay · 2023-09-23T20:48:32Z

docs/macos_dependencies.md

+Xcode 15.x introduces a few `clang` changes that can cause the build to fail due an identifier format not expected by older versions of `bindgen`. The error looks like this:
+
+```
+error: failed to run custom build command for `coreaudio-sys v0.2.10`
+
+Caused by:
+  process didn't exit successfully: `<path to your project>/target/debug/build/coreaudio-sys-7e0a7d7c97b2ec33/build-script-build` (exit status: 101)
+  --- stdout
+  cargo:rerun-if-env-changed=COREAUDIO_SDK_PATH
+  cargo:rustc-link-lib=framework=AudioUnit
+  cargo:rustc-link-lib=framework=CoreAudio
+  cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS
+
+  --- stderr
+  thread 'main' panicked at '"enum_(unnamed_at_/Applications/Xcode_app/Contents/Developer/Platforms/MacOSX_platform/Developer/SDKs/MacOSX14_0_sdk/usr/include/MacTypes_h_382_1)" is not a valid Ident', <path to your user folder>/.cargo/registry/src/index.crates.io-6f17d22bba15001f/proc-macro2-1.0.56/src/fallback.rs:811:9
+  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+```
+
+There's an upstream [issue](https://github.com/RustAudio/coreaudio-sys/issues/85) in `coreaudio-sys` to update `bindgen`. In the mean time you can work around this by installing clang from [Homebrew](https://brew.sh):
+
+```sh
+brew install llvm@15
+```


Sorry for being late to see the coreaudio-sys issue. A new minor version of coreaudio-sys has been published with an updated version of bindgen so this work around shouldn't be necessary.

No problem, that's even better!

Thanks for updating it, I'll update the PR bumping the version.

Actually scratch that, I forgot that Cargo.lock is not tracked for libraries, so there's no need to update anything 🥳

I just removed the special instructions

Co-Authored-By: Marco Buono <[email protected]>

n-raine · 2023-09-28T10:54:39Z

FWIW it looks like winit's maintainers have just backported the fix and released it as 0.28.7 (see the last comments on the linked issue), so hopefully this can be fixed properly now?

…bevyengine#9905)" This reverts commit 20ed3e0.

#9991) … (#9905)" This reverts commit 20ed3e0. Issue was already fixed: rust-windowing/winit#3118

bevyengine#9991) … (bevyengine#9905)" This reverts commit 20ed3e0. Issue was already fixed: rust-windowing/winit#3118

# Objective - Update winit dependency to 0.29 ## Changelog ### KeyCode changes - Removed `ScanCode`, as it was [replaced by KeyCode](https://github.com/rust-windowing/winit/blob/master/CHANGELOG.md#0292). - `ReceivedCharacter.char` is now a `SmolStr`, [relevant doc](https://docs.rs/winit/latest/winit/event/struct.KeyEvent.html#structfield.text). - Changed most `KeyCode` values, and added more. KeyCode has changed meaning. With this PR, it refers to physical position on keyboard rather than the printed letter on keyboard keys. In practice this means: - On QWERTY keyboard layouts, nothing changes - On any other keyboard layout, `KeyCode` no longer reflects the label on key. - This is "good". In bevy 0.12, when you used WASD for movement, users with non-QWERTY keyboards couldn't play your game! This was especially bad for non-latin keyboards. Now, WASD represents the physical keys. A French player will press the ZQSD keys, which are near each other, Kyrgyz players will use "Цфыв". - This is "bad" as well. You can't know in advance what the label of the key for input is. Your UI says "press WASD to move", even if in reality, they should be pressing "ZQSD" or "Цфыв". You also no longer can use `KeyCode` for text inputs. In any case, it was a pretty bad API for text input. You should use `ReceivedCharacter` now instead. ### Other changes - Use `web-time` rather than `instant` crate. (rust-windowing/winit#2836) - winit did split `run_return` in `run_onDemand` and `pump_events`, I did the same change in bevy_winit and used `pump_events`. - Removed `return_from_run` from `WinitSettings` as `winit::run` now returns on supported platforms. - I left the example "return_after_run" as I think it's still useful. - This winit change is done partly to allow to create a new window after quitting all windows: emilk/egui#1918 ; this PR doesn't address. - added `width` and `height` properties in the `canvas` from wasm example (#10702 (comment)) ## Known regressions (important follow ups?) - Provide an API for reacting when a specific key from current layout was released. - possible solutions: use winit::Key from winit::KeyEvent ; mapping between KeyCode and Key ; or . - We don't receive characters through alt+numpad (e.g. alt + 151 = "ù") anymore ; reproduced on winit example "ime". maybe related to rust-windowing/winit#2945 - (windows) Window content doesn't refresh at all when resizing. By reading rust-windowing/winit#2900 ; I suspect we should just fire a `window.request_redraw();` from `AboutToWait`, and handle actual redrawing within `RedrawRequested`. I'm not sure how to move all that code so I'd appreciate it to be a follow up. - (windows) unreleased winit fix for using set_control_flow in AboutToWait rust-windowing/winit#3215 ; ⚠️ I'm not sure what the implications are, but that feels bad 🤔 ## Follow up I'd like to avoid bloating this PR, here are a few follow up tasks worthy of a separate PR, or new issue to track them once this PR is closed, as they would either complicate reviews, or at risk of being controversial: - remove CanvasParentResizePlugin (#10702 (comment)) - avoid mentionning explicitly winit in docs from bevy_window ? - NamedKey integration on bevy_input: rust-windowing/winit#3143 introduced a new NamedKey variant. I implemented it only on the converters but we'd benefit making the same changes to bevy_input. - Add more info in KeyboardInput #10702 (review) - #9905 added a workaround on a bug allegedly fixed by winit 0.29. We should check if it's still necessary. - update to raw_window_handle 0.6 - blocked by wgpu - Rename `KeyCode` to `PhysicalKeyCode` #10702 (comment) - remove `instant` dependency, [replaced by](rust-windowing/winit#2836) `web_time`), we'd need to update to : - fastrand >= 2.0 - [`async-executor`](https://github.com/smol-rs/async-executor) >= 1.7 - [`futures-lite`](https://github.com/smol-rs/futures-lite) >= 2.0 - Verify license, see [discussion](#8745 (comment)) - we might be missing a short notice or description of changes made - Consider using https://github.com/rust-windowing/cursor-icon directly rather than vendoring it in bevy. - investigate [this unwrap](#8745 (comment)) (`winit_window.canvas().unwrap();`) - Use more good things about winit's update - #10689 (comment) ## Migration Guide This PR should have one.

@ptxmac

…gine#9905) # Objective Improve compatibility with macOS Sonoma and Xcode 15.0. ## Solution - Adds the workaround by @ptxmac to ignore the invalid window sizes provided by `winit` on macOS 14.0 - This still provides a slightly wrong content size when resizing (it fails to account for the window title bar, so some content gets clipped at the bottom) but it's _much better_ than crashing. - Adds docs on how to work around the `bindgen` bug on Xcode 15.0. ## Related Issues: - RustAudio/coreaudio-sys#85 - rust-windowing/winit#2876 --- ## Changelog - Added a workaround for a `winit`-related crash under macOS Sonoma (14.0) --------- Co-authored-by: Peter Kristensen <[email protected]>

bevyengine#9991) … (bevyengine#9905)" This reverts commit 20ed3e0. Issue was already fixed: rust-windowing/winit#3118

# Objective - Update winit dependency to 0.29 ## Changelog ### KeyCode changes - Removed `ScanCode`, as it was [replaced by KeyCode](https://github.com/rust-windowing/winit/blob/master/CHANGELOG.md#0292). - `ReceivedCharacter.char` is now a `SmolStr`, [relevant doc](https://docs.rs/winit/latest/winit/event/struct.KeyEvent.html#structfield.text). - Changed most `KeyCode` values, and added more. KeyCode has changed meaning. With this PR, it refers to physical position on keyboard rather than the printed letter on keyboard keys. In practice this means: - On QWERTY keyboard layouts, nothing changes - On any other keyboard layout, `KeyCode` no longer reflects the label on key. - This is "good". In bevy 0.12, when you used WASD for movement, users with non-QWERTY keyboards couldn't play your game! This was especially bad for non-latin keyboards. Now, WASD represents the physical keys. A French player will press the ZQSD keys, which are near each other, Kyrgyz players will use "Цфыв". - This is "bad" as well. You can't know in advance what the label of the key for input is. Your UI says "press WASD to move", even if in reality, they should be pressing "ZQSD" or "Цфыв". You also no longer can use `KeyCode` for text inputs. In any case, it was a pretty bad API for text input. You should use `ReceivedCharacter` now instead. ### Other changes - Use `web-time` rather than `instant` crate. (rust-windowing/winit#2836) - winit did split `run_return` in `run_onDemand` and `pump_events`, I did the same change in bevy_winit and used `pump_events`. - Removed `return_from_run` from `WinitSettings` as `winit::run` now returns on supported platforms. - I left the example "return_after_run" as I think it's still useful. - This winit change is done partly to allow to create a new window after quitting all windows: emilk/egui#1918 ; this PR doesn't address. - added `width` and `height` properties in the `canvas` from wasm example (bevyengine/bevy#10702 (comment)) ## Known regressions (important follow ups?) - Provide an API for reacting when a specific key from current layout was released. - possible solutions: use winit::Key from winit::KeyEvent ; mapping between KeyCode and Key ; or . - We don't receive characters through alt+numpad (e.g. alt + 151 = "ù") anymore ; reproduced on winit example "ime". maybe related to rust-windowing/winit#2945 - (windows) Window content doesn't refresh at all when resizing. By reading rust-windowing/winit#2900 ; I suspect we should just fire a `window.request_redraw();` from `AboutToWait`, and handle actual redrawing within `RedrawRequested`. I'm not sure how to move all that code so I'd appreciate it to be a follow up. - (windows) unreleased winit fix for using set_control_flow in AboutToWait rust-windowing/winit#3215 ; ⚠️ I'm not sure what the implications are, but that feels bad 🤔 ## Follow up I'd like to avoid bloating this PR, here are a few follow up tasks worthy of a separate PR, or new issue to track them once this PR is closed, as they would either complicate reviews, or at risk of being controversial: - remove CanvasParentResizePlugin (bevyengine/bevy#10702 (comment)) - avoid mentionning explicitly winit in docs from bevy_window ? - NamedKey integration on bevy_input: rust-windowing/winit#3143 introduced a new NamedKey variant. I implemented it only on the converters but we'd benefit making the same changes to bevy_input. - Add more info in KeyboardInput bevyengine/bevy#10702 (review) - bevyengine/bevy#9905 added a workaround on a bug allegedly fixed by winit 0.29. We should check if it's still necessary. - update to raw_window_handle 0.6 - blocked by wgpu - Rename `KeyCode` to `PhysicalKeyCode` bevyengine/bevy#10702 (comment) - remove `instant` dependency, [replaced by](rust-windowing/winit#2836) `web_time`), we'd need to update to : - fastrand >= 2.0 - [`async-executor`](https://github.com/smol-rs/async-executor) >= 1.7 - [`futures-lite`](https://github.com/smol-rs/futures-lite) >= 2.0 - Verify license, see [discussion](bevyengine/bevy#8745 (comment)) - we might be missing a short notice or description of changes made - Consider using https://github.com/rust-windowing/cursor-icon directly rather than vendoring it in bevy. - investigate [this unwrap](bevyengine/bevy#8745 (comment)) (`winit_window.canvas().unwrap();`) - Use more good things about winit's update - bevyengine/bevy#10689 (comment) ## Migration Guide This PR should have one.

ptxmac and others added 3 commits September 21, 2023 00:30

Fix winit resize event on macOS 14 (beta)

a4eb743

Add comment and conditionally compile only on MacOS

fe64438

Add macOS Dependencies Guide

687e337

Vrixyz mentioned this pull request Sep 23, 2023

Update winit dependency to 0.29 #8745

Closed

11 tasks

simlay reviewed Sep 23, 2023

View reviewed changes

Remove specific instructions for Xcode 15.0

5e66461

mockersf mentioned this pull request Sep 27, 2023

Dimension X value 4294967295 exceeds the limit of 16384 #9389

Closed

mockersf approved these changes Sep 27, 2023

View reviewed changes

mockersf added P-Crash A sudden unexpected crash O-MacOS Specific to the MacOS (Apple) desktop operating system P-High This is particularly urgent, and deserves immediate attention labels Sep 27, 2023

mockersf added this to the 0.11.3 milestone Sep 27, 2023

mockersf pushed a commit to mockersf/bevy that referenced this pull request Sep 27, 2023

Fix winit resize event on macOS 14 (bevyengine#9905)

df43c17

mockersf pushed a commit to mockersf/bevy that referenced this pull request Sep 27, 2023

Fix winit resize event on macOS 14 (bevyengine#9905)

e396f11

Co-Authored-By: Marco Buono <[email protected]>

zaycev approved these changes Sep 27, 2023

View reviewed changes

cart approved these changes Sep 27, 2023

View reviewed changes

cart added this pull request to the merge queue Sep 27, 2023

Merged via the queue into bevyengine:main with commit 20ed3e0 Sep 27, 2023
24 checks passed

ameknite added a commit to ameknite/bevy that referenced this pull request Oct 1, 2023

Revert "macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs (…

050067a

…bevyengine#9905)" This reverts commit 20ed3e0.

ameknite mentioned this pull request Oct 1, 2023

Revert "macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs… #9991

Merged

github-merge-queue bot pushed a commit that referenced this pull request Oct 2, 2023

Revert "macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs… (

f69e923

#9991) … (#9905)" This reverts commit 20ed3e0. Issue was already fixed: rust-windowing/winit#3118

ameknite added a commit to ameknite/bevy that referenced this pull request Oct 3, 2023

Revert "macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs… (

121bf65

bevyengine#9991) … (bevyengine#9905)" This reverts commit 20ed3e0. Issue was already fixed: rust-windowing/winit#3118

ameknite added a commit to ameknite/bevy that referenced this pull request Oct 3, 2023

Revert "macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs… (

bab5bdf

bevyengine#9991) … (bevyengine#9905)" This reverts commit 20ed3e0. Issue was already fixed: rust-windowing/winit#3118

Vrixyz mentioned this pull request Nov 22, 2023

Update winit dependency to 0.29 #10702

Merged

Vrixyz mentioned this pull request Dec 21, 2023

Winit 0.29 follow up #11052

Closed

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs #9905

macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs #9905

coreh commented Sep 23, 2023 •

edited

Loading

Vrixyz commented Sep 23, 2023

coreh commented Sep 23, 2023

Vrixyz commented Sep 23, 2023

rparrett commented Sep 23, 2023

simlay Sep 23, 2023

coreh Sep 23, 2023

coreh Sep 24, 2023

n-raine commented Sep 28, 2023

macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs #9905

macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs #9905

Conversation

coreh commented Sep 23, 2023 • edited Loading

Objective

Solution

Related Issues:

Changelog

Vrixyz commented Sep 23, 2023

coreh commented Sep 23, 2023

Vrixyz commented Sep 23, 2023

rparrett commented Sep 23, 2023

simlay Sep 23, 2023

Choose a reason for hiding this comment

coreh Sep 23, 2023

Choose a reason for hiding this comment

coreh Sep 24, 2023

Choose a reason for hiding this comment

n-raine commented Sep 28, 2023

coreh commented Sep 23, 2023 •

edited

Loading