mirror of
https://github.com/rust-windowing/winit.git
synced 2026-06-27 07:03:15 -04:00
Compare commits
17 Commits
v0.30.2
...
notgull/sp
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d28c867b61 | ||
|
|
cfd35d2708 | ||
|
|
1b9c576f53 | ||
|
|
52532d2579 | ||
|
|
4b28f10470 | ||
|
|
daf1304879 | ||
|
|
c6e57430bb | ||
|
|
284f4c0558 | ||
|
|
859a6f109c | ||
|
|
a232f7bc77 | ||
|
|
48831f7910 | ||
|
|
114e6999d3 | ||
|
|
2f197315d9 | ||
|
|
557464489e | ||
|
|
623b3e5070 | ||
|
|
a97255e0fc | ||
|
|
3a817647d5 |
@@ -1,6 +1,2 @@
|
|||||||
# Allow rust-analyzer and local `cargo doc` invocations to pick up unreleased changelog entries
|
[alias]
|
||||||
#
|
run-wasm = ["run", "--release", "--package", "run-wasm", "--"]
|
||||||
# Note that these flags are (intentionally) not included when building from the downloaded crate.
|
|
||||||
[build]
|
|
||||||
rustflags = ["--cfg=unreleased_changelogs"]
|
|
||||||
rustdocflags = ["--cfg=unreleased_changelogs"]
|
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
|
|
||||||
|
|
||||||
# chore(rustfmt): use nightly
|
|
||||||
7b0c7b6cb2c62767ca0c73c857b299883f55a883
|
|
||||||
4
.github/ISSUE_TEMPLATE/blank_issue.md
vendored
4
.github/ISSUE_TEMPLATE/blank_issue.md
vendored
@@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
name: Blank Issue
|
|
||||||
about: Create a blank issue.
|
|
||||||
---
|
|
||||||
36
.github/ISSUE_TEMPLATE/bug_android.yml
vendored
36
.github/ISSUE_TEMPLATE/bug_android.yml
vendored
@@ -1,36 +0,0 @@
|
|||||||
name: Android bug
|
|
||||||
description: Create an Android-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - android
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: device
|
|
||||||
attributes:
|
|
||||||
label: Device and Android version
|
|
||||||
description: Which devices and Android versions are you seeing the problem on?
|
|
||||||
placeholder: |
|
|
||||||
Samsung Galaxy Z running Android Pie (API level 28),
|
|
||||||
Samsung Galaxy Z running Android 14 (API level 34),
|
|
||||||
Pixel 8 running Android 14 (API level 34)
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
37
.github/ISSUE_TEMPLATE/bug_ios.yml
vendored
37
.github/ISSUE_TEMPLATE/bug_ios.yml
vendored
@@ -1,37 +0,0 @@
|
|||||||
name: iOS bug
|
|
||||||
description: Create an iOS-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - ios
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: device
|
|
||||||
attributes:
|
|
||||||
label: Device and iOS version
|
|
||||||
description: Which devices and iOS versions are you seeing the problem on?
|
|
||||||
placeholder: |
|
|
||||||
iPhone 15 running iOS 14.0,
|
|
||||||
iPhone 15 running iOS 17.0,
|
|
||||||
MacBook Pro M2 Mac Catalyst running macOS 14.2,
|
|
||||||
iPhone simulator running iOS 17.0
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
37
.github/ISSUE_TEMPLATE/bug_macos.yml
vendored
37
.github/ISSUE_TEMPLATE/bug_macos.yml
vendored
@@ -1,37 +0,0 @@
|
|||||||
name: MacOS bug
|
|
||||||
description: Create a macOS-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - macos
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: os-version
|
|
||||||
attributes:
|
|
||||||
label: macOS version
|
|
||||||
description: What version of macOS are you using? Please paste in the output of `sw_vers`.
|
|
||||||
placeholder: |
|
|
||||||
ProductName: macOS
|
|
||||||
ProductVersion: 14.2.1
|
|
||||||
BuildVersion: 23C71
|
|
||||||
render: shell
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
41
.github/ISSUE_TEMPLATE/bug_wayland.yml
vendored
41
.github/ISSUE_TEMPLATE/bug_wayland.yml
vendored
@@ -1,41 +0,0 @@
|
|||||||
name: Wayland bug
|
|
||||||
description: Create a Wayland-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - wayland
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: debug
|
|
||||||
attributes:
|
|
||||||
label: Debugging output
|
|
||||||
description: Output of a binary run with `WAYLAND_DEBUG=1`
|
|
||||||
placeholder: |
|
|
||||||
[1234.5678] -> wl_display@1.get_registry(new id wl_registry@2)
|
|
||||||
[1234.5678] -> wl_display@1.sync(new id wl_callback@3)
|
|
||||||
...
|
|
||||||
render: shell
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Window isn't shown unless you draw
|
|
||||||
options:
|
|
||||||
- label: I understand that windows aren't shown on Wayland unless I draw and present to them.
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
51
.github/ISSUE_TEMPLATE/bug_web.yml
vendored
51
.github/ISSUE_TEMPLATE/bug_web.yml
vendored
@@ -1,51 +0,0 @@
|
|||||||
name: Web bug
|
|
||||||
description: Create a web-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - web
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: dropdown
|
|
||||||
id: browsers
|
|
||||||
attributes:
|
|
||||||
label: Tested browsers
|
|
||||||
description: What browsers are you seeing the problem on?
|
|
||||||
options:
|
|
||||||
- Firefox
|
|
||||||
- Chrome
|
|
||||||
- Microsoft Edge
|
|
||||||
- Safari 13
|
|
||||||
- Safari 14
|
|
||||||
- Safari 15
|
|
||||||
- Safari 16
|
|
||||||
- Safari 17
|
|
||||||
- Safari (newer than listed)
|
|
||||||
multiple: true
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: device
|
|
||||||
attributes:
|
|
||||||
label: Tested devices
|
|
||||||
description: Which device(s) are you using?
|
|
||||||
placeholder: 'iPhone 15, Lenovo ThinkPad X1, MacBook Pro M2, Samsung Galaxy Z, ...'
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
35
.github/ISSUE_TEMPLATE/bug_windows.yml
vendored
35
.github/ISSUE_TEMPLATE/bug_windows.yml
vendored
@@ -1,35 +0,0 @@
|
|||||||
name: Windows bug
|
|
||||||
description: Create a Windows-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - windows
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: os-version
|
|
||||||
attributes:
|
|
||||||
label: Windows version
|
|
||||||
description: What version of Windows are you using? Please paste in the output of the `ver` command.
|
|
||||||
placeholder: |
|
|
||||||
Microsoft Windows [Version 10.0.19042.2251]
|
|
||||||
render: shell
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
32
.github/ISSUE_TEMPLATE/bug_x11.yml
vendored
32
.github/ISSUE_TEMPLATE/bug_x11.yml
vendored
@@ -1,32 +0,0 @@
|
|||||||
name: X11 bug
|
|
||||||
description: Create a X11-specific bug report
|
|
||||||
labels:
|
|
||||||
- B - bug
|
|
||||||
- DS - x11
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem you're having
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: os-info
|
|
||||||
attributes:
|
|
||||||
label: OS and window mananger
|
|
||||||
description: Which operating system and window manager are you using?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: winit-version
|
|
||||||
attributes:
|
|
||||||
label: Winit version
|
|
||||||
description: What version of Winit are you using?
|
|
||||||
placeholder: 0.29.11
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
5
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,5 +0,0 @@
|
|||||||
blank_issues_enabled: true
|
|
||||||
contact_links:
|
|
||||||
- name: Question
|
|
||||||
url: https://matrix.to/#/#rust-windowing:matrix.org
|
|
||||||
about: Please ask questions on the Matrix channel.
|
|
||||||
26
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
26
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@@ -1,26 +0,0 @@
|
|||||||
name: Feature request
|
|
||||||
description: Propose a new feature
|
|
||||||
labels:
|
|
||||||
- S - enhancement
|
|
||||||
body:
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Description of the problem does this solve or what need does it fill? Please be mindful of the [scope](https://github.com/rust-windowing/winit/blob/master/FEATURES.md) of Winit.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: dropdown
|
|
||||||
id: platforms
|
|
||||||
attributes:
|
|
||||||
label: Relevant platforms
|
|
||||||
description: On which platforms is this feature relevant?
|
|
||||||
options:
|
|
||||||
- Windows
|
|
||||||
- macOS
|
|
||||||
- Wayland
|
|
||||||
- X11
|
|
||||||
- Web
|
|
||||||
- iOS
|
|
||||||
- Android
|
|
||||||
multiple: true
|
|
||||||
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,5 +1,5 @@
|
|||||||
- [ ] Tested on all platforms changed
|
- [ ] Tested on all platforms changed
|
||||||
- [ ] Added an entry to the `changelog` module if knowledge of this change could be valuable to users
|
- [ ] Added an entry to `CHANGELOG.md` if knowledge of this change could be valuable to users
|
||||||
- [ ] Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
|
- [ ] Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
|
||||||
- [ ] Created or updated an example program if it would help users understand this functionality
|
- [ ] Created or updated an example program if it would help users understand this functionality
|
||||||
- [ ] Updated [feature matrix](https://github.com/rust-windowing/winit/blob/master/FEATURES.md), if new features were added or implemented
|
- [ ] Updated [feature matrix](https://github.com/rust-windowing/winit/blob/master/FEATURES.md), if new features were added or implemented
|
||||||
|
|||||||
45
.github/workflows/ci.yml
vendored
45
.github/workflows/ci.yml
vendored
@@ -10,31 +10,13 @@ jobs:
|
|||||||
name: Check formatting
|
name: Check formatting
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: dtolnay/rust-toolchain@nightly
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
with:
|
with:
|
||||||
components: rustfmt
|
components: rustfmt
|
||||||
- name: Check Formatting
|
- name: Check Formatting
|
||||||
run: cargo fmt -- --check
|
run: cargo fmt -- --check
|
||||||
|
|
||||||
typos:
|
|
||||||
name: Check for typos
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 30
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: taiki-e/install-action@v2
|
|
||||||
with:
|
|
||||||
tool: typos-cli
|
|
||||||
- name: run typos
|
|
||||||
run: typos
|
|
||||||
- name: Typos info
|
|
||||||
if: failure()
|
|
||||||
run: |
|
|
||||||
echo 'To fix typos, please run `typos -w`'
|
|
||||||
echo 'To check for a diff, run `typos`'
|
|
||||||
echo 'You can find typos here: https://crates.io/crates/typos'
|
|
||||||
|
|
||||||
tests:
|
tests:
|
||||||
name: Test ${{ matrix.toolchain }} ${{ matrix.platform.name }}
|
name: Test ${{ matrix.toolchain }} ${{ matrix.platform.name }}
|
||||||
runs-on: ${{ matrix.platform.os }}
|
runs-on: ${{ matrix.platform.os }}
|
||||||
@@ -53,7 +35,7 @@ jobs:
|
|||||||
- { name: 'Linux 64bit', target: x86_64-unknown-linux-gnu, os: ubuntu-latest, }
|
- { name: 'Linux 64bit', target: x86_64-unknown-linux-gnu, os: ubuntu-latest, }
|
||||||
- { name: 'X11', target: x86_64-unknown-linux-gnu, os: ubuntu-latest, options: '--no-default-features --features=x11' }
|
- { name: 'X11', target: x86_64-unknown-linux-gnu, os: ubuntu-latest, options: '--no-default-features --features=x11' }
|
||||||
- { name: 'Wayland', target: x86_64-unknown-linux-gnu, os: ubuntu-latest, options: '--no-default-features --features=wayland,wayland-dlopen' }
|
- { name: 'Wayland', target: x86_64-unknown-linux-gnu, os: ubuntu-latest, options: '--no-default-features --features=wayland,wayland-dlopen' }
|
||||||
- { name: 'Android', target: aarch64-linux-android, os: ubuntu-latest, options: '--package=winit --features=android-native-activity', cmd: 'apk --' }
|
- { name: 'Android', target: aarch64-linux-android, os: ubuntu-latest, options: '--features=android-native-activity', cmd: 'apk --' }
|
||||||
- { name: 'Redox OS', target: x86_64-unknown-redox, os: ubuntu-latest, }
|
- { name: 'Redox OS', target: x86_64-unknown-redox, os: ubuntu-latest, }
|
||||||
- { name: 'macOS', target: x86_64-apple-darwin, os: macos-latest, }
|
- { name: 'macOS', target: x86_64-apple-darwin, os: macos-latest, }
|
||||||
- { name: 'iOS x86_64', target: x86_64-apple-ios, os: macos-latest, }
|
- { name: 'iOS x86_64', target: x86_64-apple-ios, os: macos-latest, }
|
||||||
@@ -88,7 +70,7 @@ jobs:
|
|||||||
CMD: ${{ matrix.platform.cmd }}
|
CMD: ${{ matrix.platform.cmd }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: Restore cache of cargo folder
|
- name: Restore cache of cargo folder
|
||||||
# We use `restore` and later `save`, so that we can create the key after
|
# We use `restore` and later `save`, so that we can create the key after
|
||||||
@@ -107,7 +89,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Generate lockfile
|
- name: Generate lockfile
|
||||||
# Also updates the crates.io index
|
# Also updates the crates.io index
|
||||||
run: cargo generate-lockfile && cargo update -p ahash --precise 0.8.7 && cargo update -p bumpalo --precise 3.14.0
|
run: cargo generate-lockfile
|
||||||
|
|
||||||
- name: Install GCC Multilib
|
- name: Install GCC Multilib
|
||||||
if: (matrix.platform.os == 'ubuntu-latest') && contains(matrix.platform.target, 'i686')
|
if: (matrix.platform.os == 'ubuntu-latest') && contains(matrix.platform.target, 'i686')
|
||||||
@@ -143,20 +125,13 @@ jobs:
|
|||||||
RUSTDOCFLAGS: '--deny=warnings ${{ matrix.platform.rustflags }}'
|
RUSTDOCFLAGS: '--deny=warnings ${{ matrix.platform.rustflags }}'
|
||||||
|
|
||||||
- name: Build crate
|
- name: Build crate
|
||||||
run: cargo $CMD build $OPTIONS
|
run: cargo $CMD build -p winit $OPTIONS
|
||||||
|
|
||||||
# Test only on Linux x86_64, so we avoid spending unnecessary CI hours.
|
|
||||||
- name: Test dpi crate
|
|
||||||
if: >
|
|
||||||
contains(matrix.platform.name, 'Linux 64bit') &&
|
|
||||||
matrix.toolchain != '1.70.0'
|
|
||||||
run: cargo test -p dpi
|
|
||||||
|
|
||||||
- name: Build tests
|
- name: Build tests
|
||||||
if: >
|
if: >
|
||||||
!contains(matrix.platform.target, 'redox') &&
|
!contains(matrix.platform.target, 'redox') &&
|
||||||
matrix.toolchain != '1.70.0'
|
matrix.toolchain != '1.70.0'
|
||||||
run: cargo $CMD test --no-run $OPTIONS
|
run: cargo $CMD test -p winit --no-run $OPTIONS
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
if: >
|
if: >
|
||||||
@@ -175,7 +150,7 @@ jobs:
|
|||||||
if: >
|
if: >
|
||||||
!contains(matrix.platform.target, 'redox') &&
|
!contains(matrix.platform.target, 'redox') &&
|
||||||
matrix.toolchain != '1.70.0'
|
matrix.toolchain != '1.70.0'
|
||||||
run: cargo $CMD test --no-run $OPTIONS --features serde
|
run: cargo $CMD test --no-run $OPTIONS -p winit --features serde
|
||||||
|
|
||||||
- name: Run tests with serde enabled
|
- name: Run tests with serde enabled
|
||||||
if: >
|
if: >
|
||||||
@@ -190,7 +165,7 @@ jobs:
|
|||||||
if: matrix.toolchain == 'nightly'
|
if: matrix.toolchain == 'nightly'
|
||||||
run: cargo doc --no-deps $OPTIONS --features=rwh_04,rwh_05,rwh_06,serde,mint,android-native-activity
|
run: cargo doc --no-deps $OPTIONS --features=rwh_04,rwh_05,rwh_06,serde,mint,android-native-activity
|
||||||
env:
|
env:
|
||||||
RUSTDOCFLAGS: '--deny=warnings ${{ matrix.platform.rustflags }} --cfg=docsrs --cfg=unreleased_changelogs'
|
RUSTDOCFLAGS: '--deny=warnings ${{ matrix.platform.rustflags }} --cfg=docsrs'
|
||||||
|
|
||||||
# See restore step above
|
# See restore step above
|
||||||
- name: Save cache of cargo folder
|
- name: Save cache of cargo folder
|
||||||
@@ -220,7 +195,7 @@ jobs:
|
|||||||
- { name: 'Windows', target: x86_64-pc-windows-gnu }
|
- { name: 'Windows', target: x86_64-pc-windows-gnu }
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: EmbarkStudios/cargo-deny-action@v1
|
- uses: EmbarkStudios/cargo-deny-action@v1
|
||||||
with:
|
with:
|
||||||
command: check
|
command: check
|
||||||
|
|||||||
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- uses: dtolnay/rust-toolchain@master
|
- uses: dtolnay/rust-toolchain@master
|
||||||
with:
|
with:
|
||||||
@@ -27,7 +27,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Run Rustdoc
|
- name: Run Rustdoc
|
||||||
env:
|
env:
|
||||||
RUSTDOCFLAGS: --crate-version master --cfg=docsrs --cfg=unreleased_changelogs
|
RUSTDOCFLAGS: --crate-version master --cfg=docsrs
|
||||||
run: |
|
run: |
|
||||||
cargo doc --no-deps -Z rustdoc-map -Z rustdoc-scrape-examples --features=rwh_04,rwh_05,rwh_06,serde,mint,android-native-activity
|
cargo doc --no-deps -Z rustdoc-map -Z rustdoc-scrape-examples --features=rwh_04,rwh_05,rwh_06,serde,mint,android-native-activity
|
||||||
|
|
||||||
|
|||||||
1259
CHANGELOG.md
1259
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@@ -1,6 +0,0 @@
|
|||||||
# Code of Conduct
|
|
||||||
|
|
||||||
The `rust-windowing` project adheres to the [Rust Code of Conduct]. This
|
|
||||||
describes the minimum behavior expected from all contributors.
|
|
||||||
|
|
||||||
[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
|
|
||||||
160
CONTRIBUTING.md
160
CONTRIBUTING.md
@@ -1,145 +1,71 @@
|
|||||||
# Contribution Guidelines
|
# Winit Contributing Guidelines
|
||||||
|
|
||||||
This document contains guidelines for contributing code to winit. It has to be
|
## Scope
|
||||||
followed in order for your patch to be approved and applied.
|
[See `FEATURES.md`](./FEATURES.md). When requesting or implementing a new Winit feature, you should
|
||||||
|
consider whether or not it's directly related to window creation or input handling. If it isn't, it
|
||||||
|
may be worth creating a separate crate that extends Winit's API to add that functionality.
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Anyone can contribute to winit, however given that it's a cross platform
|
## Reporting an issue
|
||||||
windowing toolkit getting certain changes incorporated could be challenging.
|
|
||||||
|
|
||||||
To save your time it's wise to check already opened [pull requests][prs] and
|
When reporting an issue, in order to help the maintainers understand what the problem is, please make
|
||||||
[issues][issues]. In general, bug fixes and missing implementations are always
|
your description of the issue as detailed as possible:
|
||||||
accepted, however larger new API proposals should go into the issue first. When
|
|
||||||
in doubt contact us on [Matrix][matrix] or via opening an issue.
|
|
||||||
|
|
||||||
### Submitting your work and handling review
|
- if it is a bug, please provide a clear explanation of what happens, what should happen, and how to
|
||||||
|
reproduce the issue, ideally by providing a minimal program exhibiting the problem
|
||||||
|
- if it is a feature request, please provide a clear argumentation about why you believe this feature
|
||||||
|
should be supported by winit
|
||||||
|
|
||||||
All patches have to be sent on Github as [pull requests][prs]. To simplify your
|
## Making a pull request
|
||||||
life during review it's recommended to check the "give contributors write access
|
|
||||||
to the branch" checkbox.
|
|
||||||
|
|
||||||
#### Handling review
|
When making a code contribution to winit, before opening your pull request, please make sure that:
|
||||||
|
|
||||||
During the review process certain events could require an action from your side,
|
- your patch builds with Winit's minimal supported rust version - Rust 1.70.
|
||||||
common patterns and reactions are described below.
|
- you tested your modifications on all the platforms impacted, or if not possible, detail which platforms
|
||||||
|
were not tested, and what should be tested, so that a maintainer or another contributor can test them
|
||||||
|
- you updated any relevant documentation in winit
|
||||||
|
- you left comments in your code explaining any part that is not straightforward, so that the
|
||||||
|
maintainers and future contributors don't have to try to guess what your code is supposed to do
|
||||||
|
- your PR adds an entry to the changelog file if the introduced change is relevant to winit users.
|
||||||
|
|
||||||
_Event:_ The CI fails to build, but it looks like it is not your fault. Not
|
You needn't worry about the added entry causing conflicts, the maintainer that merges the PR will
|
||||||
communicating so could result in maintainers not looking into your patch,
|
handle those for you when merging (see below).
|
||||||
since they may assume that you're still working on it.\
|
- if your PR affects the platform compatibility of one or more features or adds another feature, the
|
||||||
_Desired behaviour:_ Write a message saying roughly the following "The CI
|
relevant sections in [`FEATURES.md`](https://github.com/rust-windowing/winit/blob/master/FEATURES.md#features)
|
||||||
failure is unrelated", so that the maintainers will fix it for you.
|
should be updated.
|
||||||
|
|
||||||
_Event:_ Maintainer requested changes to your PR.\
|
Once your PR is open, you can ask for a review by a maintainer of your platform. Winit's merging policy
|
||||||
_Desired behavior:_ Once you address the request, you should re-request a review
|
is that a PR must be approved by at least two maintainers of winit before being merged, including
|
||||||
with GitHub's UI. If you don't agree with what maintainer suggested, you
|
at least a maintainer of the platform (a maintainer making a PR themselves counts as approving it).
|
||||||
should state your objections and re-request the review. That will indicate that
|
|
||||||
the ball is on maintainer's side.
|
|
||||||
|
|
||||||
_Event:_ You've opened a PR, but maintainer shortly after commented that they
|
Once your PR is deemed ready, the merging maintainer will take care of resolving conflicts in
|
||||||
want to work on that themselves.\
|
`CHANGELOG.md` (but you must resolve other conflicts yourself). Doing this requires that you check the
|
||||||
_Desired behavior:_ Discuss with the maintainer regarding their plans if they
|
"give contributors write access to the branch" checkbox when creating the PR.
|
||||||
were not outlined in the initial response, because such response means that they
|
|
||||||
are not interested in reviewing your code. Such thing could happen when
|
|
||||||
underestimating complexity of the task you're solving or when your patch
|
|
||||||
mandate certain downstream designs. In general, the maintainer will likely
|
|
||||||
close your PR in order to prevent work being done on it.
|
|
||||||
|
|
||||||
[prs]: https://github.com/rust-windowing/winit/pulls
|
## Maintainers & Testers
|
||||||
[issues]: https://github.com/rust-windowing/winit/issues
|
|
||||||
[matrix]: https://matrix.to/#/#rust-windowing:matrix.org
|
|
||||||
|
|
||||||
## Maintainers
|
The current maintainers are listed in the [CODEOWNERS](.github/CODEOWNERS) file.
|
||||||
|
|
||||||
Winit has plenty of maintainers with different backgrounds, different time
|
If you are interested in being pinged when testing is needed for a specific platform, please add yourself to the [Testers and Contributors](https://github.com/rust-windowing/winit/wiki/Testers-and-Contributors) table!
|
||||||
available to work on Winit, and reasons to be winit maintainer in the first
|
|
||||||
place. To ensure that Winit's code quality does not decrease over time and to
|
|
||||||
make it easier to teach new maintainers the "winit way of doing things" the
|
|
||||||
common policies and routines are defined in this section.
|
|
||||||
|
|
||||||
The current maintainers for each platform are listed in [this file][CODEOWNERS].
|
## Release process
|
||||||
|
|
||||||
### Contributions handling
|
|
||||||
|
|
||||||
The maintainers must ensure that the external contributions meet Winit's
|
|
||||||
quality standards. If it's not, it **is the maintainer's responsibility** to
|
|
||||||
bring it on par, which includes:
|
|
||||||
|
|
||||||
- Ensure that formatting is consistent and `CHANGELOG` messages are clear
|
|
||||||
for the end users.
|
|
||||||
- Improve the commit message, so it'll be easier for other maintainers to
|
|
||||||
understand the motivation without going through all the discussions on the
|
|
||||||
particular patch/PR.
|
|
||||||
- Ensure that the proposed patch doesn't break platform parity. If the
|
|
||||||
breakage is desired by contributor, an issue should be opened to discuss
|
|
||||||
with other maintainers before merging.
|
|
||||||
- Always fix CI issues before merging if they don't originate from the
|
|
||||||
submitted work.
|
|
||||||
|
|
||||||
However, maintainers should give some leeway for external contributors, so they
|
|
||||||
don't feel discouraged contributing, for example:
|
|
||||||
|
|
||||||
- Suggest a patch to resolve style issues, if it's the only issue with the
|
|
||||||
submitted work. Keep in mind that pushing the resolution yourself is not
|
|
||||||
desired, because the contributor might not agree with what you did.
|
|
||||||
- Be more explicit on how things should be done if you don't like the
|
|
||||||
approach.
|
|
||||||
- Suggest to finish the PR for them if they're absent for a while and you need
|
|
||||||
the proposed changes to move forward with something. In such cases the
|
|
||||||
maintainer must preserve attribution with `Co-authored-by`, `Suggested-by`,
|
|
||||||
or keep the original committer.
|
|
||||||
- Rebase their work for them when massive changes to the Winit codebase were
|
|
||||||
introduced.
|
|
||||||
|
|
||||||
When reviewing code of other maintainers all of the above is on the maintainer
|
|
||||||
who submitted the patch. Interested maintainers could help push the work over
|
|
||||||
the finish line, but teaching other maintainers should be preferred.
|
|
||||||
|
|
||||||
For a _regular_ contributor to winit, the maintainer should slowly start
|
|
||||||
requiring contributor to match *maintainer* quality standards when writing
|
|
||||||
patches and commit messages.
|
|
||||||
|
|
||||||
### Contributing
|
|
||||||
|
|
||||||
When submitting a patch, the maintainer should follow the general contributing
|
|
||||||
guidelines, however greater attention to detail is expected in this case.
|
|
||||||
|
|
||||||
To make life simpler for other maintainers it's suggested to create your branch
|
|
||||||
under the project repository instead of your own fork. The naming scheme is
|
|
||||||
`github_user_name/branch_name`. Doing so will make your work easier to rebase
|
|
||||||
for other maintainers when you're absent.
|
|
||||||
|
|
||||||
### Administrative Actions
|
|
||||||
|
|
||||||
Some things (such as changing required CI steps, adding contributors, ...)
|
|
||||||
require administrative permissions. If you don't have those, ask about the
|
|
||||||
change in an issue. If you have the permissions, discuss it with at least one
|
|
||||||
other admin before making the change.
|
|
||||||
|
|
||||||
### Release process
|
|
||||||
|
|
||||||
Given that winit is a widely used library, we should be able to make a patch
|
Given that winit is a widely used library, we should be able to make a patch
|
||||||
releases at any time we want without blocking the development of new features.
|
releases at any time we want without blocking the development of new features.
|
||||||
|
|
||||||
To achieve these goals, a new branch is created for every new release. Releases
|
To achieve these goals, a new branch is created for every new release. Releases and later patch releases are committed and tagged in this branch.
|
||||||
and later patch releases are committed and tagged in this branch.
|
|
||||||
|
|
||||||
The exact steps for an exemplary `0.2.0` release might look like this:
|
The exact steps for an exemplary `0.2.0` release might look like this:
|
||||||
1. Initially, the version on the latest master is `0.1.0`
|
1. Initially, the version on the latest master is `0.1.0`
|
||||||
2. A new `v0.2.x` branch is created for the release
|
2. A new `v0.2.x` branch is created for the release
|
||||||
3. Update released `cfg_attr` in `src/changelog/mod.rs` to `v0.2.md`
|
3. In the branch, the version is bumped to `v0.2.0`
|
||||||
4. Move entries from `src/changelog/unreleased.md` into
|
4. The new commit in the branch is tagged `v0.2.0`
|
||||||
`src/changelog/v0.2.md`
|
5. The version is pushed to crates.io
|
||||||
5. In the branch, the version is bumped to `v0.2.0`
|
6. A GitHub release is created for the `v0.2.0` tag
|
||||||
6. The new commit in the branch is tagged `v0.2.0`
|
7. On master, the version is bumped to `0.2.0`, and the CHANGELOG is updated
|
||||||
7. The version is pushed to crates.io
|
|
||||||
8. A GitHub release is created for the `v0.2.0` tag
|
|
||||||
9. On master, the version is bumped to `0.2.0`, and the changelog is updated
|
|
||||||
|
|
||||||
When doing a patch release, the process is similar:
|
When doing a patch release, the process is similar:
|
||||||
1. Initially, the version of the latest release is `0.2.0`
|
1. Initially, the version of the latest release is `0.2.0`
|
||||||
2. Checkout the `v0.2.x` branch
|
2. Checkout the `v0.2.x` branch
|
||||||
3. Cherry-pick the required non-breaking changes into the `v0.2.x`
|
3. Cherry-pick the required non-breaking changes into the `v0.2.x`
|
||||||
4. Follow steps 4-9 of the regular release example
|
4. Follow steps 3-7 of the regular release example
|
||||||
|
|
||||||
[CODEOWNERS]: .github/CODEOWNERS
|
|
||||||
|
|||||||
362
Cargo.toml
362
Cargo.toml
@@ -1,356 +1,16 @@
|
|||||||
[package]
|
|
||||||
name = "winit"
|
|
||||||
version = "0.30.2"
|
|
||||||
authors = [
|
|
||||||
"The winit contributors",
|
|
||||||
"Pierre Krieger <pierre.krieger1708@gmail.com>",
|
|
||||||
]
|
|
||||||
description = "Cross-platform window creation library."
|
|
||||||
keywords = ["windowing"]
|
|
||||||
readme = "README.md"
|
|
||||||
documentation = "https://docs.rs/winit"
|
|
||||||
categories = ["gui"]
|
|
||||||
rust-version.workspace = true
|
|
||||||
repository.workspace = true
|
|
||||||
license.workspace = true
|
|
||||||
edition.workspace = true
|
|
||||||
exclude = ["/.cargo"]
|
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
|
||||||
features = [
|
|
||||||
"rwh_04",
|
|
||||||
"rwh_05",
|
|
||||||
"rwh_06",
|
|
||||||
"serde",
|
|
||||||
"mint",
|
|
||||||
# Enabled to get docs to compile
|
|
||||||
"android-native-activity",
|
|
||||||
]
|
|
||||||
# These are all tested in CI
|
|
||||||
targets = [
|
|
||||||
# Windows
|
|
||||||
"i686-pc-windows-msvc",
|
|
||||||
"x86_64-pc-windows-msvc",
|
|
||||||
# macOS
|
|
||||||
"x86_64-apple-darwin",
|
|
||||||
# Unix (X11 & Wayland)
|
|
||||||
"i686-unknown-linux-gnu",
|
|
||||||
"x86_64-unknown-linux-gnu",
|
|
||||||
# iOS
|
|
||||||
"x86_64-apple-ios",
|
|
||||||
# Android
|
|
||||||
"aarch64-linux-android",
|
|
||||||
# Web
|
|
||||||
"wasm32-unknown-unknown",
|
|
||||||
]
|
|
||||||
rustdoc-args = ["--cfg", "docsrs"]
|
|
||||||
|
|
||||||
# Features are documented in either `lib.rs` or under `winit::platform`.
|
|
||||||
[features]
|
|
||||||
default = ["rwh_06", "x11", "wayland", "wayland-dlopen", "wayland-csd-adwaita"]
|
|
||||||
x11 = ["x11-dl", "bytemuck", "percent-encoding", "xkbcommon-dl/x11", "x11rb"]
|
|
||||||
wayland = [
|
|
||||||
"wayland-client",
|
|
||||||
"wayland-backend",
|
|
||||||
"wayland-protocols",
|
|
||||||
"wayland-protocols-plasma",
|
|
||||||
"sctk",
|
|
||||||
"ahash",
|
|
||||||
"memmap2",
|
|
||||||
]
|
|
||||||
wayland-dlopen = ["wayland-backend/dlopen"]
|
|
||||||
wayland-csd-adwaita = ["sctk-adwaita", "sctk-adwaita/ab_glyph"]
|
|
||||||
wayland-csd-adwaita-crossfont = ["sctk-adwaita", "sctk-adwaita/crossfont"]
|
|
||||||
wayland-csd-adwaita-notitle = ["sctk-adwaita"]
|
|
||||||
android-native-activity = ["android-activity/native-activity"]
|
|
||||||
android-game-activity = ["android-activity/game-activity"]
|
|
||||||
serde = ["dep:serde", "cursor-icon/serde", "smol_str/serde", "dpi/serde"]
|
|
||||||
mint = ["dpi/mint"]
|
|
||||||
rwh_04 = ["dep:rwh_04", "ndk/rwh_04"]
|
|
||||||
rwh_05 = ["dep:rwh_05", "ndk/rwh_05"]
|
|
||||||
rwh_06 = ["dep:rwh_06", "ndk/rwh_06"]
|
|
||||||
|
|
||||||
[build-dependencies]
|
|
||||||
cfg_aliases = "0.2.1"
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
bitflags = "2"
|
|
||||||
cursor-icon = "1.1.0"
|
|
||||||
dpi = { version = "0.1.1", path = "dpi" }
|
|
||||||
rwh_04 = { package = "raw-window-handle", version = "0.4", optional = true }
|
|
||||||
rwh_05 = { package = "raw-window-handle", version = "0.5.2", features = [
|
|
||||||
"std",
|
|
||||||
], optional = true }
|
|
||||||
rwh_06 = { package = "raw-window-handle", version = "0.6", features = [
|
|
||||||
"std",
|
|
||||||
], optional = true }
|
|
||||||
serde = { workspace = true, optional = true }
|
|
||||||
smol_str = "0.2.0"
|
|
||||||
tracing = { version = "0.1.40", default_features = false }
|
|
||||||
|
|
||||||
[dev-dependencies]
|
|
||||||
image = { version = "0.25.0", default-features = false, features = ["png"] }
|
|
||||||
tracing = { version = "0.1.40", default_features = false, features = ["log"] }
|
|
||||||
tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
|
|
||||||
winit = { path = ".", features = ["rwh_05"] }
|
|
||||||
|
|
||||||
[target.'cfg(not(any(target_os = "android", target_os = "ios")))'.dev-dependencies]
|
|
||||||
softbuffer = { version = "0.4.0", default-features = false, features = [
|
|
||||||
"x11",
|
|
||||||
"x11-dlopen",
|
|
||||||
"wayland",
|
|
||||||
"wayland-dlopen",
|
|
||||||
] }
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "android")'.dependencies]
|
|
||||||
android-activity = "0.6.0"
|
|
||||||
ndk = { version = "0.9.0", default-features = false }
|
|
||||||
|
|
||||||
[target.'cfg(any(target_os = "ios", target_os = "macos"))'.dependencies]
|
|
||||||
core-foundation = "0.9.3"
|
|
||||||
objc2 = "0.5.2"
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "macos")'.dependencies]
|
|
||||||
core-graphics = "0.23.1"
|
|
||||||
block2 = "0.5.1"
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "macos")'.dependencies.objc2-foundation]
|
|
||||||
version = "0.2.2"
|
|
||||||
features = [
|
|
||||||
"block2",
|
|
||||||
"dispatch",
|
|
||||||
"NSArray",
|
|
||||||
"NSAttributedString",
|
|
||||||
"NSData",
|
|
||||||
"NSDictionary",
|
|
||||||
"NSDistributedNotificationCenter",
|
|
||||||
"NSEnumerator",
|
|
||||||
"NSNotification",
|
|
||||||
"NSObjCRuntime",
|
|
||||||
"NSPathUtilities",
|
|
||||||
"NSProcessInfo",
|
|
||||||
"NSRunLoop",
|
|
||||||
"NSString",
|
|
||||||
"NSThread",
|
|
||||||
"NSValue",
|
|
||||||
]
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "macos")'.dependencies.objc2-app-kit]
|
|
||||||
version = "0.2.2"
|
|
||||||
features = [
|
|
||||||
"NSAppearance",
|
|
||||||
"NSApplication",
|
|
||||||
"NSBitmapImageRep",
|
|
||||||
"NSButton",
|
|
||||||
"NSColor",
|
|
||||||
"NSControl",
|
|
||||||
"NSCursor",
|
|
||||||
"NSDragging",
|
|
||||||
"NSEvent",
|
|
||||||
"NSGraphics",
|
|
||||||
"NSGraphicsContext",
|
|
||||||
"NSImage",
|
|
||||||
"NSImageRep",
|
|
||||||
"NSMenu",
|
|
||||||
"NSMenuItem",
|
|
||||||
"NSOpenGLView",
|
|
||||||
"NSPasteboard",
|
|
||||||
"NSResponder",
|
|
||||||
"NSRunningApplication",
|
|
||||||
"NSScreen",
|
|
||||||
"NSTextInputClient",
|
|
||||||
"NSTextInputContext",
|
|
||||||
"NSView",
|
|
||||||
"NSWindow",
|
|
||||||
"NSWindowScripting",
|
|
||||||
"NSWindowTabGroup",
|
|
||||||
]
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "ios")'.dependencies.objc2-foundation]
|
|
||||||
version = "0.2.2"
|
|
||||||
features = [
|
|
||||||
"dispatch",
|
|
||||||
"NSArray",
|
|
||||||
"NSEnumerator",
|
|
||||||
"NSGeometry",
|
|
||||||
"NSObjCRuntime",
|
|
||||||
"NSString",
|
|
||||||
"NSProcessInfo",
|
|
||||||
"NSThread",
|
|
||||||
"NSSet",
|
|
||||||
]
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "ios")'.dependencies.objc2-ui-kit]
|
|
||||||
version = "0.2.2"
|
|
||||||
features = [
|
|
||||||
"UIApplication",
|
|
||||||
"UIDevice",
|
|
||||||
"UIEvent",
|
|
||||||
"UIGeometry",
|
|
||||||
"UIGestureRecognizer",
|
|
||||||
"UIOrientation",
|
|
||||||
"UIPanGestureRecognizer",
|
|
||||||
"UIPinchGestureRecognizer",
|
|
||||||
"UIResponder",
|
|
||||||
"UIRotationGestureRecognizer",
|
|
||||||
"UIScreen",
|
|
||||||
"UIScreenMode",
|
|
||||||
"UITapGestureRecognizer",
|
|
||||||
"UITouch",
|
|
||||||
"UITraitCollection",
|
|
||||||
"UIView",
|
|
||||||
"UIViewController",
|
|
||||||
"UIWindow",
|
|
||||||
]
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "windows")'.dependencies]
|
|
||||||
unicode-segmentation = "1.7.1"
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "windows")'.dependencies.windows-sys]
|
|
||||||
version = "0.52.0"
|
|
||||||
features = [
|
|
||||||
"Win32_Devices_HumanInterfaceDevice",
|
|
||||||
"Win32_Foundation",
|
|
||||||
"Win32_Globalization",
|
|
||||||
"Win32_Graphics_Dwm",
|
|
||||||
"Win32_Graphics_Gdi",
|
|
||||||
"Win32_Media",
|
|
||||||
"Win32_System_Com_StructuredStorage",
|
|
||||||
"Win32_System_Com",
|
|
||||||
"Win32_System_LibraryLoader",
|
|
||||||
"Win32_System_Ole",
|
|
||||||
"Win32_System_SystemInformation",
|
|
||||||
"Win32_System_SystemServices",
|
|
||||||
"Win32_System_Threading",
|
|
||||||
"Win32_System_WindowsProgramming",
|
|
||||||
"Win32_UI_Accessibility",
|
|
||||||
"Win32_UI_Controls",
|
|
||||||
"Win32_UI_HiDpi",
|
|
||||||
"Win32_UI_Input_Ime",
|
|
||||||
"Win32_UI_Input_KeyboardAndMouse",
|
|
||||||
"Win32_UI_Input_Pointer",
|
|
||||||
"Win32_UI_Input_Touch",
|
|
||||||
"Win32_UI_Shell",
|
|
||||||
"Win32_UI_TextServices",
|
|
||||||
"Win32_UI_WindowsAndMessaging",
|
|
||||||
]
|
|
||||||
|
|
||||||
[target.'cfg(all(unix, not(any(target_os = "redox", target_family = "wasm", target_os = "android", target_os = "ios", target_os = "macos"))))'.dependencies]
|
|
||||||
ahash = { version = "0.8.7", features = ["no-rng"], optional = true }
|
|
||||||
bytemuck = { version = "1.13.1", default-features = false, optional = true }
|
|
||||||
calloop = "0.12.3"
|
|
||||||
libc = "0.2.64"
|
|
||||||
memmap2 = { version = "0.9.0", optional = true }
|
|
||||||
percent-encoding = { version = "2.0", optional = true }
|
|
||||||
rustix = { version = "0.38.4", default-features = false, features = [
|
|
||||||
"std",
|
|
||||||
"system",
|
|
||||||
"thread",
|
|
||||||
"process",
|
|
||||||
] }
|
|
||||||
sctk = { package = "smithay-client-toolkit", version = "0.18.0", default-features = false, features = [
|
|
||||||
"calloop",
|
|
||||||
], optional = true }
|
|
||||||
sctk-adwaita = { version = "0.9.0", default_features = false, optional = true }
|
|
||||||
wayland-backend = { version = "0.3.0", default_features = false, features = [
|
|
||||||
"client_system",
|
|
||||||
], optional = true }
|
|
||||||
wayland-client = { version = "0.31.1", optional = true }
|
|
||||||
wayland-protocols = { version = "0.31.0", features = [
|
|
||||||
"staging",
|
|
||||||
], optional = true }
|
|
||||||
wayland-protocols-plasma = { version = "0.2.0", features = [
|
|
||||||
"client",
|
|
||||||
], optional = true }
|
|
||||||
x11-dl = { version = "2.19.1", optional = true }
|
|
||||||
x11rb = { version = "0.13.0", default-features = false, features = [
|
|
||||||
"allow-unsafe-code",
|
|
||||||
"dl-libxcb",
|
|
||||||
"randr",
|
|
||||||
"resource_manager",
|
|
||||||
"xinput",
|
|
||||||
"xkb",
|
|
||||||
], optional = true }
|
|
||||||
xkbcommon-dl = "0.4.2"
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "redox")'.dependencies]
|
|
||||||
orbclient = { version = "0.3.47", default-features = false }
|
|
||||||
redox_syscall = "0.4.1"
|
|
||||||
|
|
||||||
[target.'cfg(target_family = "wasm")'.dependencies.web_sys]
|
|
||||||
package = "web-sys"
|
|
||||||
version = "0.3.64"
|
|
||||||
features = [
|
|
||||||
'AbortController',
|
|
||||||
'AbortSignal',
|
|
||||||
'Blob',
|
|
||||||
'console',
|
|
||||||
'CssStyleDeclaration',
|
|
||||||
'Document',
|
|
||||||
'DomException',
|
|
||||||
'DomRect',
|
|
||||||
'DomRectReadOnly',
|
|
||||||
'Element',
|
|
||||||
'Event',
|
|
||||||
'EventTarget',
|
|
||||||
'FocusEvent',
|
|
||||||
'HtmlCanvasElement',
|
|
||||||
'HtmlElement',
|
|
||||||
'HtmlImageElement',
|
|
||||||
'ImageBitmap',
|
|
||||||
'ImageBitmapOptions',
|
|
||||||
'ImageBitmapRenderingContext',
|
|
||||||
'ImageData',
|
|
||||||
'IntersectionObserver',
|
|
||||||
'IntersectionObserverEntry',
|
|
||||||
'KeyboardEvent',
|
|
||||||
'MediaQueryList',
|
|
||||||
'MessageChannel',
|
|
||||||
'MessagePort',
|
|
||||||
'Node',
|
|
||||||
'PageTransitionEvent',
|
|
||||||
'PointerEvent',
|
|
||||||
'PremultiplyAlpha',
|
|
||||||
'ResizeObserver',
|
|
||||||
'ResizeObserverBoxOptions',
|
|
||||||
'ResizeObserverEntry',
|
|
||||||
'ResizeObserverOptions',
|
|
||||||
'ResizeObserverSize',
|
|
||||||
'VisibilityState',
|
|
||||||
'Window',
|
|
||||||
'WheelEvent',
|
|
||||||
'Url',
|
|
||||||
]
|
|
||||||
|
|
||||||
[target.'cfg(target_family = "wasm")'.dependencies]
|
|
||||||
js-sys = "0.3.64"
|
|
||||||
pin-project = "1"
|
|
||||||
wasm-bindgen = "0.2"
|
|
||||||
wasm-bindgen-futures = "0.4"
|
|
||||||
web-time = "1"
|
|
||||||
|
|
||||||
[target.'cfg(all(target_family = "wasm", target_feature = "atomics"))'.dependencies]
|
|
||||||
atomic-waker = "1"
|
|
||||||
concurrent-queue = { version = "2", default-features = false }
|
|
||||||
|
|
||||||
[target.'cfg(target_family = "wasm")'.dev-dependencies]
|
|
||||||
console_error_panic_hook = "0.1"
|
|
||||||
tracing-web = "0.1"
|
|
||||||
|
|
||||||
[[example]]
|
|
||||||
doc-scrape-examples = true
|
|
||||||
name = "window"
|
|
||||||
|
|
||||||
[workspace]
|
[workspace]
|
||||||
|
members = [
|
||||||
|
"run-wasm",
|
||||||
|
"winit",
|
||||||
|
"winit-core"
|
||||||
|
]
|
||||||
resolver = "2"
|
resolver = "2"
|
||||||
members = ["dpi"]
|
|
||||||
|
|
||||||
[workspace.package]
|
|
||||||
rust-version = "1.70.0"
|
|
||||||
repository = "https://github.com/rust-windowing/winit"
|
|
||||||
license = "Apache-2.0"
|
|
||||||
edition = "2021"
|
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
|
bitflags = "2"
|
||||||
|
cfg_aliases = "0.2.0"
|
||||||
|
cursor-icon = "1.1.0"
|
||||||
serde = { version = "1", features = ["serde_derive"] }
|
serde = { version = "1", features = ["serde_derive"] }
|
||||||
mint = "0.5.6"
|
smol_str = "0.2.0"
|
||||||
|
web-time = "1"
|
||||||
|
winit-core = { path = "./winit-core", default-features = false, features = ["std"] }
|
||||||
|
|||||||
13
FEATURES.md
13
FEATURES.md
@@ -3,8 +3,8 @@
|
|||||||
Winit aims to expose an interface that abstracts over window creation and input handling and can
|
Winit aims to expose an interface that abstracts over window creation and input handling and can
|
||||||
be used to create both games and applications. It supports the following main graphical platforms:
|
be used to create both games and applications. It supports the following main graphical platforms:
|
||||||
- Desktop
|
- Desktop
|
||||||
- Windows
|
- Windows 7+ (10+ is tested regularly)
|
||||||
- macOS
|
- macOS 10.7+ (10.14+ is tested regularly)
|
||||||
- Unix
|
- Unix
|
||||||
- via X11
|
- via X11
|
||||||
- via Wayland
|
- via Wayland
|
||||||
@@ -13,6 +13,9 @@ be used to create both games and applications. It supports the following main gr
|
|||||||
- iOS
|
- iOS
|
||||||
- Android
|
- Android
|
||||||
- Web
|
- Web
|
||||||
|
- Chrome
|
||||||
|
- Firefox
|
||||||
|
- Safari 13.1+
|
||||||
|
|
||||||
Most platforms expose capabilities that cannot be meaningfully transposed onto others. Winit does not
|
Most platforms expose capabilities that cannot be meaningfully transposed onto others. Winit does not
|
||||||
aim to support every single feature of every platform, but rather to abstract over the common features
|
aim to support every single feature of every platform, but rather to abstract over the common features
|
||||||
@@ -148,6 +151,7 @@ If your PR makes notable changes to Winit's features, please update this section
|
|||||||
* Setting the X11 parent window
|
* Setting the X11 parent window
|
||||||
|
|
||||||
### iOS
|
### iOS
|
||||||
|
* `winit` has a minimum OS requirement of iOS 8
|
||||||
* Get the `UIScreen` object pointer
|
* Get the `UIScreen` object pointer
|
||||||
* Setting the `UIView` hidpi factor
|
* Setting the `UIView` hidpi factor
|
||||||
* Valid orientations
|
* Valid orientations
|
||||||
@@ -160,6 +164,9 @@ If your PR makes notable changes to Winit's features, please update this section
|
|||||||
### Web
|
### Web
|
||||||
* Get if the systems preferred color scheme is "dark"
|
* Get if the systems preferred color scheme is "dark"
|
||||||
|
|
||||||
|
## Usability
|
||||||
|
* `serde`: Enables serialization/deserialization of certain types with Serde. (Maintainer: @Osspial)
|
||||||
|
|
||||||
## Compatibility Matrix
|
## Compatibility Matrix
|
||||||
|
|
||||||
Legend:
|
Legend:
|
||||||
@@ -179,7 +186,7 @@ Legend:
|
|||||||
|Window decorations |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|**N/A**|✔️ |
|
|Window decorations |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|**N/A**|✔️ |
|
||||||
|Window decorations toggle |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|**N/A**|**N/A** |
|
|Window decorations toggle |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|**N/A**|**N/A** |
|
||||||
|Window resizing |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|✔️ |✔️ |
|
|Window resizing |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|✔️ |✔️ |
|
||||||
|Window resize increments |✔️ |✔️ |✔️ |❌ |**N/A**|**N/A**|**N/A**|**N/A** |
|
|Window resize increments |❌ |✔️ |✔️ |❌ |**N/A**|**N/A**|**N/A**|**N/A** |
|
||||||
|Window transparency |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|N/A |✔️ |
|
|Window transparency |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|N/A |✔️ |
|
||||||
|Window blur |❌ |❌ |❌ |✔️ |**N/A**|**N/A**|N/A |❌ |
|
|Window blur |❌ |❌ |❌ |✔️ |**N/A**|**N/A**|N/A |❌ |
|
||||||
|Window maximization |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|**N/A**|**N/A** |
|
|Window maximization |✔️ |✔️ |✔️ |✔️ |**N/A**|**N/A**|**N/A**|**N/A** |
|
||||||
|
|||||||
128
README.md
128
README.md
@@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
```toml
|
```toml
|
||||||
[dependencies]
|
[dependencies]
|
||||||
winit = "0.30.2"
|
winit = "0.29.10"
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Documentation](https://docs.rs/winit)
|
## [Documentation](https://docs.rs/winit)
|
||||||
@@ -21,7 +21,7 @@ For features _outside_ the scope of winit, see [Are we GUI Yet?](https://arewegu
|
|||||||
|
|
||||||
Join us in our [](https://matrix.to/#/#rust-windowing:matrix.org) room. If you don't get an answer there, try [](https://web.libera.chat/#winit).
|
Join us in our [](https://matrix.to/#/#rust-windowing:matrix.org) room. If you don't get an answer there, try [](https://web.libera.chat/#winit).
|
||||||
|
|
||||||
The maintainers have a meeting every friday at UTC 15. The meeting notes can be found [here](https://hackmd.io/@winit-meetings).
|
The maintainers have a meeting every friday at UTC 14. The meeting notes can be found [here](https://hackmd.io/@winit-meetings).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@@ -33,6 +33,14 @@ Winit is designed to be a low-level brick in a hierarchy of libraries. Consequen
|
|||||||
show something on the window you need to use the platform-specific getters provided by winit, or
|
show something on the window you need to use the platform-specific getters provided by winit, or
|
||||||
another library.
|
another library.
|
||||||
|
|
||||||
|
### Cargo Features
|
||||||
|
|
||||||
|
Winit provides the following features, which can be enabled in your `Cargo.toml` file:
|
||||||
|
* `serde`: Enables serialization/deserialization of certain types with [Serde](https://crates.io/crates/serde).
|
||||||
|
* `x11` (enabled by default): On Unix platform, compiles with the X11 backend
|
||||||
|
* `wayland` (enabled by default): On Unix platform, compiles with the Wayland backend
|
||||||
|
* `mint`: Enables mint (math interoperability standard types) conversions.
|
||||||
|
|
||||||
## MSRV Policy
|
## MSRV Policy
|
||||||
|
|
||||||
This crate's Minimum Supported Rust Version (MSRV) is **1.70**. Changes to
|
This crate's Minimum Supported Rust Version (MSRV) is **1.70**. Changes to
|
||||||
@@ -63,4 +71,118 @@ same MSRV policy.
|
|||||||
|
|
||||||
### Platform-specific usage
|
### Platform-specific usage
|
||||||
|
|
||||||
Check out the [`winit::platform`](https://rust-windowing.github.io/winit/winit/platform/index.html) module for platform-specific usage.
|
#### Wayland
|
||||||
|
|
||||||
|
Note that windows don't appear on Wayland until you draw/present to them.
|
||||||
|
|
||||||
|
#### Web
|
||||||
|
|
||||||
|
To run the web example: `cargo run-wasm --example web`
|
||||||
|
|
||||||
|
Winit supports compiling to the `wasm32-unknown-unknown` target with `web-sys`.
|
||||||
|
|
||||||
|
On the web platform, a Winit window is backed by a `<canvas>` element. You can
|
||||||
|
either [provide Winit with a `<canvas>` element][web with_canvas], or [let Winit
|
||||||
|
create a `<canvas>` element which you can then retrieve][web canvas getter] and
|
||||||
|
insert it into the DOM yourself.
|
||||||
|
|
||||||
|
For the example code using Winit on Web, check out the [web example]. For
|
||||||
|
information on using Rust on WebAssembly, check out the [Rust and WebAssembly
|
||||||
|
book].
|
||||||
|
|
||||||
|
[web with_canvas]: https://docs.rs/winit/latest/wasm32-unknown-unknown/winit/platform/web/trait.WindowBuilderExtWebSys.html#tymethod.with_canvas
|
||||||
|
[web canvas getter]: https://docs.rs/winit/latest/wasm32-unknown-unknown/winit/platform/web/trait.WindowExtWebSys.html#tymethod.canvas
|
||||||
|
[web example]: ./examples/web.rs
|
||||||
|
[Rust and WebAssembly book]: https://rustwasm.github.io/book/
|
||||||
|
|
||||||
|
#### Android
|
||||||
|
|
||||||
|
The Android backend builds on (and exposes types from) the [`ndk`](https://docs.rs/ndk/latest/ndk/) crate.
|
||||||
|
|
||||||
|
Native Android applications need some form of "glue" crate that is responsible
|
||||||
|
for defining the main entry point for your Rust application as well as tracking
|
||||||
|
various life-cycle events and synchronizing with the main JVM thread.
|
||||||
|
|
||||||
|
Winit uses the [android-activity](https://github.com/rib/android-activity) as a
|
||||||
|
glue crate (prior to `0.28` it used
|
||||||
|
[ndk-glue](https://github.com/rust-windowing/android-ndk-rs/tree/master/ndk-glue)).
|
||||||
|
|
||||||
|
The version of the glue crate that your application depends on _must_ match the
|
||||||
|
version that Winit depends on because the glue crate is responsible for your
|
||||||
|
application's main entry point. If Cargo resolves multiple versions, they will
|
||||||
|
clash.
|
||||||
|
|
||||||
|
`winit` glue compatibility table:
|
||||||
|
|
||||||
|
| winit | ndk-glue |
|
||||||
|
| :---: | :--------------------------: |
|
||||||
|
| 0.29 | `android-activity = "0.5"` |
|
||||||
|
| 0.28 | `android-activity = "0.4"` |
|
||||||
|
| 0.27 | `ndk-glue = "0.7"` |
|
||||||
|
| 0.26 | `ndk-glue = "0.5"` |
|
||||||
|
| 0.25 | `ndk-glue = "0.3"` |
|
||||||
|
| 0.24 | `ndk-glue = "0.2"` |
|
||||||
|
|
||||||
|
The recommended way to avoid a conflict with the glue version is to avoid explicitly
|
||||||
|
depending on the `android-activity` crate, and instead consume the API that
|
||||||
|
is re-exported by Winit under `winit::platform::android::activity::*`
|
||||||
|
|
||||||
|
Running on an Android device needs a dynamic system library. Add this to Cargo.toml:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[lib]
|
||||||
|
name = "main"
|
||||||
|
crate-type = ["cdylib"]
|
||||||
|
```
|
||||||
|
|
||||||
|
All Android applications are based on an `Activity` subclass, and the
|
||||||
|
`android-activity` crate is designed to support different choices for this base
|
||||||
|
class. Your application _must_ specify the base class it needs via a feature flag:
|
||||||
|
|
||||||
|
| Base Class | Feature Flag | Notes |
|
||||||
|
| :--------------: | :---------------: | :-----: |
|
||||||
|
| `NativeActivity` | `android-native-activity` | Built-in to Android - it is possible to use without compiling any Java or Kotlin code. Java or Kotlin code may be needed to subclass `NativeActivity` to access some platform features. It does not derive from the [`AndroidAppCompat`] base class.|
|
||||||
|
| [`GameActivity`] | `android-game-activity` | Derives from [`AndroidAppCompat`], a defacto standard `Activity` base class that helps support a wider range of Android versions. Requires a build system that can compile Java or Kotlin and fetch Android dependencies from a [Maven repository][agdk_jetpack] (or link with an embedded [release][agdk_releases] of [`GameActivity`]) |
|
||||||
|
|
||||||
|
[`GameActivity`]: https://developer.android.com/games/agdk/game-activity
|
||||||
|
[`GameTextInput`]: https://developer.android.com/games/agdk/add-support-for-text-input
|
||||||
|
[`AndroidAppCompat`]: https://developer.android.com/reference/androidx/appcompat/app/AppCompatActivity
|
||||||
|
[agdk_jetpack]: https://developer.android.com/jetpack/androidx/releases/games
|
||||||
|
[agdk_releases]: https://developer.android.com/games/agdk/download#agdk-libraries
|
||||||
|
[Gradle]: https://developer.android.com/studio/build
|
||||||
|
|
||||||
|
For more details, refer to these `android-activity` [example applications](https://github.com/rust-mobile/android-activity/tree/main/examples).
|
||||||
|
|
||||||
|
##### Converting from `ndk-glue` to `android-activity`
|
||||||
|
|
||||||
|
If your application is currently based on `NativeActivity` via the `ndk-glue` crate and building with `cargo apk`, then the minimal changes would be:
|
||||||
|
1. Remove `ndk-glue` from your `Cargo.toml`
|
||||||
|
2. Enable the `"android-native-activity"` feature for Winit: `winit = { version = "0.29.10", features = [ "android-native-activity" ] }`
|
||||||
|
3. Add an `android_main` entrypoint (as above), instead of using the '`[ndk_glue::main]` proc macro from `ndk-macros` (optionally add a dependency on `android_logger` and initialize logging as above).
|
||||||
|
4. Pass a clone of the `AndroidApp` that your application receives to Winit when building your event loop (as shown above).
|
||||||
|
|
||||||
|
#### MacOS
|
||||||
|
|
||||||
|
A lot of functionality expects the application to be ready before you start
|
||||||
|
doing anything; this includes creating windows, fetching monitors, drawing,
|
||||||
|
and so on, see issues [#2238], [#2051] and [#2087].
|
||||||
|
|
||||||
|
If you encounter problems, you should try doing your initialization inside
|
||||||
|
`Event::Resumed`.
|
||||||
|
|
||||||
|
#### iOS
|
||||||
|
|
||||||
|
Similar to macOS, iOS's main `UIApplicationMain` does some init work that's required
|
||||||
|
by all UI-related code (see issue [#1705]). It would be best to consider creating your windows
|
||||||
|
inside `Event::Resumed`.
|
||||||
|
|
||||||
|
|
||||||
|
[#2238]: https://github.com/rust-windowing/winit/issues/2238
|
||||||
|
[#2051]: https://github.com/rust-windowing/winit/issues/2051
|
||||||
|
[#2087]: https://github.com/rust-windowing/winit/issues/2087
|
||||||
|
[#1705]: https://github.com/rust-windowing/winit/issues/1705
|
||||||
|
|
||||||
|
#### Redox OS
|
||||||
|
|
||||||
|
Redox OS has some functionality not yet present that will be implemented when
|
||||||
|
its orbital display server provides it.
|
||||||
|
|||||||
@@ -10,6 +10,6 @@ disallowed-methods = [
|
|||||||
{ path = "web_sys::Element::request_fullscreen", reason = "Doesn't account for compatibility with Safari" },
|
{ path = "web_sys::Element::request_fullscreen", reason = "Doesn't account for compatibility with Safari" },
|
||||||
{ path = "web_sys::Document::exit_fullscreen", reason = "Doesn't account for compatibility with Safari" },
|
{ path = "web_sys::Document::exit_fullscreen", reason = "Doesn't account for compatibility with Safari" },
|
||||||
{ path = "web_sys::Document::fullscreen_element", reason = "Doesn't account for compatibility with Safari" },
|
{ path = "web_sys::Document::fullscreen_element", reason = "Doesn't account for compatibility with Safari" },
|
||||||
{ path = "objc2_app_kit::NSView::visibleRect", reason = "We expose a render target to the user, and visibility is not really relevant to that (and can break if you don't use the rectangle position as well). Use `frame` instead." },
|
{ path = "icrate::AppKit::NSView::visibleRect", reason = "We expose a render target to the user, and visibility is not really relevant to that (and can break if you don't use the rectangle position as well). Use `frame` instead." },
|
||||||
{ path = "objc2_app_kit::NSWindow::setFrameTopLeftPoint", reason = "Not sufficient when working with Winit's coordinate system, use `flip_window_screen_coordinates` instead" },
|
{ path = "icrate::AppKit::NSWindow::setFrameTopLeftPoint", reason = "Not sufficient when working with Winit's coordinate system, use `flip_window_screen_coordinates` instead" },
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -35,7 +35,9 @@ skip = [
|
|||||||
{ name = "bitflags" }, # the ecosystem is in the process of migrating.
|
{ name = "bitflags" }, # the ecosystem is in the process of migrating.
|
||||||
{ name = "libloading" }, # x11rb uses a different version until the next update
|
{ name = "libloading" }, # x11rb uses a different version until the next update
|
||||||
]
|
]
|
||||||
skip-tree = []
|
skip-tree = [
|
||||||
|
{ name = "run-wasm", version = "0.1.0" }
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
[licenses]
|
[licenses]
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
|
||||||
|
|
||||||
Please keep one empty line before and after all headers. (This is required for
|
|
||||||
`git` to produce a conflict when a release is made while a PR is open and the
|
|
||||||
PR's changelog entry would go into the wrong section).
|
|
||||||
|
|
||||||
And please only add new entries to the top of this list, right below the `#
|
|
||||||
Unreleased` header.
|
|
||||||
|
|
||||||
## Unreleased
|
|
||||||
|
|
||||||
## 0.1.1
|
|
||||||
|
|
||||||
- Derive `Debug`, `Copy`, `Clone`, `PartialEq`, `Serialize`, `Deserialize` traits for `PixelUnit`.
|
|
||||||
|
|
||||||
## 0.1.0
|
|
||||||
|
|
||||||
- Add `LogicalUnit`, `PhysicalUnit` and `PixelUnit` types and related functions.
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
[package]
|
|
||||||
name = "dpi"
|
|
||||||
version = "0.1.1"
|
|
||||||
description = "Types for handling UI scaling"
|
|
||||||
keywords = ["DPI", "HiDPI", "scale-factor"]
|
|
||||||
categories = ["gui"]
|
|
||||||
rust-version.workspace = true
|
|
||||||
repository.workspace = true
|
|
||||||
license.workspace = true
|
|
||||||
edition.workspace = true
|
|
||||||
|
|
||||||
[features]
|
|
||||||
serde = ["dep:serde"]
|
|
||||||
mint = ["dep:mint"]
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
serde = { workspace = true, optional = true }
|
|
||||||
mint = { workspace = true, optional = true }
|
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
|
||||||
features = ["serde", "mint"]
|
|
||||||
# These are all tested in CI
|
|
||||||
targets = [
|
|
||||||
# Windows
|
|
||||||
"i686-pc-windows-msvc",
|
|
||||||
"x86_64-pc-windows-msvc",
|
|
||||||
# macOS
|
|
||||||
"x86_64-apple-darwin",
|
|
||||||
# Unix (X11 & Wayland)
|
|
||||||
"i686-unknown-linux-gnu",
|
|
||||||
"x86_64-unknown-linux-gnu",
|
|
||||||
# iOS
|
|
||||||
"x86_64-apple-ios",
|
|
||||||
# Android
|
|
||||||
"aarch64-linux-android",
|
|
||||||
# Web
|
|
||||||
"wasm32-unknown-unknown",
|
|
||||||
]
|
|
||||||
rustdoc-args = ["--cfg", "docsrs"]
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
../LICENSE
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
#[cfg(all(feature = "rwh_06", any(x11_platform, macos_platform, windows_platform)))]
|
|
||||||
#[allow(deprecated)]
|
|
||||||
fn main() -> Result<(), impl std::error::Error> {
|
|
||||||
use std::collections::HashMap;
|
|
||||||
|
|
||||||
use winit::dpi::{LogicalPosition, LogicalSize, Position};
|
|
||||||
use winit::event::{ElementState, Event, KeyEvent, WindowEvent};
|
|
||||||
use winit::event_loop::{ActiveEventLoop, EventLoop};
|
|
||||||
use winit::raw_window_handle::HasRawWindowHandle;
|
|
||||||
use winit::window::Window;
|
|
||||||
|
|
||||||
#[path = "util/fill.rs"]
|
|
||||||
mod fill;
|
|
||||||
|
|
||||||
fn spawn_child_window(parent: &Window, event_loop: &ActiveEventLoop) -> Window {
|
|
||||||
let parent = parent.raw_window_handle().unwrap();
|
|
||||||
let mut window_attributes = Window::default_attributes()
|
|
||||||
.with_title("child window")
|
|
||||||
.with_inner_size(LogicalSize::new(200.0f32, 200.0f32))
|
|
||||||
.with_position(Position::Logical(LogicalPosition::new(0.0, 0.0)))
|
|
||||||
.with_visible(true);
|
|
||||||
// `with_parent_window` is unsafe. Parent window must be a valid window.
|
|
||||||
window_attributes = unsafe { window_attributes.with_parent_window(Some(parent)) };
|
|
||||||
|
|
||||||
event_loop.create_window(window_attributes).unwrap()
|
|
||||||
}
|
|
||||||
|
|
||||||
let mut windows = HashMap::new();
|
|
||||||
|
|
||||||
let event_loop: EventLoop<()> = EventLoop::new().unwrap();
|
|
||||||
let mut parent_window_id = None;
|
|
||||||
|
|
||||||
event_loop.run(move |event: Event<()>, event_loop| {
|
|
||||||
match event {
|
|
||||||
Event::Resumed => {
|
|
||||||
let attributes = Window::default_attributes()
|
|
||||||
.with_title("parent window")
|
|
||||||
.with_position(Position::Logical(LogicalPosition::new(0.0, 0.0)))
|
|
||||||
.with_inner_size(LogicalSize::new(640.0f32, 480.0f32));
|
|
||||||
let window = event_loop.create_window(attributes).unwrap();
|
|
||||||
|
|
||||||
parent_window_id = Some(window.id());
|
|
||||||
|
|
||||||
println!("Parent window id: {parent_window_id:?})");
|
|
||||||
windows.insert(window.id(), window);
|
|
||||||
},
|
|
||||||
Event::WindowEvent { window_id, event } => match event {
|
|
||||||
WindowEvent::CloseRequested => {
|
|
||||||
windows.clear();
|
|
||||||
event_loop.exit();
|
|
||||||
},
|
|
||||||
WindowEvent::CursorEntered { device_id: _ } => {
|
|
||||||
// On x11, println when the cursor entered in a window even if the child window
|
|
||||||
// is created by some key inputs.
|
|
||||||
// the child windows are always placed at (0, 0) with size (200, 200) in the
|
|
||||||
// parent window, so we also can see this log when we move
|
|
||||||
// the cursor around (200, 200) in parent window.
|
|
||||||
println!("cursor entered in the window {window_id:?}");
|
|
||||||
},
|
|
||||||
WindowEvent::KeyboardInput {
|
|
||||||
event: KeyEvent { state: ElementState::Pressed, .. },
|
|
||||||
..
|
|
||||||
} => {
|
|
||||||
let parent_window = windows.get(&parent_window_id.unwrap()).unwrap();
|
|
||||||
let child_window = spawn_child_window(parent_window, event_loop);
|
|
||||||
let child_id = child_window.id();
|
|
||||||
println!("Child window created with id: {child_id:?}");
|
|
||||||
windows.insert(child_id, child_window);
|
|
||||||
},
|
|
||||||
WindowEvent::RedrawRequested => {
|
|
||||||
if let Some(window) = windows.get(&window_id) {
|
|
||||||
fill::fill_window(window);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(all(feature = "rwh_06", not(any(x11_platform, macos_platform, windows_platform))))]
|
|
||||||
fn main() {
|
|
||||||
panic!(
|
|
||||||
"This example is supported only on x11, macOS, and Windows, with the `rwh_06` feature \
|
|
||||||
enabled."
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
#![allow(clippy::single_match)]
|
|
||||||
|
|
||||||
use std::thread;
|
|
||||||
#[cfg(not(web_platform))]
|
|
||||||
use std::time;
|
|
||||||
|
|
||||||
use ::tracing::{info, warn};
|
|
||||||
#[cfg(web_platform)]
|
|
||||||
use web_time as time;
|
|
||||||
|
|
||||||
use winit::application::ApplicationHandler;
|
|
||||||
use winit::event::{ElementState, KeyEvent, StartCause, WindowEvent};
|
|
||||||
use winit::event_loop::{ActiveEventLoop, ControlFlow, EventLoop};
|
|
||||||
use winit::keyboard::{Key, NamedKey};
|
|
||||||
use winit::window::{Window, WindowId};
|
|
||||||
|
|
||||||
#[path = "util/fill.rs"]
|
|
||||||
mod fill;
|
|
||||||
#[path = "util/tracing.rs"]
|
|
||||||
mod tracing;
|
|
||||||
|
|
||||||
const WAIT_TIME: time::Duration = time::Duration::from_millis(100);
|
|
||||||
const POLL_SLEEP_TIME: time::Duration = time::Duration::from_millis(100);
|
|
||||||
|
|
||||||
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
|
|
||||||
enum Mode {
|
|
||||||
#[default]
|
|
||||||
Wait,
|
|
||||||
WaitUntil,
|
|
||||||
Poll,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn main() -> Result<(), impl std::error::Error> {
|
|
||||||
#[cfg(web_platform)]
|
|
||||||
console_error_panic_hook::set_once();
|
|
||||||
|
|
||||||
tracing::init();
|
|
||||||
|
|
||||||
info!("Press '1' to switch to Wait mode.");
|
|
||||||
info!("Press '2' to switch to WaitUntil mode.");
|
|
||||||
info!("Press '3' to switch to Poll mode.");
|
|
||||||
info!("Press 'R' to toggle request_redraw() calls.");
|
|
||||||
info!("Press 'Esc' to close the window.");
|
|
||||||
|
|
||||||
let event_loop = EventLoop::new().unwrap();
|
|
||||||
|
|
||||||
let mut app = ControlFlowDemo::default();
|
|
||||||
event_loop.run_app(&mut app)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Default)]
|
|
||||||
struct ControlFlowDemo {
|
|
||||||
mode: Mode,
|
|
||||||
request_redraw: bool,
|
|
||||||
wait_cancelled: bool,
|
|
||||||
close_requested: bool,
|
|
||||||
window: Option<Window>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ApplicationHandler for ControlFlowDemo {
|
|
||||||
fn new_events(&mut self, _event_loop: &ActiveEventLoop, cause: StartCause) {
|
|
||||||
info!("new_events: {cause:?}");
|
|
||||||
|
|
||||||
self.wait_cancelled = match cause {
|
|
||||||
StartCause::WaitCancelled { .. } => self.mode == Mode::WaitUntil,
|
|
||||||
_ => false,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let window_attributes = Window::default_attributes().with_title(
|
|
||||||
"Press 1, 2, 3 to change control flow mode. Press R to toggle redraw requests.",
|
|
||||||
);
|
|
||||||
self.window = Some(event_loop.create_window(window_attributes).unwrap());
|
|
||||||
}
|
|
||||||
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
_event_loop: &ActiveEventLoop,
|
|
||||||
_window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
) {
|
|
||||||
info!("{event:?}");
|
|
||||||
|
|
||||||
match event {
|
|
||||||
WindowEvent::CloseRequested => {
|
|
||||||
self.close_requested = true;
|
|
||||||
},
|
|
||||||
WindowEvent::KeyboardInput {
|
|
||||||
event: KeyEvent { logical_key: key, state: ElementState::Pressed, .. },
|
|
||||||
..
|
|
||||||
} => match key.as_ref() {
|
|
||||||
// WARNING: Consider using `key_without_modifiers()` if available on your platform.
|
|
||||||
// See the `key_binding` example
|
|
||||||
Key::Character("1") => {
|
|
||||||
self.mode = Mode::Wait;
|
|
||||||
warn!("mode: {:?}", self.mode);
|
|
||||||
},
|
|
||||||
Key::Character("2") => {
|
|
||||||
self.mode = Mode::WaitUntil;
|
|
||||||
warn!("mode: {:?}", self.mode);
|
|
||||||
},
|
|
||||||
Key::Character("3") => {
|
|
||||||
self.mode = Mode::Poll;
|
|
||||||
warn!("mode: {:?}", self.mode);
|
|
||||||
},
|
|
||||||
Key::Character("r") => {
|
|
||||||
self.request_redraw = !self.request_redraw;
|
|
||||||
warn!("request_redraw: {}", self.request_redraw);
|
|
||||||
},
|
|
||||||
Key::Named(NamedKey::Escape) => {
|
|
||||||
self.close_requested = true;
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
},
|
|
||||||
WindowEvent::RedrawRequested => {
|
|
||||||
let window = self.window.as_ref().unwrap();
|
|
||||||
window.pre_present_notify();
|
|
||||||
fill::fill_window(window);
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
if self.request_redraw && !self.wait_cancelled && !self.close_requested {
|
|
||||||
self.window.as_ref().unwrap().request_redraw();
|
|
||||||
}
|
|
||||||
|
|
||||||
match self.mode {
|
|
||||||
Mode::Wait => event_loop.set_control_flow(ControlFlow::Wait),
|
|
||||||
Mode::WaitUntil => {
|
|
||||||
if !self.wait_cancelled {
|
|
||||||
event_loop
|
|
||||||
.set_control_flow(ControlFlow::WaitUntil(time::Instant::now() + WAIT_TIME));
|
|
||||||
}
|
|
||||||
},
|
|
||||||
Mode::Poll => {
|
|
||||||
thread::sleep(POLL_SLEEP_TIME);
|
|
||||||
event_loop.set_control_flow(ControlFlow::Poll);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
if self.close_requested {
|
|
||||||
event_loop.exit();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
#![allow(clippy::single_match)]
|
|
||||||
|
|
||||||
// Limit this example to only compatible platforms.
|
|
||||||
#[cfg(any(windows_platform, macos_platform, x11_platform, wayland_platform, android_platform,))]
|
|
||||||
fn main() -> std::process::ExitCode {
|
|
||||||
use std::process::ExitCode;
|
|
||||||
use std::thread::sleep;
|
|
||||||
use std::time::Duration;
|
|
||||||
|
|
||||||
use winit::application::ApplicationHandler;
|
|
||||||
use winit::event::WindowEvent;
|
|
||||||
use winit::event_loop::{ActiveEventLoop, EventLoop};
|
|
||||||
use winit::platform::pump_events::{EventLoopExtPumpEvents, PumpStatus};
|
|
||||||
use winit::window::{Window, WindowId};
|
|
||||||
|
|
||||||
#[path = "util/fill.rs"]
|
|
||||||
mod fill;
|
|
||||||
|
|
||||||
#[derive(Default)]
|
|
||||||
struct PumpDemo {
|
|
||||||
window: Option<Window>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ApplicationHandler for PumpDemo {
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let window_attributes = Window::default_attributes().with_title("A fantastic window!");
|
|
||||||
self.window = Some(event_loop.create_window(window_attributes).unwrap());
|
|
||||||
}
|
|
||||||
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
_window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
) {
|
|
||||||
println!("{event:?}");
|
|
||||||
|
|
||||||
let window = match self.window.as_ref() {
|
|
||||||
Some(window) => window,
|
|
||||||
None => return,
|
|
||||||
};
|
|
||||||
|
|
||||||
match event {
|
|
||||||
WindowEvent::CloseRequested => event_loop.exit(),
|
|
||||||
WindowEvent::RedrawRequested => {
|
|
||||||
fill::fill_window(window);
|
|
||||||
window.request_redraw();
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let mut event_loop = EventLoop::new().unwrap();
|
|
||||||
|
|
||||||
tracing_subscriber::fmt::init();
|
|
||||||
|
|
||||||
let mut app = PumpDemo::default();
|
|
||||||
|
|
||||||
loop {
|
|
||||||
let timeout = Some(Duration::ZERO);
|
|
||||||
let status = event_loop.pump_app_events(timeout, &mut app);
|
|
||||||
|
|
||||||
if let PumpStatus::Exit(exit_code) = status {
|
|
||||||
break ExitCode::from(exit_code as u8);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sleep for 1/60 second to simulate application work
|
|
||||||
//
|
|
||||||
// Since `pump_events` doesn't block it will be important to
|
|
||||||
// throttle the loop in the app somehow.
|
|
||||||
println!("Update()");
|
|
||||||
sleep(Duration::from_millis(16));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(any(ios_platform, web_platform, orbital_platform))]
|
|
||||||
fn main() {
|
|
||||||
println!("This platform doesn't support pump_events.");
|
|
||||||
}
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
#![allow(clippy::single_match)]
|
|
||||||
|
|
||||||
// Limit this example to only compatible platforms.
|
|
||||||
#[cfg(any(windows_platform, macos_platform, x11_platform, wayland_platform,))]
|
|
||||||
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
||||||
use std::time::Duration;
|
|
||||||
|
|
||||||
use winit::application::ApplicationHandler;
|
|
||||||
use winit::event::WindowEvent;
|
|
||||||
use winit::event_loop::{ActiveEventLoop, EventLoop};
|
|
||||||
use winit::platform::run_on_demand::EventLoopExtRunOnDemand;
|
|
||||||
use winit::window::{Window, WindowId};
|
|
||||||
|
|
||||||
#[path = "util/fill.rs"]
|
|
||||||
mod fill;
|
|
||||||
|
|
||||||
#[derive(Default)]
|
|
||||||
struct App {
|
|
||||||
idx: usize,
|
|
||||||
window_id: Option<WindowId>,
|
|
||||||
window: Option<Window>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ApplicationHandler for App {
|
|
||||||
fn about_to_wait(&mut self, _event_loop: &ActiveEventLoop) {
|
|
||||||
if let Some(window) = self.window.as_ref() {
|
|
||||||
window.request_redraw();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let window_attributes = Window::default_attributes()
|
|
||||||
.with_title("Fantastic window number one!")
|
|
||||||
.with_inner_size(winit::dpi::LogicalSize::new(128.0, 128.0));
|
|
||||||
let window = event_loop.create_window(window_attributes).unwrap();
|
|
||||||
self.window_id = Some(window.id());
|
|
||||||
self.window = Some(window);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
) {
|
|
||||||
if event == WindowEvent::Destroyed && self.window_id == Some(window_id) {
|
|
||||||
println!(
|
|
||||||
"--------------------------------------------------------- Window {} Destroyed",
|
|
||||||
self.idx
|
|
||||||
);
|
|
||||||
self.window_id = None;
|
|
||||||
event_loop.exit();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
let window = match self.window.as_mut() {
|
|
||||||
Some(window) => window,
|
|
||||||
None => return,
|
|
||||||
};
|
|
||||||
|
|
||||||
match event {
|
|
||||||
WindowEvent::CloseRequested => {
|
|
||||||
println!(
|
|
||||||
"--------------------------------------------------------- Window {} \
|
|
||||||
CloseRequested",
|
|
||||||
self.idx
|
|
||||||
);
|
|
||||||
fill::cleanup_window(window);
|
|
||||||
self.window = None;
|
|
||||||
},
|
|
||||||
WindowEvent::RedrawRequested => {
|
|
||||||
fill::fill_window(window);
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
tracing_subscriber::fmt::init();
|
|
||||||
|
|
||||||
let mut event_loop = EventLoop::new().unwrap();
|
|
||||||
|
|
||||||
let mut app = App { idx: 1, ..Default::default() };
|
|
||||||
event_loop.run_app_on_demand(&mut app)?;
|
|
||||||
|
|
||||||
println!("--------------------------------------------------------- Finished first loop");
|
|
||||||
println!("--------------------------------------------------------- Waiting 5 seconds");
|
|
||||||
std::thread::sleep(Duration::from_secs(5));
|
|
||||||
|
|
||||||
app.idx += 1;
|
|
||||||
event_loop.run_app_on_demand(&mut app)?;
|
|
||||||
println!("--------------------------------------------------------- Finished second loop");
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(not(any(windows_platform, macos_platform, x11_platform, wayland_platform,)))]
|
|
||||||
fn main() {
|
|
||||||
println!("This example is not supported on this platform");
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
#[cfg(not(web_platform))]
|
|
||||||
pub fn init() {
|
|
||||||
use tracing_subscriber::filter::{EnvFilter, LevelFilter};
|
|
||||||
|
|
||||||
tracing_subscriber::fmt()
|
|
||||||
.with_env_filter(
|
|
||||||
EnvFilter::builder().with_default_directive(LevelFilter::INFO.into()).from_env_lossy(),
|
|
||||||
)
|
|
||||||
.init();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(web_platform)]
|
|
||||||
pub fn init() {
|
|
||||||
use tracing_subscriber::layer::SubscriberExt;
|
|
||||||
use tracing_subscriber::util::SubscriberInitExt;
|
|
||||||
|
|
||||||
tracing_subscriber::registry()
|
|
||||||
.with(
|
|
||||||
tracing_subscriber::fmt::layer()
|
|
||||||
.with_ansi(false)
|
|
||||||
.without_time()
|
|
||||||
.with_writer(tracing_web::MakeWebConsoleWriter::new()),
|
|
||||||
)
|
|
||||||
.init();
|
|
||||||
}
|
|
||||||
1072
examples/window.rs
1072
examples/window.rs
File diff suppressed because it is too large
Load Diff
@@ -1,69 +0,0 @@
|
|||||||
//! A demonstration of embedding a winit window in an existing X11 application.
|
|
||||||
use std::error::Error;
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
fn main() -> Result<(), Box<dyn Error>> {
|
|
||||||
use winit::application::ApplicationHandler;
|
|
||||||
use winit::event::WindowEvent;
|
|
||||||
use winit::event_loop::{ActiveEventLoop, EventLoop};
|
|
||||||
use winit::platform::x11::WindowAttributesExtX11;
|
|
||||||
use winit::window::{Window, WindowId};
|
|
||||||
|
|
||||||
#[path = "util/fill.rs"]
|
|
||||||
mod fill;
|
|
||||||
|
|
||||||
pub struct XEmbedDemo {
|
|
||||||
parent_window_id: u32,
|
|
||||||
window: Option<Window>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ApplicationHandler for XEmbedDemo {
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let window_attributes = Window::default_attributes()
|
|
||||||
.with_title("An embedded window!")
|
|
||||||
.with_inner_size(winit::dpi::LogicalSize::new(128.0, 128.0))
|
|
||||||
.with_embed_parent_window(self.parent_window_id);
|
|
||||||
|
|
||||||
self.window = Some(event_loop.create_window(window_attributes).unwrap());
|
|
||||||
}
|
|
||||||
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
_window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
) {
|
|
||||||
let window = self.window.as_ref().unwrap();
|
|
||||||
match event {
|
|
||||||
WindowEvent::CloseRequested => event_loop.exit(),
|
|
||||||
WindowEvent::RedrawRequested => {
|
|
||||||
window.pre_present_notify();
|
|
||||||
fill::fill_window(window);
|
|
||||||
},
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn about_to_wait(&mut self, _event_loop: &ActiveEventLoop) {
|
|
||||||
self.window.as_ref().unwrap().request_redraw();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// First argument should be a 32-bit X11 window ID.
|
|
||||||
let parent_window_id = std::env::args()
|
|
||||||
.nth(1)
|
|
||||||
.ok_or("Expected a 32-bit X11 window ID as the first argument.")?
|
|
||||||
.parse::<u32>()?;
|
|
||||||
|
|
||||||
tracing_subscriber::fmt::init();
|
|
||||||
let event_loop = EventLoop::new()?;
|
|
||||||
|
|
||||||
let mut app = XEmbedDemo { parent_window_id, window: None };
|
|
||||||
event_loop.run_app(&mut app).map_err(Into::into)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(not(x11_platform))]
|
|
||||||
fn main() -> Result<(), Box<dyn Error>> {
|
|
||||||
println!("This example is only supported on X11 platforms.");
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
8
run-wasm/Cargo.toml
Normal file
8
run-wasm/Cargo.toml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
[package]
|
||||||
|
name = "run-wasm"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2021"
|
||||||
|
publish = false
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
cargo-run-wasm = "0.2.0"
|
||||||
3
run-wasm/src/main.rs
Normal file
3
run-wasm/src/main.rs
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
fn main() {
|
||||||
|
cargo_run_wasm::run_wasm_with_css("body { margin: 0px; }");
|
||||||
|
}
|
||||||
22
rustfmt.toml
22
rustfmt.toml
@@ -1,19 +1,3 @@
|
|||||||
format_code_in_doc_comments = true
|
force_explicit_abi=true
|
||||||
match_block_trailing_comma = true
|
use_field_init_shorthand=true
|
||||||
condense_wildcard_suffixes = true
|
# merge_imports=true
|
||||||
use_field_init_shorthand = true
|
|
||||||
normalize_doc_attributes = true
|
|
||||||
overflow_delimited_expr = true
|
|
||||||
imports_granularity = "Module"
|
|
||||||
use_small_heuristics = "Max"
|
|
||||||
format_macro_matchers = true
|
|
||||||
error_on_unformatted = true
|
|
||||||
format_macro_bodies = true
|
|
||||||
hex_literal_case = "Lower"
|
|
||||||
normalize_comments = true
|
|
||||||
# Some macros break with this.
|
|
||||||
reorder_impl_items = false
|
|
||||||
newline_style = "Unix"
|
|
||||||
format_strings = true
|
|
||||||
wrap_comments = true
|
|
||||||
comment_width = 100
|
|
||||||
|
|||||||
@@ -1,339 +0,0 @@
|
|||||||
//! End user application handling.
|
|
||||||
|
|
||||||
use crate::event::{DeviceEvent, DeviceId, StartCause, WindowEvent};
|
|
||||||
use crate::event_loop::ActiveEventLoop;
|
|
||||||
use crate::window::WindowId;
|
|
||||||
|
|
||||||
/// The handler of the application events.
|
|
||||||
pub trait ApplicationHandler<T: 'static = ()> {
|
|
||||||
/// Emitted when new events arrive from the OS to be processed.
|
|
||||||
///
|
|
||||||
/// This is a useful place to put code that should be done before you start processing
|
|
||||||
/// events, such as updating frame timing information for benchmarking or checking the
|
|
||||||
/// [`StartCause`] to see if a timer set by
|
|
||||||
/// [`ControlFlow::WaitUntil`][crate::event_loop::ControlFlow::WaitUntil] has elapsed.
|
|
||||||
fn new_events(&mut self, event_loop: &ActiveEventLoop, cause: StartCause) {
|
|
||||||
let _ = (event_loop, cause);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Emitted when the application has been resumed.
|
|
||||||
///
|
|
||||||
/// For consistency, all platforms emit a `Resumed` event even if they don't themselves have a
|
|
||||||
/// formal suspend/resume lifecycle. For systems without a formal suspend/resume lifecycle
|
|
||||||
/// the `Resumed` event is always emitted after the
|
|
||||||
/// [`NewEvents(StartCause::Init)`][StartCause::Init] event.
|
|
||||||
///
|
|
||||||
/// # Portability
|
|
||||||
///
|
|
||||||
/// It's recommended that applications should only initialize their graphics context and create
|
|
||||||
/// a window after they have received their first `Resumed` event. Some systems
|
|
||||||
/// (specifically Android) won't allow applications to create a render surface until they are
|
|
||||||
/// resumed.
|
|
||||||
///
|
|
||||||
/// Considering that the implementation of [`Suspended`] and `Resumed` events may be internally
|
|
||||||
/// driven by multiple platform-specific events, and that there may be subtle differences across
|
|
||||||
/// platforms with how these internal events are delivered, it's recommended that applications
|
|
||||||
/// be able to gracefully handle redundant (i.e. back-to-back) [`Suspended`] or `Resumed`
|
|
||||||
/// events.
|
|
||||||
///
|
|
||||||
/// Also see [`Suspended`] notes.
|
|
||||||
///
|
|
||||||
/// ## Android
|
|
||||||
///
|
|
||||||
/// On Android, the `Resumed` event is sent when a new [`SurfaceView`] has been created. This is
|
|
||||||
/// expected to closely correlate with the [`onResume`] lifecycle event but there may
|
|
||||||
/// technically be a discrepancy.
|
|
||||||
///
|
|
||||||
/// [`onResume`]: https://developer.android.com/reference/android/app/Activity#onResume()
|
|
||||||
///
|
|
||||||
/// Applications that need to run on Android must wait until they have been `Resumed`
|
|
||||||
/// before they will be able to create a render surface (such as an `EGLSurface`,
|
|
||||||
/// [`VkSurfaceKHR`] or [`wgpu::Surface`]) which depend on having a
|
|
||||||
/// [`SurfaceView`]. Applications must also assume that if they are [`Suspended`], then their
|
|
||||||
/// render surfaces are invalid and should be dropped.
|
|
||||||
///
|
|
||||||
/// Also see [`Suspended`] notes.
|
|
||||||
///
|
|
||||||
/// [`SurfaceView`]: https://developer.android.com/reference/android/view/SurfaceView
|
|
||||||
/// [Activity lifecycle]: https://developer.android.com/guide/components/activities/activity-lifecycle
|
|
||||||
/// [`VkSurfaceKHR`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkSurfaceKHR.html
|
|
||||||
/// [`wgpu::Surface`]: https://docs.rs/wgpu/latest/wgpu/struct.Surface.html
|
|
||||||
///
|
|
||||||
/// ## iOS
|
|
||||||
///
|
|
||||||
/// On iOS, the `Resumed` event is emitted in response to an [`applicationDidBecomeActive`]
|
|
||||||
/// callback which means the application is "active" (according to the
|
|
||||||
/// [iOS application lifecycle]).
|
|
||||||
///
|
|
||||||
/// [`applicationDidBecomeActive`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622956-applicationdidbecomeactive
|
|
||||||
/// [iOS application lifecycle]: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle
|
|
||||||
///
|
|
||||||
/// ## Web
|
|
||||||
///
|
|
||||||
/// On Web, the `Resumed` event is emitted in response to a [`pageshow`] event
|
|
||||||
/// with the property [`persisted`] being true, which means that the page is being
|
|
||||||
/// restored from the [`bfcache`] (back/forward cache) - an in-memory cache that
|
|
||||||
/// stores a complete snapshot of a page (including the JavaScript heap) as the
|
|
||||||
/// user is navigating away.
|
|
||||||
///
|
|
||||||
/// [`pageshow`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event
|
|
||||||
/// [`persisted`]: https://developer.mozilla.org/en-US/docs/Web/API/PageTransitionEvent/persisted
|
|
||||||
/// [`bfcache`]: https://web.dev/bfcache/
|
|
||||||
/// [`Suspended`]: Self::suspended
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop);
|
|
||||||
|
|
||||||
/// Emitted when an event is sent from [`EventLoopProxy::send_event`].
|
|
||||||
///
|
|
||||||
/// [`EventLoopProxy::send_event`]: crate::event_loop::EventLoopProxy::send_event
|
|
||||||
fn user_event(&mut self, event_loop: &ActiveEventLoop, event: T) {
|
|
||||||
let _ = (event_loop, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Emitted when the OS sends an event to a winit window.
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
);
|
|
||||||
|
|
||||||
/// Emitted when the OS sends an event to a device.
|
|
||||||
fn device_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
device_id: DeviceId,
|
|
||||||
event: DeviceEvent,
|
|
||||||
) {
|
|
||||||
let _ = (event_loop, device_id, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Emitted when the event loop is about to block and wait for new events.
|
|
||||||
///
|
|
||||||
/// Most applications shouldn't need to hook into this event since there is no real relationship
|
|
||||||
/// between how often the event loop needs to wake up and the dispatching of any specific
|
|
||||||
/// events.
|
|
||||||
///
|
|
||||||
/// High frequency event sources, such as input devices could potentially lead to lots of wake
|
|
||||||
/// ups and also lots of corresponding `AboutToWait` events.
|
|
||||||
///
|
|
||||||
/// This is not an ideal event to drive application rendering from and instead applications
|
|
||||||
/// should render in response to [`WindowEvent::RedrawRequested`] events.
|
|
||||||
fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let _ = event_loop;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Emitted when the application has been suspended.
|
|
||||||
///
|
|
||||||
/// # Portability
|
|
||||||
///
|
|
||||||
/// Not all platforms support the notion of suspending applications, and there may be no
|
|
||||||
/// technical way to guarantee being able to emit a `Suspended` event if the OS has
|
|
||||||
/// no formal application lifecycle (currently only Android, iOS, and Web do). For this reason,
|
|
||||||
/// Winit does not currently try to emit pseudo `Suspended` events before the application
|
|
||||||
/// quits on platforms without an application lifecycle.
|
|
||||||
///
|
|
||||||
/// Considering that the implementation of `Suspended` and [`Resumed`] events may be internally
|
|
||||||
/// driven by multiple platform-specific events, and that there may be subtle differences across
|
|
||||||
/// platforms with how these internal events are delivered, it's recommended that applications
|
|
||||||
/// be able to gracefully handle redundant (i.e. back-to-back) `Suspended` or [`Resumed`]
|
|
||||||
/// events.
|
|
||||||
///
|
|
||||||
/// Also see [`Resumed`] notes.
|
|
||||||
///
|
|
||||||
/// ## Android
|
|
||||||
///
|
|
||||||
/// On Android, the `Suspended` event is only sent when the application's associated
|
|
||||||
/// [`SurfaceView`] is destroyed. This is expected to closely correlate with the [`onPause`]
|
|
||||||
/// lifecycle event but there may technically be a discrepancy.
|
|
||||||
///
|
|
||||||
/// [`onPause`]: https://developer.android.com/reference/android/app/Activity#onPause()
|
|
||||||
///
|
|
||||||
/// Applications that need to run on Android should assume their [`SurfaceView`] has been
|
|
||||||
/// destroyed, which indirectly invalidates any existing render surfaces that may have been
|
|
||||||
/// created outside of Winit (such as an `EGLSurface`, [`VkSurfaceKHR`] or [`wgpu::Surface`]).
|
|
||||||
///
|
|
||||||
/// After being `Suspended` on Android applications must drop all render surfaces before
|
|
||||||
/// the event callback completes, which may be re-created when the application is next
|
|
||||||
/// [`Resumed`].
|
|
||||||
///
|
|
||||||
/// [`SurfaceView`]: https://developer.android.com/reference/android/view/SurfaceView
|
|
||||||
/// [Activity lifecycle]: https://developer.android.com/guide/components/activities/activity-lifecycle
|
|
||||||
/// [`VkSurfaceKHR`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkSurfaceKHR.html
|
|
||||||
/// [`wgpu::Surface`]: https://docs.rs/wgpu/latest/wgpu/struct.Surface.html
|
|
||||||
///
|
|
||||||
/// ## iOS
|
|
||||||
///
|
|
||||||
/// On iOS, the `Suspended` event is currently emitted in response to an
|
|
||||||
/// [`applicationWillResignActive`] callback which means that the application is
|
|
||||||
/// about to transition from the active to inactive state (according to the
|
|
||||||
/// [iOS application lifecycle]).
|
|
||||||
///
|
|
||||||
/// [`applicationWillResignActive`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622950-applicationwillresignactive
|
|
||||||
/// [iOS application lifecycle]: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle
|
|
||||||
///
|
|
||||||
/// ## Web
|
|
||||||
///
|
|
||||||
/// On Web, the `Suspended` event is emitted in response to a [`pagehide`] event
|
|
||||||
/// with the property [`persisted`] being true, which means that the page is being
|
|
||||||
/// put in the [`bfcache`] (back/forward cache) - an in-memory cache that stores a
|
|
||||||
/// complete snapshot of a page (including the JavaScript heap) as the user is
|
|
||||||
/// navigating away.
|
|
||||||
///
|
|
||||||
/// [`pagehide`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/pagehide_event
|
|
||||||
/// [`persisted`]: https://developer.mozilla.org/en-US/docs/Web/API/PageTransitionEvent/persisted
|
|
||||||
/// [`bfcache`]: https://web.dev/bfcache/
|
|
||||||
/// [`Resumed`]: Self::resumed
|
|
||||||
fn suspended(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let _ = event_loop;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Emitted when the event loop is being shut down.
|
|
||||||
///
|
|
||||||
/// This is irreversible - if this method is called, it is guaranteed that the event loop
|
|
||||||
/// will exit right after.
|
|
||||||
fn exiting(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let _ = event_loop;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Emitted when the application has received a memory warning.
|
|
||||||
///
|
|
||||||
/// ## Platform-specific
|
|
||||||
///
|
|
||||||
/// ### Android
|
|
||||||
///
|
|
||||||
/// On Android, the `MemoryWarning` event is sent when [`onLowMemory`] was called. The
|
|
||||||
/// application must [release memory] or risk being killed.
|
|
||||||
///
|
|
||||||
/// [`onLowMemory`]: https://developer.android.com/reference/android/app/Application.html#onLowMemory()
|
|
||||||
/// [release memory]: https://developer.android.com/topic/performance/memory#release
|
|
||||||
///
|
|
||||||
/// ### iOS
|
|
||||||
///
|
|
||||||
/// On iOS, the `MemoryWarning` event is emitted in response to an
|
|
||||||
/// [`applicationDidReceiveMemoryWarning`] callback. The application must free as much
|
|
||||||
/// memory as possible or risk being terminated, see [how to respond to memory warnings].
|
|
||||||
///
|
|
||||||
/// [`applicationDidReceiveMemoryWarning`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623063-applicationdidreceivememorywarni
|
|
||||||
/// [how to respond to memory warnings]: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle/responding_to_memory_warnings
|
|
||||||
///
|
|
||||||
/// ### Others
|
|
||||||
///
|
|
||||||
/// - **macOS / Orbital / Wayland / Web / Windows:** Unsupported.
|
|
||||||
fn memory_warning(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
let _ = event_loop;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<A: ?Sized + ApplicationHandler<T>, T: 'static> ApplicationHandler<T> for &mut A {
|
|
||||||
#[inline]
|
|
||||||
fn new_events(&mut self, event_loop: &ActiveEventLoop, cause: StartCause) {
|
|
||||||
(**self).new_events(event_loop, cause);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).resumed(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn user_event(&mut self, event_loop: &ActiveEventLoop, event: T) {
|
|
||||||
(**self).user_event(event_loop, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
) {
|
|
||||||
(**self).window_event(event_loop, window_id, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn device_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
device_id: DeviceId,
|
|
||||||
event: DeviceEvent,
|
|
||||||
) {
|
|
||||||
(**self).device_event(event_loop, device_id, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).about_to_wait(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn suspended(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).suspended(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn exiting(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).exiting(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn memory_warning(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).memory_warning(event_loop);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<A: ?Sized + ApplicationHandler<T>, T: 'static> ApplicationHandler<T> for Box<A> {
|
|
||||||
#[inline]
|
|
||||||
fn new_events(&mut self, event_loop: &ActiveEventLoop, cause: StartCause) {
|
|
||||||
(**self).new_events(event_loop, cause);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).resumed(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn user_event(&mut self, event_loop: &ActiveEventLoop, event: T) {
|
|
||||||
(**self).user_event(event_loop, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn window_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
window_id: WindowId,
|
|
||||||
event: WindowEvent,
|
|
||||||
) {
|
|
||||||
(**self).window_event(event_loop, window_id, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn device_event(
|
|
||||||
&mut self,
|
|
||||||
event_loop: &ActiveEventLoop,
|
|
||||||
device_id: DeviceId,
|
|
||||||
event: DeviceEvent,
|
|
||||||
) {
|
|
||||||
(**self).device_event(event_loop, device_id, event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).about_to_wait(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn suspended(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).suspended(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn exiting(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).exiting(event_loop);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn memory_warning(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
(**self).memory_warning(event_loop);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
//! # Changelog and migrations
|
|
||||||
//!
|
|
||||||
//! All notable changes to this project will be documented in this module,
|
|
||||||
//! along with migration instructions for larger changes.
|
|
||||||
// Put the current entry at the top of this page, for discoverability.
|
|
||||||
// See `.cargo/config.toml` for details about `unreleased_changelogs`.
|
|
||||||
#![cfg_attr(unreleased_changelogs, doc = include_str!("unreleased.md"))]
|
|
||||||
#![cfg_attr(not(unreleased_changelogs), doc = include_str!("v0.30.md"))]
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.30.md")]
|
|
||||||
pub mod v0_30 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.29.md")]
|
|
||||||
pub mod v0_29 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.28.md")]
|
|
||||||
pub mod v0_28 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.27.md")]
|
|
||||||
pub mod v0_27 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.26.md")]
|
|
||||||
pub mod v0_26 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.25.md")]
|
|
||||||
pub mod v0_25 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.24.md")]
|
|
||||||
pub mod v0_24 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.23.md")]
|
|
||||||
pub mod v0_23 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.22.md")]
|
|
||||||
pub mod v0_22 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.21.md")]
|
|
||||||
pub mod v0_21 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.20.md")]
|
|
||||||
pub mod v0_20 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.19.md")]
|
|
||||||
pub mod v0_19 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.18.md")]
|
|
||||||
pub mod v0_18 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.17.md")]
|
|
||||||
pub mod v0_17 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.16.md")]
|
|
||||||
pub mod v0_16 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.15.md")]
|
|
||||||
pub mod v0_15 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.14.md")]
|
|
||||||
pub mod v0_14 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.13.md")]
|
|
||||||
pub mod v0_13 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.12.md")]
|
|
||||||
pub mod v0_12 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.11.md")]
|
|
||||||
pub mod v0_11 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.10.md")]
|
|
||||||
pub mod v0_10 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.9.md")]
|
|
||||||
pub mod v0_9 {}
|
|
||||||
|
|
||||||
#[doc = include_str!("v0.8.md")]
|
|
||||||
pub mod v0_8 {}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
||||||
|
|
||||||
The sections should follow the order `Added`, `Changed`, `Deprecated`,
|
|
||||||
`Removed`, and `Fixed`.
|
|
||||||
|
|
||||||
Platform specific changed should be added to the end of the section and grouped
|
|
||||||
by platform name. Common API additions should have `, implemented` at the end
|
|
||||||
for platforms where the API was initially implemented. See the following example
|
|
||||||
on how to add them:
|
|
||||||
|
|
||||||
```md
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add `Window::turbo()`, implemented on X11, Wayland, and Web.
|
|
||||||
- On X11, add `Window::some_rare_api`.
|
|
||||||
- On X11, add `Window::even_more_rare_api`.
|
|
||||||
- On Wayland, add `Window::common_api`.
|
|
||||||
- On Windows, add `Window::some_rare_api`.
|
|
||||||
```
|
|
||||||
|
|
||||||
When the change requires non-trivial amount of work for users to comply
|
|
||||||
with it, the migration guide should be added below the entry, like:
|
|
||||||
|
|
||||||
```md
|
|
||||||
- Deprecate `Window` creation outside of `EventLoop::run`
|
|
||||||
|
|
||||||
This was done to simply migration in the future. Consider the
|
|
||||||
following code:
|
|
||||||
|
|
||||||
// Code snippet.
|
|
||||||
|
|
||||||
To migrate it we should do X, Y, and then Z, for example:
|
|
||||||
|
|
||||||
// Code snippet.
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
The migration guide could reference other migration examples in the current
|
|
||||||
changelog entry.
|
|
||||||
|
|
||||||
## Unreleased
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
## 0.10.1
|
|
||||||
|
|
||||||
_Yanked_
|
|
||||||
|
|
||||||
## 0.10.0
|
|
||||||
|
|
||||||
- Add support for `Touch` for emscripten backend.
|
|
||||||
- Added support for `DroppedFile`, `HoveredFile`, and `HoveredFileCancelled` to X11 backend.
|
|
||||||
- **Breaking:** `unix::WindowExt` no longer returns pointers for things that aren't actually pointers; `get_xlib_window` now returns `Option<std::os::raw::c_ulong>` and `get_xlib_screen_id` returns `Option<std::os::raw::c_int>`. Additionally, methods that previously returned `libc::c_void` have been changed to return `std::os::raw::c_void`, which are not interchangeable types, so users wanting the former will need to explicitly cast.
|
|
||||||
- Added `set_decorations` method to `Window` to allow decorations to be toggled after the window is built. Presently only implemented on X11.
|
|
||||||
- Raised the minimum supported version of Rust to 1.20 on MacOS due to usage of associated constants in new versions of cocoa and core-graphics.
|
|
||||||
- Added `modifiers` field to `MouseInput`, `MouseWheel`, and `CursorMoved` events to track the modifiers state (`ModifiersState`).
|
|
||||||
- Fixed the emscripten backend to return the size of the canvas instead of the size of the window.
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
## 0.11.3
|
|
||||||
|
|
||||||
- Added `set_min_dimensions` and `set_max_dimensions` methods to `Window`, and implemented on Windows, X11, Wayland, and OSX.
|
|
||||||
- On X11, dropping a `Window` actually closes it now, and clicking the window's × button (or otherwise having the WM signal to close it) will result in the window closing.
|
|
||||||
- Added `WindowBuilderExt` methods for macos: `with_titlebar_transparent`,
|
|
||||||
`with_title_hidden`, `with_titlebar_buttons_hidden`,
|
|
||||||
`with_fullsize_content_view`.
|
|
||||||
- Mapped X11 numpad keycodes (arrows, Home, End, PageUp, PageDown, Insert and Delete) to corresponding virtual keycodes
|
|
||||||
|
|
||||||
## 0.11.2
|
|
||||||
|
|
||||||
- Impl `Hash`, `PartialEq`, and `Eq` for `events::ModifiersState`.
|
|
||||||
- Implement `MonitorId::get_hidpi_factor` for MacOS.
|
|
||||||
- Added method `os::macos::MonitorIdExt::get_nsscreen() -> *mut c_void` that gets a `NSScreen` object matching the monitor ID.
|
|
||||||
- Send `Awakened` event on Android when event loop is woken up.
|
|
||||||
|
|
||||||
## 0.11.1
|
|
||||||
|
|
||||||
- Fixed windows not receiving mouse events when click-dragging the mouse outside the client area of a window, on Windows platforms.
|
|
||||||
- Added method `os::android::EventsLoopExt:set_suspend_callback(Option<Box<Fn(bool) -> ()>>)` that allows glutin to register a callback when a suspend event happens
|
|
||||||
|
|
||||||
## 0.11.0
|
|
||||||
|
|
||||||
- Implement `MonitorId::get_dimensions` for Android.
|
|
||||||
- Added method `os::macos::WindowBuilderExt::with_movable_by_window_background(bool)` that allows to move a window without a titlebar - `with_decorations(false)`
|
|
||||||
- Implement `Window::set_fullscreen`, `Window::set_maximized` and `Window::set_decorations` for Wayland.
|
|
||||||
- Added `Caret` as VirtualKeyCode and support OSX ^-Key with german input.
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
## 0.12.0
|
|
||||||
|
|
||||||
- Added subclass to macos windows so they can be made resizable even with no decorations.
|
|
||||||
- Dead keys now work properly on X11, no longer resulting in a panic.
|
|
||||||
- On X11, input method creation first tries to use the value from the user's `XMODIFIERS` environment variable, so application developers should no longer need to manually call `XSetLocaleModifiers`. If that fails, fallbacks are tried, which should prevent input method initialization from ever outright failing.
|
|
||||||
- Fixed thread safety issues with input methods on X11.
|
|
||||||
- Add support for `Touch` for win32 backend.
|
|
||||||
- Fixed `Window::get_inner_size` and friends to return the size in pixels instead of points when using HIDPI displays on OSX.
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
## 0.13.1
|
|
||||||
|
|
||||||
- Ensure necessary `x11-dl` version is used.
|
|
||||||
|
|
||||||
## 0.13.0
|
|
||||||
|
|
||||||
- Implement `WindowBuilder::with_maximized`, `Window::set_fullscreen`, `Window::set_maximized` and `Window::set_decorations` for MacOS.
|
|
||||||
- Implement `WindowBuilder::with_maximized`, `Window::set_fullscreen`, `Window::set_maximized` and `Window::set_decorations` for Windows.
|
|
||||||
- On Windows, `WindowBuilder::with_fullscreen` no longer changing monitor display resolution.
|
|
||||||
- Overhauled X11 window geometry calculations. `get_position` and `set_position` are more universally accurate across different window managers, and `get_outer_size` actually works now.
|
|
||||||
- Fixed SIGSEGV/SIGILL crashes on macOS caused by stabilization of the `!` (never) type.
|
|
||||||
- Implement `WindowEvent::HiDPIFactorChanged` for macOS
|
|
||||||
- On X11, input methods now work completely out of the box, no longer requiring application developers to manually call `setlocale`. Additionally, when input methods are started, stopped, or restarted on the server end, it's correctly handled.
|
|
||||||
- Implemented `Refresh` event on Windows.
|
|
||||||
- Properly calculate the minimum and maximum window size on Windows, including window decorations.
|
|
||||||
- Map more `MouseCursor` variants to cursor icons on Windows.
|
|
||||||
- Corrected `get_position` on macOS to return outer frame position, not content area position.
|
|
||||||
- Corrected `set_position` on macOS to set outer frame position, not content area position.
|
|
||||||
- Added `get_inner_position` method to `Window`, which gets the position of the window's client area. This is implemented on all applicable platforms (all desktop platforms other than Wayland, where this isn't possible).
|
|
||||||
- **Breaking:** the `Closed` event has been replaced by `CloseRequested` and `Destroyed`. To migrate, you typically just need to replace all usages of `Closed` with `CloseRequested`; see example programs for more info. The exception is iOS, where `Closed` must be replaced by `Destroyed`.
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
## 0.14.0
|
|
||||||
|
|
||||||
- Created the `Copy`, `Paste` and `Cut` `VirtualKeyCode`s and added support for them on X11 and Wayland
|
|
||||||
- Fix `.with_decorations(false)` in macOS
|
|
||||||
- On Mac, `NSWindow` and supporting objects might be alive long after they were `closed` which resulted in apps consuming more heap then needed. Mainly it was affecting multi window applications. Not expecting any user visible change of behaviour after the fix.
|
|
||||||
- Fix regression of Window platform extensions for macOS where `NSFullSizeContentViewWindowMask` was not being correctly applied to `.fullsize_content_view`.
|
|
||||||
- Corrected `get_position` on Windows to be relative to the screen rather than to the taskbar.
|
|
||||||
- Corrected `Moved` event on Windows to use position values equivalent to those returned by `get_position`. It previously supplied client area positions instead of window positions, and would additionally interpret negative values as being very large (around `u16::MAX`).
|
|
||||||
- Implemented `Moved` event on macOS.
|
|
||||||
- On X11, the `Moved` event correctly use window positions rather than client area positions. Additionally, a stray `Moved` that unconditionally accompanied `Resized` with the client area position relative to the parent has been eliminated; `Moved` is still received alongside `Resized`, but now only once and always correctly.
|
|
||||||
- On Windows, implemented all variants of `DeviceEvent` other than `Text`. Mouse `DeviceEvent`s are now received even if the window isn't in the foreground.
|
|
||||||
- `DeviceId` on Windows is no longer a unit struct, and now contains a `u32`. For `WindowEvent`s, this will always be 0, but on `DeviceEvent`s it will be the handle to that device. `DeviceIdExt::get_persistent_identifier` can be used to acquire a unique identifier for that device that persists across replugs/reboots/etc.
|
|
||||||
- Corrected `run_forever` on X11 to stop discarding `Awakened` events.
|
|
||||||
- Various safety and correctness improvements to the X11 backend internals.
|
|
||||||
- Fixed memory leak on X11 every time the mouse entered the window.
|
|
||||||
- On X11, drag and drop now works reliably in release mode.
|
|
||||||
- Added `WindowBuilderExt::with_resize_increments` and `WindowBuilderExt::with_base_size` to X11, allowing for more optional hints to be set.
|
|
||||||
- Rework of the wayland backend, migrating it to use [Smithay's Client Toolkit](https://github.com/Smithay/client-toolkit).
|
|
||||||
- Added `WindowBuilder::with_window_icon` and `Window::set_window_icon`, finally making it possible to set the window icon on Windows and X11. The `icon_loading` feature can be enabled to allow for icons to be easily loaded; see example program `window_icon.rs` for usage.
|
|
||||||
- Windows additionally has `WindowBuilderExt::with_taskbar_icon` and `WindowExt::set_taskbar_icon`.
|
|
||||||
- On Windows, fix panic when trying to call `set_fullscreen(None)` on a window that has not been fullscreened prior.
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
## 0.15.1
|
|
||||||
|
|
||||||
- On X11, the `Moved` event is no longer sent when the window is resized without changing position.
|
|
||||||
- `MouseCursor` and `CursorState` now implement `Default`.
|
|
||||||
- `WindowBuilder::with_resizable` implemented for Windows, X11, Wayland, and macOS.
|
|
||||||
- `Window::set_resizable` implemented for Windows, X11, Wayland, and macOS.
|
|
||||||
- On X11, if the monitor's width or height in millimeters is reported as 0, the DPI is now 1.0 instead of +inf.
|
|
||||||
- On X11, the environment variable `WINIT_HIDPI_FACTOR` has been added for overriding DPI factor.
|
|
||||||
- On X11, enabling transparency no longer causes the window contents to flicker when resizing.
|
|
||||||
- On X11, `with_override_redirect` now actually enables override redirect.
|
|
||||||
- macOS now generates `VirtualKeyCode::LAlt` and `VirtualKeyCode::RAlt` instead of `None` for both.
|
|
||||||
- On macOS, `VirtualKeyCode::RWin` and `VirtualKeyCode::LWin` are no longer switched.
|
|
||||||
- On macOS, windows without decorations can once again be resized.
|
|
||||||
- Fixed race conditions when creating an `EventsLoop` on X11, most commonly manifesting as `"[xcb] Unknown sequence number while processing queue"`.
|
|
||||||
- On macOS, `CursorMoved` and `MouseInput` events are only generated if they occurs within the window's client area.
|
|
||||||
- On macOS, resizing the window no longer generates a spurious `MouseInput` event.
|
|
||||||
|
|
||||||
## 0.15.0
|
|
||||||
|
|
||||||
- `Icon::to_cardinals` is no longer public, since it was never supposed to be.
|
|
||||||
- Wayland: improve diagnostics if initialization fails
|
|
||||||
- Fix some system event key doesn't work when focused, do not block keyevent forward to system on macOS
|
|
||||||
- On X11, the scroll wheel position is now correctly reset on i3 and other WMs that have the same quirk.
|
|
||||||
- On X11, `Window::get_current_monitor` now reliably returns the correct monitor.
|
|
||||||
- On X11, `Window::hidpi_factor` returns values from XRandR rather than the inaccurate values previously queried from the core protocol.
|
|
||||||
- On X11, the primary monitor is detected correctly even when using versions of XRandR less than 1.5.
|
|
||||||
- `MonitorId` now implements `Debug`.
|
|
||||||
- Fixed bug on macOS where using `with_decorations(false)` would cause `set_decorations(true)` to produce a transparent titlebar with no title.
|
|
||||||
- Implemented `MonitorId::get_position` on macOS.
|
|
||||||
- On macOS, `Window::get_current_monitor` now returns accurate values.
|
|
||||||
- Added `WindowBuilderExt::with_resize_increments` to macOS.
|
|
||||||
- **Breaking:** On X11, `WindowBuilderExt::with_resize_increments` and `WindowBuilderExt::with_base_size` now take `u32` values rather than `i32`.
|
|
||||||
- macOS keyboard handling has been overhauled, allowing for the use of dead keys, IME, etc. Right modifier keys are also no longer reported as being left.
|
|
||||||
- Added the `Window::set_ime_spot(x: i32, y: i32)` method, which is implemented on X11 and macOS.
|
|
||||||
- **Breaking**: `os::unix::WindowExt::send_xim_spot(x: i16, y: i16)` no longer exists. Switch to the new `Window::set_ime_spot(x: i32, y: i32)`, which has equivalent functionality.
|
|
||||||
- Fixed detection of `Pause` and `Scroll` keys on Windows.
|
|
||||||
- On Windows, alt-tabbing while the cursor is grabbed no longer makes it impossible to re-grab the cursor.
|
|
||||||
- On Windows, using `CursorState::Hide` when the cursor is grabbed now ungrabs the cursor first.
|
|
||||||
- Implemented `MouseCursor::NoneCursor` on Windows.
|
|
||||||
- Added `WindowBuilder::with_always_on_top` and `Window::set_always_on_top`. Implemented on Windows, macOS, and X11.
|
|
||||||
- On X11, `WindowBuilderExt` now has `with_class`, `with_override_redirect`, and `with_x11_window_type` to allow for more control over window creation. `WindowExt` additionally has `set_urgent`.
|
|
||||||
- More hints are set by default on X11, including `_NET_WM_PID` and `WM_CLIENT_MACHINE`. Note that prior to this, the `WM_CLASS` hint was automatically set to whatever value was passed to `with_title`. It's now set to the executable name to better conform to expectations and the specification; if this is undesirable, you must explicitly use `WindowBuilderExt::with_class`.
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
## 0.16.2
|
|
||||||
|
|
||||||
- On Windows, non-resizable windows now have the maximization button disabled. This is consistent with behavior on macOS and popular X11 WMs.
|
|
||||||
- Corrected incorrect `unreachable!` usage when guessing the DPI factor with no detected monitors.
|
|
||||||
|
|
||||||
## 0.16.1
|
|
||||||
|
|
||||||
- Added logging through `log`. Logging will become more extensive over time.
|
|
||||||
- On X11 and Windows, the window's DPI factor is guessed before creating the window. This _greatly_ cuts back on unsightly auto-resizing that would occur immediately after window creation.
|
|
||||||
- Fixed X11 backend compilation for environments where `c_char` is unsigned.
|
|
||||||
|
|
||||||
## 0.16.0
|
|
||||||
|
|
||||||
- Windows additionally has `WindowBuilderExt::with_no_redirection_bitmap`.
|
|
||||||
- **Breaking:** Removed `VirtualKeyCode::LMenu` and `VirtualKeyCode::RMenu`; Windows now generates `VirtualKeyCode::LAlt` and `VirtualKeyCode::RAlt` instead.
|
|
||||||
- On X11, exiting fullscreen no longer leaves the window in the monitor's top left corner.
|
|
||||||
- **Breaking:** `Window::hidpi_factor` has been renamed to `Window::get_hidpi_factor` for better consistency. `WindowEvent::HiDPIFactorChanged` has been renamed to `WindowEvent::HiDpiFactorChanged`. DPI factors are always represented as `f64` instead of `f32` now.
|
|
||||||
- The Windows backend is now DPI aware. `WindowEvent::HiDpiFactorChanged` is implemented, and `MonitorId::get_hidpi_factor` and `Window::hidpi_factor` return accurate values.
|
|
||||||
- Implemented `WindowEvent::HiDpiFactorChanged` on X11.
|
|
||||||
- On macOS, `Window::set_cursor_position` is now relative to the client area.
|
|
||||||
- On macOS, setting the maximum and minimum dimensions now applies to the client area dimensions rather than to the window dimensions.
|
|
||||||
- On iOS, `MonitorId::get_dimensions` has been implemented and both `MonitorId::get_hidpi_factor` and `Window::get_hidpi_factor` return accurate values.
|
|
||||||
- On Emscripten, `MonitorId::get_hidpi_factor` now returns the same value as `Window::get_hidpi_factor` (it previously would always return 1.0).
|
|
||||||
- **Breaking:** The entire API for sizes, positions, etc. has changed. In the majority of cases, winit produces and consumes positions and sizes as `LogicalPosition` and `LogicalSize`, respectively. The notable exception is `MonitorId` methods, which deal in `PhysicalPosition` and `PhysicalSize`. See the documentation for specifics and explanations of the types. Additionally, winit automatically conserves logical size when the DPI factor changes.
|
|
||||||
- **Breaking:** All deprecated methods have been removed. For `Window::platform_display` and `Window::platform_window`, switch to the appropriate platform-specific `WindowExt` methods. For `Window::get_inner_size_points` and `Window::get_inner_size_pixels`, use the `LogicalSize` returned by `Window::get_inner_size` and convert as needed.
|
|
||||||
- HiDPI support for Wayland.
|
|
||||||
- `EventsLoop::get_available_monitors` and `EventsLoop::get_primary_monitor` now have identical counterparts on `Window`, so this information can be acquired without an `EventsLoop` borrow.
|
|
||||||
- `AvailableMonitorsIter` now implements `Debug`.
|
|
||||||
- Fixed quirk on macOS where certain keys would generate characters at twice the normal rate when held down.
|
|
||||||
- On X11, all event loops now share the same `XConnection`.
|
|
||||||
- **Breaking:** `Window::set_cursor_state` and `CursorState` enum removed in favor of the more composable `Window::grab_cursor` and `Window::hide_cursor`. As a result, grabbing the cursor no longer automatically hides it; you must call both methods to retain the old behavior on Windows and macOS. `Cursor::NoneCursor` has been removed, as it's no longer useful.
|
|
||||||
- **Breaking:** `Window::set_cursor_position` now returns `Result<(), String>`, thus allowing for `Box<Error>` conversion via `?`.
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
## 0.17.2
|
|
||||||
|
|
||||||
- On macOS, fix `<C-Tab>` so applications receive the event.
|
|
||||||
- On macOS, fix `<Cmd-{key}>` so applications receive the event.
|
|
||||||
- On Wayland, key press events will now be repeated.
|
|
||||||
|
|
||||||
## 0.17.1
|
|
||||||
|
|
||||||
- On X11, prevent a compilation failure in release mode for versions of Rust greater than or equal to 1.30.
|
|
||||||
- Fixed deadlock that broke fullscreen mode on Windows.
|
|
||||||
|
|
||||||
## 0.17.0
|
|
||||||
|
|
||||||
- Cocoa and core-graphics updates.
|
|
||||||
- Fixed thread-safety issues in several `Window` functions on Windows.
|
|
||||||
- On MacOS, the key state for modifiers key events is now properly set.
|
|
||||||
- On iOS, the view is now set correctly. This makes it possible to render things (instead of being stuck on a black screen), and touch events work again.
|
|
||||||
- Added NetBSD support.
|
|
||||||
- **Breaking:** On iOS, `UIView` is now the default root view. `WindowBuilderExt::with_root_view_class` can be used to set the root view objective-c class to `GLKView` (OpenGLES) or `MTKView` (Metal/MoltenVK).
|
|
||||||
- On iOS, the `UIApplication` is not started until `Window::new` is called.
|
|
||||||
- Fixed thread unsafety with cursor hiding on macOS.
|
|
||||||
- On iOS, fixed the size of the `JmpBuf` type used for `setjmp`/`longjmp` calls. Previously this was a buffer overflow on most architectures.
|
|
||||||
- On Windows, use cached window DPI instead of repeatedly querying the system. This fixes sporadic crashes on Windows 7.
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
## 0.18.1
|
|
||||||
|
|
||||||
- On macOS, fix `Yen` (JIS) so applications receive the event.
|
|
||||||
- On X11 with a tiling WM, fixed high CPU usage when moving windows across monitors.
|
|
||||||
- On X11, fixed panic caused by dropping the window before running the event loop.
|
|
||||||
- on macOS, added `WindowExt::set_simple_fullscreen` which does not require a separate space
|
|
||||||
- Introduce `WindowBuilderExt::with_app_id` to allow setting the application ID on Wayland.
|
|
||||||
- On Windows, catch panics in event loop child thread and forward them to the parent thread. This prevents an invocation of undefined behavior due to unwinding into foreign code.
|
|
||||||
- On Windows, fix issue where resizing or moving window combined with grabbing the cursor would freeze program.
|
|
||||||
- On Windows, fix issue where resizing or moving window would eat `Awakened` events.
|
|
||||||
- On Windows, exiting fullscreen after entering fullscreen with disabled decorations no longer shrinks window.
|
|
||||||
- On X11, fixed a segfault when using virtual monitors with XRandR.
|
|
||||||
- Derive `Ord` and `PartialOrd` for `VirtualKeyCode` enum.
|
|
||||||
- On Windows, fix issue where hovering or dropping a non file item would create a panic.
|
|
||||||
- On Wayland, fix resizing and DPI calculation when a `wl_output` is removed without sending a `leave` event to the `wl_surface`, such as disconnecting a monitor from a laptop.
|
|
||||||
- On Wayland, DPI calculation is handled by smithay-client-toolkit.
|
|
||||||
- On X11, `WindowBuilder::with_min_dimensions` and `WindowBuilder::with_max_dimensions` now correctly account for DPI.
|
|
||||||
- Added support for generating dummy `DeviceId`s and `WindowId`s to better support unit testing.
|
|
||||||
- On macOS, fixed unsoundness in drag-and-drop that could result in drops being rejected.
|
|
||||||
- On macOS, implemented `WindowEvent::Refresh`.
|
|
||||||
- On macOS, all `MouseCursor` variants are now implemented and the cursor will no longer reset after unfocusing.
|
|
||||||
- Removed minimum supported Rust version guarantee.
|
|
||||||
|
|
||||||
## 0.18.0
|
|
||||||
|
|
||||||
- **Breaking:** `image` crate upgraded to 0.20. This is exposed as part of the `icon_loading` API.
|
|
||||||
- On Wayland, pointer events will now provide the current modifiers state.
|
|
||||||
- On Wayland, titles will now be displayed in the window header decoration.
|
|
||||||
- On Wayland, key repetition is now ended when keyboard loses focus.
|
|
||||||
- On Wayland, windows will now use more stylish and modern client side decorations.
|
|
||||||
- On Wayland, windows will use server-side decorations when available.
|
|
||||||
- **Breaking:** Added support for F16-F24 keys (variants were added to the `VirtualKeyCode` enum).
|
|
||||||
- Fixed graphical glitches when resizing on Wayland.
|
|
||||||
- On Windows, fix freezes when performing certain actions after a window resize has been triggered. Reintroduces some visual artifacts when resizing.
|
|
||||||
- Updated window manager hints under X11 to v1.5 of [Extended Window Manager Hints](https://specifications.freedesktop.org/wm-spec/wm-spec-1.5.html#idm140200472629520).
|
|
||||||
- Added `WindowBuilderExt::with_gtk_theme_variant` to X11-specific `WindowBuilder` functions.
|
|
||||||
- Fixed UTF8 handling bug in X11 `set_title` function.
|
|
||||||
- On Windows, `Window::set_cursor` now applies immediately instead of requiring specific events to occur first.
|
|
||||||
- On Windows, the `HoveredFile` and `HoveredFileCancelled` events are now implemented.
|
|
||||||
- On Windows, fix `Window::set_maximized`.
|
|
||||||
- On Windows 10, fix transparency (#260).
|
|
||||||
- On macOS, fix modifiers during key repeat.
|
|
||||||
- Implemented the `Debug` trait for `Window`, `EventsLoop`, `EventsLoopProxy` and `WindowBuilder`.
|
|
||||||
- On X11, now a `Resized` event will always be generated after a DPI change to ensure the window's logical size is consistent with the new DPI.
|
|
||||||
- Added further clarifications to the DPI docs.
|
|
||||||
- On Linux, if neither X11 nor Wayland manage to initialize, the corresponding panic now consists of a single line only.
|
|
||||||
- Add optional `serde` feature with implementations of `Serialize`/`Deserialize` for DPI types and various event types.
|
|
||||||
- Add `PartialEq`, `Eq`, and `Hash` implementations on public types that could have them but were missing them.
|
|
||||||
- On X11, drag-and-drop receiving an unsupported drop type can no longer cause the WM to freeze.
|
|
||||||
- Fix issue whereby the OpenGL context would not appear at startup on macOS Mojave (#1069).
|
|
||||||
- **Breaking:** Removed `From<NSApplicationActivationPolicy>` impl from `ActivationPolicy` on macOS.
|
|
||||||
- On macOS, the application can request the user's attention with `WindowExt::request_user_attention`.
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
## 0.19.1
|
|
||||||
|
|
||||||
- On Wayland, added a `get_wayland_display` function to `EventsLoopExt`.
|
|
||||||
- On Windows, fix `CursorMoved(0, 0)` getting dispatched on window focus.
|
|
||||||
- On macOS, fix command key event left and right reverse.
|
|
||||||
- On FreeBSD, NetBSD, and OpenBSD, fix build of X11 backend.
|
|
||||||
- On Linux, the numpad's add, subtract and divide keys are now mapped to the `Add`, `Subtract` and `Divide` virtual key codes
|
|
||||||
- On macOS, the numpad's subtract key has been added to the `Subtract` mapping
|
|
||||||
- On Wayland, the numpad's home, end, page up and page down keys are now mapped to the `Home`, `End`, `PageUp` and `PageDown` virtual key codes
|
|
||||||
- On Windows, fix icon not showing up in corner of window.
|
|
||||||
- On X11, change DPI scaling factor behavior. First, winit tries to read it from "Xft.dpi" XResource, and uses DPI calculation from xrandr dimensions as fallback behavior.
|
|
||||||
|
|
||||||
## 0.19.0
|
|
||||||
|
|
||||||
- On X11, we will use the faster `XRRGetScreenResourcesCurrent` function instead of `XRRGetScreenResources` when available.
|
|
||||||
- On macOS, fix keycodes being incorrect when using a non-US keyboard layout.
|
|
||||||
- On Wayland, fix `with_title()` not setting the windows title
|
|
||||||
- On Wayland, add `set_wayland_theme()` to control client decoration color theme
|
|
||||||
- Added serde serialization to `os::unix::XWindowType`.
|
|
||||||
- **Breaking:** Remove the `icon_loading` feature and the associated `image` dependency.
|
|
||||||
- On X11, make event loop thread safe by replacing XNextEvent with select(2) and XCheckIfEvent
|
|
||||||
- On Windows, fix malformed function pointer typecast that could invoke undefined behavior.
|
|
||||||
- Refactored Windows state/flag-setting code.
|
|
||||||
- On Windows, hiding the cursor no longer hides the cursor for all Winit windows - just the one `hide_cursor` was called on.
|
|
||||||
- On Windows, cursor grabs used to get perpetually canceled when the grabbing window lost focus. Now, cursor grabs automatically get re-initialized when the window regains focus and the mouse moves over the client area.
|
|
||||||
- On Windows, only vertical mouse wheel events were handled. Now, horizontal mouse wheel events are also handled.
|
|
||||||
- On Windows, ignore the AltGr key when populating the `ModifiersState` type.
|
|
||||||
@@ -1,200 +0,0 @@
|
|||||||
## 0.20.0
|
|
||||||
|
|
||||||
- On X11, fix `ModifiersChanged` emitting incorrect modifier change events
|
|
||||||
- **Breaking**: Overhaul how Winit handles DPI:
|
|
||||||
- Window functions and events now return `PhysicalSize` instead of `LogicalSize`.
|
|
||||||
- Functions that take `Size` or `Position` types can now take either `Logical` or `Physical` types.
|
|
||||||
- `hidpi_factor` has been renamed to `scale_factor`.
|
|
||||||
- `HiDpiFactorChanged` has been renamed to `ScaleFactorChanged`, and lets you control how the OS
|
|
||||||
resizes the window in response to the change.
|
|
||||||
- On X11, deprecate `WINIT_HIDPI_FACTOR` environment variable in favor of `WINIT_X11_SCALE_FACTOR`.
|
|
||||||
- `Size` and `Position` types are now generic over their exact pixel type.
|
|
||||||
|
|
||||||
## 0.20.0-alpha6
|
|
||||||
|
|
||||||
- On macOS, fix `set_cursor_visible` hides cursor outside of window.
|
|
||||||
- On macOS, fix `CursorEntered` and `CursorLeft` events fired at old window size.
|
|
||||||
- On macOS, fix error when `set_fullscreen` is called during fullscreen transition.
|
|
||||||
- On all platforms except mobile and WASM, implement `Window::set_minimized`.
|
|
||||||
- On X11, fix `CursorEntered` event being generated for non-winit windows.
|
|
||||||
- On macOS, fix crash when starting maximized without decorations.
|
|
||||||
- On macOS, fix application not terminating on `run_return`.
|
|
||||||
- On Wayland, fix cursor icon updates on window borders when using CSD.
|
|
||||||
- On Wayland, under mutter(GNOME Wayland), fix CSD being behind the status bar, when starting window in maximized mode.
|
|
||||||
- On Windows, theme the title bar according to whether the system theme is "Light" or "Dark".
|
|
||||||
- Added `WindowEvent::ThemeChanged` variant to handle changes to the system theme. Currently only implemented on Windows.
|
|
||||||
- **Breaking**: Changes to the `RedrawRequested` event (#1041):
|
|
||||||
- `RedrawRequested` has been moved from `WindowEvent` to `Event`.
|
|
||||||
- `EventsCleared` has been renamed to `MainEventsCleared`.
|
|
||||||
- `RedrawRequested` is now issued only after `MainEventsCleared`.
|
|
||||||
- `RedrawEventsCleared` is issued after each set of `RedrawRequested` events.
|
|
||||||
- Implement synthetic window focus key events on Windows.
|
|
||||||
- **Breaking**: Change `ModifiersState` to a `bitflags` struct.
|
|
||||||
- On Windows, implement `VirtualKeyCode` translation for `LWin` and `RWin`.
|
|
||||||
- On Windows, fix closing the last opened window causing `DeviceEvent`s to stop getting emitted.
|
|
||||||
- On Windows, fix `Window::set_visible` not setting internal flags correctly. This resulted in some weird behavior.
|
|
||||||
- Add `DeviceEvent::ModifiersChanged`.
|
|
||||||
- Deprecate `modifiers` fields in other events in favor of `ModifiersChanged`.
|
|
||||||
- On X11, `WINIT_HIDPI_FACTOR` now dominates `Xft.dpi` when picking DPI factor for output.
|
|
||||||
- On X11, add special value `randr` for `WINIT_HIDPI_FACTOR` to make winit use self computed DPI factor instead of the one from `Xft.dpi`.
|
|
||||||
|
|
||||||
## 0.20.0-alpha5
|
|
||||||
|
|
||||||
- On macOS, fix application termination on `ControlFlow::Exit`
|
|
||||||
- On Windows, fix missing `ReceivedCharacter` events when Alt is held.
|
|
||||||
- On macOS, stop emitting private corporate characters in `ReceivedCharacter` events.
|
|
||||||
- On X11, fix misreporting DPI factor at startup.
|
|
||||||
- On X11, fix events not being reported when using `run_return`.
|
|
||||||
- On X11, fix key modifiers being incorrectly reported.
|
|
||||||
- On X11, fix window creation hanging when another window is fullscreen.
|
|
||||||
- On Windows, fix focusing unfocused windows when switching from fullscreen to windowed.
|
|
||||||
- On X11, fix reporting incorrect DPI factor when waking from suspend.
|
|
||||||
- Change `EventLoopClosed` to contain the original event.
|
|
||||||
- **Breaking**: Add `is_synthetic` field to `WindowEvent` variant `KeyboardInput`,
|
|
||||||
indicating that the event is generated by winit.
|
|
||||||
- On X11, generate synthetic key events for keys held when a window gains or loses focus.
|
|
||||||
- On X11, issue a `CursorMoved` event when a `Touch` event occurs,
|
|
||||||
as X11 implicitly moves the cursor for such events.
|
|
||||||
|
|
||||||
## 0.20.0-alpha4
|
|
||||||
|
|
||||||
- Add web support via the 'stdweb' or 'web-sys' features
|
|
||||||
- On Windows, implemented function to get HINSTANCE
|
|
||||||
- On macOS, implement `run_return`.
|
|
||||||
- On iOS, fix inverted parameter in `set_prefers_home_indicator_hidden`.
|
|
||||||
- On X11, performance is improved when rapidly calling `Window::set_cursor_icon`.
|
|
||||||
- On iOS, fix improper `msg_send` usage that was UB and/or would break if `!` is stabilized.
|
|
||||||
- On Windows, unset `maximized` when manually changing the window's position or size.
|
|
||||||
- On Windows, add touch pressure information for touch events.
|
|
||||||
- On macOS, differentiate between `CursorIcon::Grab` and `CursorIcon::Grabbing`.
|
|
||||||
- On Wayland, fix event processing sometimes stalling when using OpenGL with vsync.
|
|
||||||
- Officially remove the Emscripten backend.
|
|
||||||
- On Windows, fix handling of surrogate pairs when dispatching `ReceivedCharacter`.
|
|
||||||
- On macOS 10.15, fix freeze upon exiting exclusive fullscreen mode.
|
|
||||||
- On iOS, fix panic upon closing the app.
|
|
||||||
- On X11, allow setting multiple `XWindowType`s.
|
|
||||||
- On iOS, fix null window on initial `HiDpiFactorChanged` event.
|
|
||||||
- On Windows, fix fullscreen window shrinking upon getting restored to a normal window.
|
|
||||||
- On macOS, fix events not being emitted during modal loops, such as when windows are being resized
|
|
||||||
by the user.
|
|
||||||
- On Windows, fix hovering the mouse over the active window creating an endless stream of CursorMoved events.
|
|
||||||
- Always dispatch a `RedrawRequested` event after creating a new window.
|
|
||||||
- On X11, return dummy monitor data to avoid panicking when no monitors exist.
|
|
||||||
- On X11, prevent stealing input focus when creating a new window.
|
|
||||||
Only steal input focus when entering fullscreen mode.
|
|
||||||
- On Wayland, fixed DeviceEvents for relative mouse movement is not always produced
|
|
||||||
- On Wayland, add support for set_cursor_visible and set_cursor_grab.
|
|
||||||
- On Wayland, fixed DeviceEvents for relative mouse movement is not always produced.
|
|
||||||
- Removed `derivative` crate dependency.
|
|
||||||
- On Wayland, add support for set_cursor_icon.
|
|
||||||
- Use `impl Iterator<Item = MonitorHandle>` instead of `AvailableMonitorsIter` consistently.
|
|
||||||
- On macOS, fix fullscreen state being updated after entering fullscreen instead of before,
|
|
||||||
resulting in `Window::fullscreen` returning the old state in `Resized` events instead of
|
|
||||||
reflecting the new fullscreen state
|
|
||||||
- On X11, fix use-after-free during window creation
|
|
||||||
- On Windows, disable monitor change keyboard shortcut while in exclusive fullscreen.
|
|
||||||
- On Windows, ensure that changing a borderless fullscreen window's monitor via keyboard shortcuts keeps the window fullscreen on the new monitor.
|
|
||||||
- Prevent `EventLoop::new` and `EventLoop::with_user_event` from getting called outside the main thread.
|
|
||||||
- This is because some platforms cannot run the event loop outside the main thread. Preventing this
|
|
||||||
reduces the potential for cross-platform compatibility gotchyas.
|
|
||||||
- On Windows and Linux X11/Wayland, add platform-specific functions for creating an `EventLoop` outside the main thread.
|
|
||||||
- On Wayland, drop resize events identical to the current window size.
|
|
||||||
- On Windows, fix window rectangle not getting set correctly on high-DPI systems.
|
|
||||||
|
|
||||||
## 0.20.0-alpha3
|
|
||||||
|
|
||||||
- On macOS, drop the run closure on exit.
|
|
||||||
- On Windows, location of `WindowEvent::Touch` are window client coordinates instead of screen coordinates.
|
|
||||||
- On X11, fix delayed events after window redraw.
|
|
||||||
- On macOS, add `WindowBuilderExt::with_disallow_hidpi` to have the option to turn off best resolution openGL surface.
|
|
||||||
- On Windows, screen saver won't start if the window is in fullscreen mode.
|
|
||||||
- Change all occurrences of the `new_user_event` method to `with_user_event`.
|
|
||||||
- On macOS, the dock and the menu bar are now hidden in fullscreen mode.
|
|
||||||
- `Window::set_fullscreen` now takes `Option<Fullscreen>` where `Fullscreen`
|
|
||||||
consists of `Fullscreen::Exclusive(VideoMode)` and
|
|
||||||
`Fullscreen::Borderless(MonitorHandle)` variants.
|
|
||||||
- Adds support for exclusive fullscreen mode.
|
|
||||||
- On iOS, add support for hiding the home indicator.
|
|
||||||
- On iOS, add support for deferring system gestures.
|
|
||||||
- On iOS, fix a crash that occurred while acquiring a monitor's name.
|
|
||||||
- On iOS, fix armv7-apple-ios compile target.
|
|
||||||
- Removed the `T: Clone` requirement from the `Clone` impl of `EventLoopProxy<T>`.
|
|
||||||
- On iOS, disable overscan compensation for external displays (removes black
|
|
||||||
bars surrounding the image).
|
|
||||||
- On Linux, the functions `is_wayland`, `is_x11`, `xlib_xconnection` and `wayland_display` have been moved to a new `EventLoopWindowTargetExtUnix` trait.
|
|
||||||
- On iOS, add `set_prefers_status_bar_hidden` extension function instead of
|
|
||||||
hijacking `set_decorations` for this purpose.
|
|
||||||
- On macOS and iOS, corrected the auto trait impls of `EventLoopProxy`.
|
|
||||||
- On iOS, add touch pressure information for touch events.
|
|
||||||
- Implement `raw_window_handle::HasRawWindowHandle` for `Window` type on all supported platforms.
|
|
||||||
- On macOS, fix the signature of `-[NSView drawRect:]`.
|
|
||||||
- On iOS, fix the behavior of `ControlFlow::Poll`. It wasn't polling if that was the only mode ever used by the application.
|
|
||||||
- On iOS, fix DPI sent out by views on creation was `0.0` - now it gives a reasonable number.
|
|
||||||
- On iOS, RedrawRequested now works for gl/metal backed views.
|
|
||||||
- On iOS, RedrawRequested is generally ordered after EventsCleared.
|
|
||||||
|
|
||||||
## 0.20.0-alpha2
|
|
||||||
|
|
||||||
- On X11, non-resizable windows now have maximize explicitly disabled.
|
|
||||||
- On Windows, support paths longer than MAX_PATH (260 characters) in `WindowEvent::DroppedFile`
|
|
||||||
and `WindowEvent::HoveredFile`.
|
|
||||||
- On Mac, implement `DeviceEvent::Button`.
|
|
||||||
- Change `Event::Suspended(true / false)` to `Event::Suspended` and `Event::Resumed`.
|
|
||||||
- On X11, fix sanity check which checks that a monitor's reported width and height (in millimeters) are non-zero when calculating the DPI factor.
|
|
||||||
- Revert the use of invisible surfaces in Wayland, which introduced graphical glitches with OpenGL (#835)
|
|
||||||
- On X11, implement `_NET_WM_PING` to allow desktop environment to kill unresponsive programs.
|
|
||||||
- On Windows, when a window is initially invisible, it won't take focus from the existing visible windows.
|
|
||||||
- On Windows, fix multiple calls to `request_redraw` during `EventsCleared` sending multiple `RedrawRequested events.`
|
|
||||||
- On Windows, fix edge case where `RedrawRequested` could be dispatched before input events in event loop iteration.
|
|
||||||
- On Windows, fix timing issue that could cause events to be improperly dispatched after `RedrawRequested` but before `EventsCleared`.
|
|
||||||
- On macOS, drop unused Metal dependency.
|
|
||||||
- On Windows, fix the trail effect happening on transparent decorated windows. Borderless (or un-decorated) windows were not affected.
|
|
||||||
- On Windows, fix `with_maximized` not properly setting window size to entire window.
|
|
||||||
- On macOS, change `WindowExtMacOS::request_user_attention()` to take an `enum` instead of a `bool`.
|
|
||||||
|
|
||||||
## 0.20.0-alpha1
|
|
||||||
|
|
||||||
- Changes below are considered **breaking**.
|
|
||||||
- Change all occurrences of `EventsLoop` to `EventLoop`.
|
|
||||||
- Previously flat API is now exposed through `event`, `event_loop`, `monitor`, and `window` modules.
|
|
||||||
- `os` module changes:
|
|
||||||
- Renamed to `platform`.
|
|
||||||
- All traits now have platform-specific suffixes.
|
|
||||||
- Exposes new `desktop` module on Windows, Mac, and Linux.
|
|
||||||
- Changes to event loop types:
|
|
||||||
- `EventLoopProxy::wakeup` has been removed in favor of `send_event`.
|
|
||||||
- **Major:** New `run` method drives winit event loop.
|
|
||||||
- Returns `!` to ensure API behaves identically across all supported platforms.
|
|
||||||
- This allows `emscripten` implementation to work without lying about the API.
|
|
||||||
- `ControlFlow`'s variants have been replaced with `Wait`, `WaitUntil(Instant)`, `Poll`, and `Exit`.
|
|
||||||
- Is read after `EventsCleared` is processed.
|
|
||||||
- `Wait` waits until new events are available.
|
|
||||||
- `WaitUntil` waits until either new events are available or the provided time has been reached.
|
|
||||||
- `Poll` instantly resumes the event loop.
|
|
||||||
- `Exit` aborts the event loop.
|
|
||||||
- Takes a closure that implements `'static + FnMut(Event<T>, &EventLoop<T>, &mut ControlFlow)`.
|
|
||||||
- `&EventLoop<T>` is provided to allow new `Window`s to be created.
|
|
||||||
- **Major:** `platform::desktop` module exposes `EventLoopExtDesktop` trait with `run_return` method.
|
|
||||||
- Behaves identically to `run`, but returns control flow to the calling context and can take non-`'static` closures.
|
|
||||||
- `EventLoop`'s `poll_events` and `run_forever` methods have been removed in favor of `run` and `run_return`.
|
|
||||||
- Changes to events:
|
|
||||||
- Remove `Event::Awakened` in favor of `Event::UserEvent(T)`.
|
|
||||||
- Can be sent with `EventLoopProxy::send_event`.
|
|
||||||
- Rename `WindowEvent::Refresh` to `WindowEvent::RedrawRequested`.
|
|
||||||
- `RedrawRequested` can be sent by the user with the `Window::request_redraw` method.
|
|
||||||
- `EventLoop`, `EventLoopProxy`, and `Event` are now generic over `T`, for use in `UserEvent`.
|
|
||||||
- **Major:** Add `NewEvents(StartCause)`, `EventsCleared`, and `LoopDestroyed` variants to `Event`.
|
|
||||||
- `NewEvents` is emitted when new events are ready to be processed by event loop.
|
|
||||||
- `StartCause` describes why new events are available, with `ResumeTimeReached`, `Poll`, `WaitCancelled`, and `Init` (sent once at start of loop).
|
|
||||||
- `EventsCleared` is emitted when all available events have been processed.
|
|
||||||
- Can be used to perform logic that depends on all events being processed (e.g. an iteration of a game loop).
|
|
||||||
- `LoopDestroyed` is emitted when the `run` or `run_return` method is about to exit.
|
|
||||||
- Rename `MonitorId` to `MonitorHandle`.
|
|
||||||
- Removed `serde` implementations from `ControlFlow`.
|
|
||||||
- Rename several functions to improve both internal consistency and compliance with Rust API guidelines.
|
|
||||||
- Remove `WindowBuilder::multitouch` field, since it was only implemented on a few platforms. Multitouch is always enabled now.
|
|
||||||
- **Breaking:** On macOS, change `ns` identifiers to use snake_case for consistency with iOS's `ui` identifiers.
|
|
||||||
- Add `MonitorHandle::video_modes` method for retrieving supported video modes for the given monitor.
|
|
||||||
- On Wayland, the window now exists even if nothing has been drawn.
|
|
||||||
- On Windows, fix initial dimensions of a fullscreen window.
|
|
||||||
- On Windows, Fix transparent borderless windows rendering wrong.
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
## 0.21.0
|
|
||||||
|
|
||||||
- On Windows, fixed "error: linking with `link.exe` failed: exit code: 1120" error on older versions of windows.
|
|
||||||
- On macOS, fix set_minimized(true) works only with decorations.
|
|
||||||
- On macOS, add `hide_application` to `EventLoopWindowTarget` via a new `EventLoopWindowTargetExtMacOS` trait. `hide_application` will hide the entire application by calling `-[NSApplication hide: nil]`.
|
|
||||||
- On macOS, fix not sending ReceivedCharacter event for specific keys combinations.
|
|
||||||
- On macOS, fix `CursorMoved` event reporting the cursor position using logical coordinates.
|
|
||||||
- On macOS, fix issue where unbundled applications would sometimes open without being focused.
|
|
||||||
- On macOS, fix `run_return` does not return unless it receives a message.
|
|
||||||
- On Windows, fix bug where `RedrawRequested` would only get emitted every other iteration of the event loop.
|
|
||||||
- On X11, fix deadlock on window state when handling certain window events.
|
|
||||||
- `WindowBuilder` now implements `Default`.
|
|
||||||
- **Breaking:** `WindowEvent::CursorMoved` changed to `f64` units, preserving high-precision data supplied by most backends
|
|
||||||
- On Wayland, fix coordinates in mouse events when scale factor isn't 1
|
|
||||||
- On Web, add the ability to provide a custom canvas
|
|
||||||
- **Breaking:** On Wayland, the `WaylandTheme` struct has been replaced with a `Theme` trait, allowing for extra configuration
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
## 0.22.2
|
|
||||||
|
|
||||||
- Added Clone implementation for 'static events.
|
|
||||||
- On Windows, fix window intermittently hanging when `ControlFlow` was set to `Poll`.
|
|
||||||
- On Windows, fix `WindowBuilder::with_maximized` being ignored.
|
|
||||||
- On Android, minimal platform support.
|
|
||||||
- On iOS, touch positions are now properly converted to physical pixels.
|
|
||||||
- On macOS, updated core-* dependencies and cocoa
|
|
||||||
|
|
||||||
## 0.22.1
|
|
||||||
|
|
||||||
- On X11, fix `ResumeTimeReached` being fired too early.
|
|
||||||
- On Web, replaced zero timeout for `ControlFlow::Poll` with `requestAnimationFrame`
|
|
||||||
- On Web, fix a possible panic during event handling
|
|
||||||
- On macOS, fix `EventLoopProxy` leaking memory for every instance.
|
|
||||||
|
|
||||||
## 0.22.0
|
|
||||||
|
|
||||||
- On Windows, fix minor timing issue in wait_until_time_or_msg
|
|
||||||
- On Windows, rework handling of request_redraw() to address panics.
|
|
||||||
- On macOS, fix `set_simple_screen` to remember frame excluding title bar.
|
|
||||||
- On Wayland, fix coordinates in touch events when scale factor isn't 1.
|
|
||||||
- On Wayland, fix color from `close_button_icon_color` not applying.
|
|
||||||
- Ignore locale if unsupported by X11 backend
|
|
||||||
- On Wayland, Add HiDPI cursor support
|
|
||||||
- On Web, add the ability to query "Light" or "Dark" system theme send `ThemeChanged` on change.
|
|
||||||
- Fix `Event::to_static` returning `None` for user events.
|
|
||||||
- On Wayland, Hide CSD for fullscreen windows.
|
|
||||||
- On Windows, ignore spurious mouse move messages.
|
|
||||||
- **Breaking:** Move `ModifiersChanged` variant from `DeviceEvent` to `WindowEvent`.
|
|
||||||
- On Windows, add `IconExtWindows` trait which exposes creating an `Icon` from an external file or embedded resource
|
|
||||||
- Add `BadIcon::OsError` variant for when OS icon functionality fails
|
|
||||||
- On Windows, fix crash at startup on systems that do not properly support Windows' Dark Mode
|
|
||||||
- Revert On macOS, fix not sending ReceivedCharacter event for specific keys combinations.
|
|
||||||
- on macOS, fix incorrect ReceivedCharacter events for some key combinations.
|
|
||||||
- **Breaking:** Use `i32` instead of `u32` for position type in `WindowEvent::Moved`.
|
|
||||||
- On macOS, a mouse motion event is now generated before every mouse click.
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
## 0.23.0
|
|
||||||
|
|
||||||
- On iOS, fixed support for the "Debug View Hierarchy" feature in Xcode.
|
|
||||||
- On all platforms, `available_monitors` and `primary_monitor` are now on `EventLoopWindowTarget` rather than `EventLoop` to list monitors event in the event loop.
|
|
||||||
- On Unix, X11 and Wayland are now optional features (enabled by default)
|
|
||||||
- On X11, fix deadlock when calling `set_fullscreen_inner`.
|
|
||||||
- On Web, prevent the webpage from scrolling when the user is focused on a winit canvas
|
|
||||||
- On Web, calling `window.set_cursor_icon` no longer breaks HiDPI scaling
|
|
||||||
- On Windows, drag and drop is now optional (enabled by default) and can be disabled with `WindowBuilderExtWindows::with_drag_and_drop(false)`.
|
|
||||||
- On Wayland, fix deadlock when calling to `set_inner_size` from a callback.
|
|
||||||
- On macOS, add `hide__other_applications` to `EventLoopWindowTarget` via existing `EventLoopWindowTargetExtMacOS` trait. `hide_other_applications` will hide other applications by calling `-[NSApplication hideOtherApplications: nil]`.
|
|
||||||
- On android added support for `run_return`.
|
|
||||||
- On MacOS, Fixed fullscreen and dialog support for `run_return`.
|
|
||||||
- On Windows, fix bug where we'd try to emit `MainEventsCleared` events during nested win32 event loops.
|
|
||||||
- On Web, use mouse events if pointer events aren't supported. This affects Safari.
|
|
||||||
- On Windows, `set_ime_position` is now a no-op instead of a runtime crash.
|
|
||||||
- On Android, `set_fullscreen` is now a no-op instead of a runtime crash.
|
|
||||||
- On iOS and Android, `set_inner_size` is now a no-op instead of a runtime crash.
|
|
||||||
- On Android, fix `ControlFlow::Poll` not polling the Android event queue.
|
|
||||||
- On macOS, add `NSWindow.hasShadow` support.
|
|
||||||
- On Web, fix vertical mouse wheel scrolling being inverted.
|
|
||||||
- On Web, implement mouse capturing for click-dragging out of the canvas.
|
|
||||||
- On Web, fix `ControlFlow::Exit` not properly handled.
|
|
||||||
- On Web (web-sys only), send `WindowEvent::ScaleFactorChanged` event when `window.devicePixelRatio` is changed.
|
|
||||||
- **Breaking:** On Web, `set_cursor_position` and `set_cursor_grab` will now always return an error.
|
|
||||||
- **Breaking:** `PixelDelta` scroll events now return a `PhysicalPosition`.
|
|
||||||
- On NetBSD, fixed crash due to incorrect detection of the main thread.
|
|
||||||
- **Breaking:** On X11, `-` key is mapped to the `Minus` virtual key code, instead of `Subtract`.
|
|
||||||
- On macOS, fix inverted horizontal scroll.
|
|
||||||
- **Breaking:** `current_monitor` now returns `Option<MonitorHandle>`.
|
|
||||||
- **Breaking:** `primary_monitor` now returns `Option<MonitorHandle>`.
|
|
||||||
- On macOS, updated core-* dependencies and cocoa.
|
|
||||||
- Bump `parking_lot` to 0.11
|
|
||||||
- On Android, bump `ndk`, `ndk-sys` and `ndk-glue` to 0.2. Checkout the new ndk-glue main proc attribute.
|
|
||||||
- On iOS, fixed starting the app in landscape where the view still had portrait dimensions.
|
|
||||||
- Deprecate the stdweb backend, to be removed in a future release
|
|
||||||
- **Breaking:** Prefixed virtual key codes `Add`, `Multiply`, `Divide`, `Decimal`, and `Subtract` with `Numpad`.
|
|
||||||
- Added `Asterisk` and `Plus` virtual key codes.
|
|
||||||
- On Web (web-sys only), the `Event::LoopDestroyed` event is correctly emitted when leaving the page.
|
|
||||||
- On Web, the `WindowEvent::Destroyed` event now gets emitted when a `Window` is dropped.
|
|
||||||
- On Web (web-sys only), the event listeners are now removed when a `Window` is dropped or when the event loop is destroyed.
|
|
||||||
- On Web, the event handler closure passed to `EventLoop::run` now gets dropped after the event loop is destroyed.
|
|
||||||
- **Breaking:** On Web, the canvas element associated to a `Window` is no longer removed from the DOM when the `Window` is dropped.
|
|
||||||
- On Web, `WindowEvent::Resized` is now emitted when `Window::set_inner_size` is called.
|
|
||||||
- **Breaking:** `Fullscreen` enum now uses `Borderless(Option<MonitorHandle>)` instead of `Borderless(MonitorHandle)` to allow picking the current monitor.
|
|
||||||
- On MacOS, fix `WindowEvent::Moved` ignoring the scale factor.
|
|
||||||
- On Wayland, add missing virtual keycodes.
|
|
||||||
- On Wayland, implement proper `set_cursor_grab`.
|
|
||||||
- On Wayland, the cursor will use similar icons if the requested one isn't available.
|
|
||||||
- On Wayland, right clicking on client side decorations will request application menu.
|
|
||||||
- On Wayland, fix tracking of window size after state changes.
|
|
||||||
- On Wayland, fix client side decorations not being hidden properly in fullscreen.
|
|
||||||
- On Wayland, fix incorrect size event when entering fullscreen with client side decorations.
|
|
||||||
- On Wayland, fix `resizable` attribute not being applied properly on startup.
|
|
||||||
- On Wayland, fix disabled repeat rate not being handled.
|
|
||||||
- On Wayland, fix decoration buttons not working after tty switch.
|
|
||||||
- On Wayland, fix scaling not being applied on output re-enable.
|
|
||||||
- On Wayland, fix crash when `XCURSOR_SIZE` is `0`.
|
|
||||||
- On Wayland, fix pointer getting created in some cases without pointer capability.
|
|
||||||
- On Wayland, on kwin, fix space between window and decorations on startup.
|
|
||||||
- **Breaking:** On Wayland, `Theme` trait was reworked.
|
|
||||||
- On Wayland, disable maximize button for non-resizable window.
|
|
||||||
- On Wayland, added support for `set_ime_position`.
|
|
||||||
- On Wayland, fix crash on startup since GNOME 3.37.90.
|
|
||||||
- On X11, fix incorrect modifiers state on startup.
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
## 0.24.0
|
|
||||||
|
|
||||||
- On Windows, fix applications not exiting gracefully due to thread_event_target_callback accessing corrupted memory.
|
|
||||||
- On Windows, implement `Window::set_ime_position`.
|
|
||||||
- **Breaking:** On Windows, Renamed `WindowBuilderExtWindows`'s `is_dark_mode` to `theme`.
|
|
||||||
- **Breaking:** On Windows, renamed `WindowBuilderExtWindows::is_dark_mode` to `theme`.
|
|
||||||
- On Windows, add `WindowBuilderExtWindows::with_theme` to set a preferred theme.
|
|
||||||
- On Windows, fix bug causing message boxes to appear delayed.
|
|
||||||
- On Android, calling `WindowEvent::Focused` now works properly instead of always returning false.
|
|
||||||
- On Windows, fix Alt-Tab behaviour by removing borderless fullscreen "always on top" flag.
|
|
||||||
- On Windows, fix bug preventing windows with transparency enabled from having fully-opaque regions.
|
|
||||||
- **Breaking:** On Windows, include prefix byte in scancodes.
|
|
||||||
- On Wayland, fix window not being resizeable when using `WindowBuilder::with_min_inner_size`.
|
|
||||||
- On Unix, fix cross-compiling to wasm32 without enabling X11 or Wayland.
|
|
||||||
- On Windows, fix use-after-free crash during window destruction.
|
|
||||||
- On Web, fix `WindowEvent::ReceivedCharacter` never being sent on key input.
|
|
||||||
- On macOS, fix compilation when targeting aarch64.
|
|
||||||
- On X11, fix `Window::request_redraw` not waking the event loop.
|
|
||||||
- On Wayland, the keypad arrow keys are now recognized.
|
|
||||||
- **Breaking** Rename `desktop::EventLoopExtDesktop` to `run_return::EventLoopExtRunReturn`.
|
|
||||||
- Added `request_user_attention` method to `Window`.
|
|
||||||
- **Breaking:** On macOS, removed `WindowExt::request_user_attention`, use `Window::request_user_attention`.
|
|
||||||
- **Breaking:** On X11, removed `WindowExt::set_urgent`, use `Window::request_user_attention`.
|
|
||||||
- On Wayland, default font size in CSD increased from 11 to 17.
|
|
||||||
- On Windows, fix bug causing message boxes to appear delayed.
|
|
||||||
- On Android, support multi-touch.
|
|
||||||
- On Wayland, extra mouse buttons are not dropped anymore.
|
|
||||||
- **Breaking**: `MouseButton::Other` now uses `u16`.
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
## 0.25.0
|
|
||||||
|
|
||||||
- **Breaking:** On macOS, replace `WindowBuilderExtMacOS::with_activation_policy` with `EventLoopExtMacOS::set_activation_policy`
|
|
||||||
- On macOS, wait with activating the application until the application has initialized.
|
|
||||||
- On macOS, fix creating new windows when the application has a main menu.
|
|
||||||
- On Windows, fix fractional deltas for mouse wheel device events.
|
|
||||||
- On macOS, fix segmentation fault after dropping the main window.
|
|
||||||
- On Android, `InputEvent::KeyEvent` is partially implemented providing the key scancode.
|
|
||||||
- Added `is_maximized` method to `Window`.
|
|
||||||
- On Windows, fix bug where clicking the decoration bar would make the cursor blink.
|
|
||||||
- On Windows, fix bug causing newly created windows to erroneously display the "wait" (spinning) cursor.
|
|
||||||
- On macOS, wake up the event loop immediately when a redraw is requested.
|
|
||||||
- On Windows, change the default window size (1024x768) to match the default on other desktop platforms (800x600).
|
|
||||||
- On Windows, fix bug causing mouse capture to not be released.
|
|
||||||
- On Windows, fix fullscreen not preserving minimized/maximized state.
|
|
||||||
- On Android, unimplemented events are marked as unhandled on the native event loop.
|
|
||||||
- On Windows, added `WindowBuilderExtWindows::with_menu` to set a custom menu at window creation time.
|
|
||||||
- On Android, bump `ndk` and `ndk-glue` to 0.3: use predefined constants for event `ident`.
|
|
||||||
- On macOS, fix objects captured by the event loop closure not being dropped on panic.
|
|
||||||
- On Windows, fixed `WindowEvent::ThemeChanged` not properly firing and fixed `Window::theme` returning the wrong theme.
|
|
||||||
- On Web, added support for `DeviceEvent::MouseMotion` to listen for relative mouse movements.
|
|
||||||
- Added `WindowBuilder::with_position` to allow setting the position of a `Window` on creation. Supported on Windows, macOS and X11.
|
|
||||||
- Added `Window::drag_window`. Implemented on Windows, macOS, X11 and Wayland.
|
|
||||||
- On X11, bump `mio` to 0.7.
|
|
||||||
- On Windows, added `WindowBuilderExtWindows::with_owner_window` to allow creating popup windows.
|
|
||||||
- On Windows, added `WindowExtWindows::set_enable` to allow creating modal popup windows.
|
|
||||||
- On macOS, emit `RedrawRequested` events immediately while the window is being resized.
|
|
||||||
- Implement `Default`, `Hash`, and `Eq` for `LogicalPosition`, `PhysicalPosition`, `LogicalSize`, and `PhysicalSize`.
|
|
||||||
- On macOS, initialize the Menu Bar with minimal defaults. (Can be prevented using `enable_default_menu_creation`)
|
|
||||||
- On macOS, change the default behavior for first click when the window was unfocused. Now the window becomes focused and then emits a `MouseInput` event on a "first mouse click".
|
|
||||||
- Implement mint (math interoperability standard types) conversions (under feature flag `mint`).
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
## 0.26.1
|
|
||||||
|
|
||||||
- Fix linking to the `ColorSync` framework on macOS 10.7, and in newer Rust versions.
|
|
||||||
- On Web, implement cursor grabbing through the pointer lock API.
|
|
||||||
- On X11, add mappings for numpad comma, numpad enter, numlock and pause.
|
|
||||||
- On macOS, fix Pinyin IME input by reverting a change that intended to improve IME.
|
|
||||||
- On Windows, fix a crash with transparent windows on Windows 11.
|
|
||||||
|
|
||||||
## 0.26.0
|
|
||||||
|
|
||||||
- Update `raw-window-handle` to `v0.4`. This is _not_ a breaking change, we still implement `HasRawWindowHandle` from `v0.3`, see [rust-windowing/raw-window-handle#74](https://github.com/rust-windowing/raw-window-handle/pull/74). Note that you might have to run `cargo update -p raw-window-handle` after upgrading.
|
|
||||||
- On X11, bump `mio` to 0.8.
|
|
||||||
- On Android, fixed `WindowExtAndroid::config` initially returning an empty `Configuration`.
|
|
||||||
- On Android, fixed `Window::scale_factor` and `MonitorHandle::scale_factor` initially always returning 1.0.
|
|
||||||
- On X11, select an appropriate visual for transparency if is requested
|
|
||||||
- On Wayland and X11, fix diagonal window resize cursor orientation.
|
|
||||||
- On macOS, drop the event callback before exiting.
|
|
||||||
- On Android, implement `Window::request_redraw`
|
|
||||||
- **Breaking:** On Web, remove the `stdweb` backend.
|
|
||||||
- Added `Window::focus_window`to bring the window to the front and set input focus.
|
|
||||||
- On Wayland and X11, implement `is_maximized` method on `Window`.
|
|
||||||
- On Windows, prevent ghost window from showing up in the taskbar after either several hours of use or restarting `explorer.exe`.
|
|
||||||
- On macOS, fix issue where `ReceivedCharacter` was not being emitted during some key repeat events.
|
|
||||||
- On Wayland, load cursor icons `hand2` and `hand1` for `CursorIcon::Hand`.
|
|
||||||
- **Breaking:** On Wayland, Theme trait and its support types are dropped.
|
|
||||||
- On Wayland, bump `smithay-client-toolkit` to 0.15.1.
|
|
||||||
- On Wayland, implement `request_user_attention` with `xdg_activation_v1`.
|
|
||||||
- On X11, emit missing `WindowEvent::ScaleFactorChanged` when the only monitor gets reconnected.
|
|
||||||
- On X11, if RANDR based scale factor is higher than 20 reset it to 1
|
|
||||||
- On Wayland, add an enabled-by-default feature called `wayland-dlopen` so users can opt out of using `dlopen` to load system libraries.
|
|
||||||
- **Breaking:** On Android, bump `ndk` and `ndk-glue` to 0.5.
|
|
||||||
- On Windows, increase wait timer resolution for more accurate timing when using `WaitUntil`.
|
|
||||||
- On macOS, fix native file dialogs hanging the event loop.
|
|
||||||
- On Wayland, implement a workaround for wrong configure size when using `xdg_decoration` in `kwin_wayland`
|
|
||||||
- On macOS, fix an issue that prevented the menu bar from showing in borderless fullscreen mode.
|
|
||||||
- On X11, EINTR while polling for events no longer causes a panic. Instead it will be treated as a spurious wakeup.
|
|
||||||
@@ -1,107 +0,0 @@
|
|||||||
## 0.27.5
|
|
||||||
|
|
||||||
- On Wayland, fix byte offset in `Ime::Preedit` pointing to invalid bytes.
|
|
||||||
|
|
||||||
## 0.27.4
|
|
||||||
|
|
||||||
- On Windows, emit `ReceivedCharacter` events on system keybindings.
|
|
||||||
- On Windows, fixed focus event emission on minimize.
|
|
||||||
- On X11, fixed IME crashing during reload.
|
|
||||||
|
|
||||||
## 0.27.3
|
|
||||||
|
|
||||||
- On Windows, added `WindowExtWindows::set_undecorated_shadow` and `WindowBuilderExtWindows::with_undecorated_shadow` to draw the drop shadow behind a borderless window.
|
|
||||||
- On Windows, fixed default window features (ie snap, animations, shake, etc.) when decorations are disabled.
|
|
||||||
- On Windows, fixed ALT+Space shortcut to open window menu.
|
|
||||||
- On Wayland, fixed `Ime::Preedit` not being sent on IME reset.
|
|
||||||
- Fixed unbound version specified for `raw-window-handle` leading to compilation failures.
|
|
||||||
- Empty `Ime::Preedit` event will be sent before `Ime::Commit` to help clearing preedit.
|
|
||||||
- On X11, fixed IME context picking by querying for supported styles beforehand.
|
|
||||||
|
|
||||||
## 0.27.2
|
|
||||||
|
|
||||||
- On macOS, fixed touch phase reporting when scrolling.
|
|
||||||
- On X11, fix min, max and resize increment hints not persisting for resizable windows (e.g. on DPI change).
|
|
||||||
- On Windows, respect min/max inner sizes when creating the window.
|
|
||||||
- For backwards compatibility, `Window` now (additionally) implements the old version (`0.4`) of the `HasRawWindowHandle` trait
|
|
||||||
- On Windows, added support for `EventLoopWindowTarget::set_device_event_filter`.
|
|
||||||
- On Wayland, fix user requested `WindowEvent::RedrawRequested` being delayed by a frame.
|
|
||||||
|
|
||||||
## 0.27.1
|
|
||||||
|
|
||||||
- The minimum supported Rust version was lowered to `1.57.0` and now explicitly tested.
|
|
||||||
- On X11, fix crash on start due to inability to create an IME context without any preedit.
|
|
||||||
|
|
||||||
## 0.27.0
|
|
||||||
|
|
||||||
- On Windows, fix hiding a maximized window.
|
|
||||||
- On Android, `ndk-glue`'s `NativeWindow` lock is now held between `Event::Resumed` and `Event::Suspended`.
|
|
||||||
- On Web, added `EventLoopExtWebSys` with a `spawn` method to start the event loop without throwing an exception.
|
|
||||||
- Added `WindowEvent::Occluded(bool)`, currently implemented on macOS and X11.
|
|
||||||
- On X11, fix events for caps lock key not being sent
|
|
||||||
- Build docs on `docs.rs` for iOS and Android as well.
|
|
||||||
- **Breaking:** Removed the `WindowAttributes` struct, since all its functionality is accessible from `WindowBuilder`.
|
|
||||||
- Added `WindowBuilder::transparent` getter to check if the user set `transparent` attribute.
|
|
||||||
- On macOS, Fix emitting `Event::LoopDestroyed` on CMD+Q.
|
|
||||||
- On macOS, fixed an issue where having multiple windows would prevent run_return from ever returning.
|
|
||||||
- On Wayland, fix bug where the cursor wouldn't hide in GNOME.
|
|
||||||
- On macOS, Windows, and Wayland, add `set_cursor_hittest` to let the window ignore mouse events.
|
|
||||||
- On Windows, added `WindowExtWindows::set_skip_taskbar` and `WindowBuilderExtWindows::with_skip_taskbar`.
|
|
||||||
- On Windows, added `EventLoopBuilderExtWindows::with_msg_hook`.
|
|
||||||
- On Windows, remove internally unique DC per window.
|
|
||||||
- On macOS, remove the need to call `set_ime_position` after moving the window.
|
|
||||||
- Added `Window::is_visible`.
|
|
||||||
- Added `Window::is_resizable`.
|
|
||||||
- Added `Window::is_decorated`.
|
|
||||||
- On X11, fix for repeated event loop iteration when `ControlFlow` was `Wait`
|
|
||||||
- On X11, fix scale factor calculation when the only monitor is reconnected
|
|
||||||
- On Wayland, report unaccelerated mouse deltas in `DeviceEvent::MouseMotion`.
|
|
||||||
- On Web, a focused event is manually generated when a click occurs to emulate behaviour of other backends.
|
|
||||||
- **Breaking:** Bump `ndk` version to 0.6, ndk-sys to `v0.3`, `ndk-glue` to `0.6`.
|
|
||||||
- Remove no longer needed `WINIT_LINK_COLORSYNC` environment variable.
|
|
||||||
- **Breaking:** Rename the `Exit` variant of `ControlFlow` to `ExitWithCode`, which holds a value to control the exit code after running. Add an `Exit` constant which aliases to `ExitWithCode(0)` instead to avoid major breakage. This shouldn't affect most existing programs.
|
|
||||||
- Add `EventLoopBuilder`, which allows you to create and tweak the settings of an event loop before creating it.
|
|
||||||
- Deprecated `EventLoop::with_user_event`; use `EventLoopBuilder::with_user_event` instead.
|
|
||||||
- **Breaking:** Replaced `EventLoopExtMacOS` with `EventLoopBuilderExtMacOS` (which also has renamed methods).
|
|
||||||
- **Breaking:** Replaced `EventLoopExtWindows` with `EventLoopBuilderExtWindows` (which also has renamed methods).
|
|
||||||
- **Breaking:** Replaced `EventLoopExtUnix` with `EventLoopBuilderExtUnix` (which also has renamed methods).
|
|
||||||
- **Breaking:** The platform specific extensions for Windows `winit::platform::windows` have changed. All `HANDLE`-like types e.g. `HWND` and `HMENU` were converted from winapi types or `*mut c_void` to `isize`. This was done to be consistent with the type definitions in windows-sys and to not expose internal dependencies.
|
|
||||||
- The internal bindings to the [Windows API](https://docs.microsoft.com/en-us/windows/) were changed from the unofficial [winapi](https://github.com/retep998/winapi-rs) bindings to the official Microsoft [windows-sys](https://github.com/microsoft/windows-rs) bindings.
|
|
||||||
- On Wayland, fix polling during consecutive `EventLoop::run_return` invocations.
|
|
||||||
- On Windows, fix race issue creating fullscreen windows with `WindowBuilder::with_fullscreen`
|
|
||||||
- On Android, `virtual_keycode` for `KeyboardInput` events is now filled in where a suitable match is found.
|
|
||||||
- Added helper methods on `ControlFlow` to set its value.
|
|
||||||
- On Wayland, fix `TouchPhase::Ended` always reporting the location of the first touch down, unless the compositor
|
|
||||||
sent a cancel or frame event.
|
|
||||||
- On iOS, send `RedrawEventsCleared` even if there are no redraw events, consistent with other platforms.
|
|
||||||
- **Breaking:** Replaced `Window::with_app_id` and `Window::with_class` with `Window::with_name` on `WindowBuilderExtUnix`.
|
|
||||||
- On Wayland, fallback CSD was replaced with proper one:
|
|
||||||
- `WindowBuilderExtUnix::with_wayland_csd_theme` to set color theme in builder.
|
|
||||||
- `WindowExtUnix::wayland_set_csd_theme` to set color theme when creating a window.
|
|
||||||
- `WINIT_WAYLAND_CSD_THEME` env variable was added, it can be used to set "dark"/"light" theme in apps that don't expose theme setting.
|
|
||||||
- `wayland-csd-adwaita` feature that enables proper CSD with title rendering using FreeType system library.
|
|
||||||
- `wayland-csd-adwaita-notitle` feature that enables CSD but without title rendering.
|
|
||||||
- On Wayland and X11, fix window not resizing with `Window::set_inner_size` after calling `Window:set_resizable(false)`.
|
|
||||||
- On Windows, fix wrong fullscreen monitors being recognized when handling WM_WINDOWPOSCHANGING messages
|
|
||||||
- **Breaking:** Added new `WindowEvent::Ime` supported on desktop platforms.
|
|
||||||
- Added `Window::set_ime_allowed` supported on desktop platforms.
|
|
||||||
- **Breaking:** IME input on desktop platforms won't be received unless it's explicitly allowed via `Window::set_ime_allowed` and new `WindowEvent::Ime` events are handled.
|
|
||||||
- On macOS, `WindowEvent::Resized` is now emitted in `frameDidChange` instead of `windowDidResize`.
|
|
||||||
- **Breaking:** On X11, device events are now ignored for unfocused windows by default, use `EventLoopWindowTarget::set_device_event_filter` to set the filter level.
|
|
||||||
- Implemented `Default` on `EventLoop<()>`.
|
|
||||||
- Implemented `Eq` for `Fullscreen`, `Theme`, and `UserAttentionType`.
|
|
||||||
- **Breaking:** `Window::set_cursor_grab` now accepts `CursorGrabMode` to control grabbing behavior.
|
|
||||||
- On Wayland, add support for `Window::set_cursor_position`.
|
|
||||||
- Fix on macOS `WindowBuilder::with_disallow_hidpi`, setting true or false by the user no matter the SO default value.
|
|
||||||
- `EventLoopBuilder::build` will now panic when the `EventLoop` is being created more than once.
|
|
||||||
- Added `From<u64>` for `WindowId` and `From<WindowId>` for `u64`.
|
|
||||||
- Added `MonitorHandle::refresh_rate_millihertz` to get monitor's refresh rate.
|
|
||||||
- **Breaking**, Replaced `VideoMode::refresh_rate` with `VideoMode::refresh_rate_millihertz` providing better precision.
|
|
||||||
- On Web, add `with_prevent_default` and `with_focusable` to `WindowBuilderExtWebSys` to control whether events should be propagated.
|
|
||||||
- On Windows, fix focus events being sent to inactive windows.
|
|
||||||
- **Breaking**, update `raw-window-handle` to `v0.5` and implement `HasRawDisplayHandle` for `Window` and `EventLoopWindowTarget`.
|
|
||||||
- On X11, add function `register_xlib_error_hook` into `winit::platform::unix` to subscribe for errors coming from Xlib.
|
|
||||||
- On Android, upgrade `ndk` and `ndk-glue` dependencies to the recently released `0.7.0`.
|
|
||||||
- All platforms can now be relied on to emit a `Resumed` event. Applications are recommended to lazily initialize graphics state and windows on first resume for portability.
|
|
||||||
- **Breaking:**: Reverse horizontal scrolling sign in `MouseScrollDelta` to match the direction of vertical scrolling. A positive X value now means moving the content to the right. The meaning of vertical scrolling stays the same: a positive Y value means moving the content down.
|
|
||||||
- On MacOS, fix deadlock when calling `set_maximized` from event loop.
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
## 0.28.7
|
|
||||||
|
|
||||||
- Fix window size sometimes being invalid when resizing on macOS 14 Sonoma.
|
|
||||||
|
|
||||||
## 0.28.6
|
|
||||||
|
|
||||||
- On macOS, fixed memory leak when getting monitor handle.
|
|
||||||
- On macOS, fix `Backspace` being emitted when clearing preedit with it.
|
|
||||||
|
|
||||||
## 0.28.5
|
|
||||||
|
|
||||||
- On macOS, fix `key_up` being ignored when `Ime` is disabled.
|
|
||||||
|
|
||||||
## 0.28.4
|
|
||||||
|
|
||||||
- On macOS, fix empty marked text blocking regular input.
|
|
||||||
- On macOS, fix potential panic when getting refresh rate.
|
|
||||||
- On macOS, fix crash when calling `Window::set_ime_position` from another thread.
|
|
||||||
|
|
||||||
## 0.28.3
|
|
||||||
|
|
||||||
- Fix macOS memory leaks.
|
|
||||||
|
|
||||||
## 0.28.2
|
|
||||||
|
|
||||||
- Implement `HasRawDisplayHandle` for `EventLoop`.
|
|
||||||
- On macOS, set resize increments only for live resizes.
|
|
||||||
- On Wayland, fix rare crash on DPI change
|
|
||||||
- Web: Added support for `Window::theme`.
|
|
||||||
- On Wayland, fix rounding issues when doing resize.
|
|
||||||
- On macOS, fix wrong focused state on startup.
|
|
||||||
- On Windows, fix crash on setting taskbar when using Visual Studio debugger.
|
|
||||||
- On macOS, resize simple fullscreen windows on windowDidChangeScreen events.
|
|
||||||
|
|
||||||
## 0.28.1
|
|
||||||
|
|
||||||
- On Wayland, fix crash when dropping a window in multi-window setup.
|
|
||||||
|
|
||||||
## 0.28.0
|
|
||||||
|
|
||||||
- On macOS, fixed `Ime::Commit` persisting for all input after interacting with `Ime`.
|
|
||||||
- On macOS, added `WindowExtMacOS::option_as_alt` and `WindowExtMacOS::set_option_as_alt`.
|
|
||||||
- On Windows, fix window size for maximized, undecorated windows.
|
|
||||||
- On Windows and macOS, add `WindowBuilder::with_active`.
|
|
||||||
- Add `Window::is_minimized`.
|
|
||||||
- On X11, fix errors handled during `register_xlib_error_hook` invocation bleeding into winit.
|
|
||||||
- Add `Window::has_focus`.
|
|
||||||
- On Windows, fix `Window::set_minimized(false)` not working for windows minimized by `Win + D` hotkey.
|
|
||||||
- **Breaking:** On Web, touch input no longer fires `WindowEvent::Cursor*`, `WindowEvent::MouseInput`, or `DeviceEvent::MouseMotion` like other platforms, but instead it fires `WindowEvent::Touch`.
|
|
||||||
- **Breaking:** Removed platform specific `WindowBuilder::with_parent` API in favor of `WindowBuilder::with_parent_window`.
|
|
||||||
- On Windows, retain `WS_MAXIMIZE` window style when un-minimizing a maximized window.
|
|
||||||
- On Windows, fix left mouse button release event not being sent after `Window::drag_window`.
|
|
||||||
- On macOS, run most actions on the main thread, which is strictly more correct, but might make multithreaded applications block slightly more.
|
|
||||||
- On macOS, fix panic when getting current monitor without any monitor attached.
|
|
||||||
- On Windows and MacOS, add API to enable/disable window buttons (close, minimize, ...etc).
|
|
||||||
- On Windows, macOS, X11 and Wayland, add `Window::set_theme`.
|
|
||||||
- **Breaking:** Remove `WindowExtWayland::wayland_set_csd_theme` and `WindowBuilderExtX11::with_gtk_theme_variant`.
|
|
||||||
- On Windows, revert window background to an empty brush to avoid white flashes when changing scaling.
|
|
||||||
- **Breaking:** Removed `Window::set_always_on_top` and related APIs in favor of `Window::set_window_level`.
|
|
||||||
- On Windows, MacOS and X11, add always on bottom APIs.
|
|
||||||
- On Windows, fix the value in `MouseButton::Other`.
|
|
||||||
- On macOS, add `WindowExtMacOS::is_document_edited` and `WindowExtMacOS::set_document_edited` APIs.
|
|
||||||
- **Breaking:** Removed `WindowBuilderExtIOS::with_root_view_class`; instead, you should use `[[view layer] addSublayer: ...]` to add an instance of the desired layer class (e.g. `CAEAGLLayer` or `CAMetalLayer`). See `vulkano-win` or `wgpu` for examples of this.
|
|
||||||
- On MacOS and Windows, add `Window::set_content_protected`.
|
|
||||||
- On MacOS, add `EventLoopBuilderExtMacOS::with_activate_ignoring_other_apps`.
|
|
||||||
- On Windows, fix icons specified on `WindowBuilder` not taking effect for windows created after the first one.
|
|
||||||
- On Windows and macOS, add `Window::title` to query the current window title.
|
|
||||||
- On Windows, fix focusing menubar when pressing `Alt`.
|
|
||||||
- On MacOS, made `accepts_first_mouse` configurable.
|
|
||||||
- Migrated `WindowBuilderExtUnix::with_resize_increments` to `WindowBuilder`.
|
|
||||||
- Added `Window::resize_increments`/`Window::set_resize_increments` to update resize increments at runtime for X11/macOS.
|
|
||||||
- macOS/iOS: Use `objc2` instead of `objc` internally.
|
|
||||||
- **Breaking:** Bump MSRV from `1.57` to `1.60`.
|
|
||||||
- **Breaking:** Split the `platform::unix` module into `platform::x11` and `platform::wayland`. The extension types are similarly renamed.
|
|
||||||
- **Breaking:**: Removed deprecated method `platform::unix::WindowExtUnix::is_ready`.
|
|
||||||
- Removed `parking_lot` dependency.
|
|
||||||
- **Breaking:** On macOS, add support for two-finger touchpad magnification and rotation gestures with new events `WindowEvent::TouchpadMagnify` and `WindowEvent::TouchpadRotate`. Also add support for touchpad smart-magnification gesture with a new event `WindowEvent::SmartMagnify`.
|
|
||||||
- **Breaking:** On web, the `WindowBuilderExtWebSys::with_prevent_default` setting (enabled by default), now additionally prevents scrolling of the webpage in mobile browsers, previously it only disabled scrolling on desktop.
|
|
||||||
- On Wayland, `wayland-csd-adwaita` now uses `ab_glyph` instead of `crossfont` to render the title for decorations.
|
|
||||||
- On Wayland, a new `wayland-csd-adwaita-crossfont` feature was added to use `crossfont` instead of `ab_glyph` for decorations.
|
|
||||||
- On Wayland, if not otherwise specified use upstream automatic CSD theme selection.
|
|
||||||
- On X11, added `WindowExtX11::with_parent` to create child windows.
|
|
||||||
- Added support for `WindowBuilder::with_theme` and `Window::theme` to support per-window dark/light/system theme configuration on macos, windows and wayland.
|
|
||||||
- On macOS, added support for `WindowEvent::ThemeChanged`.
|
|
||||||
- **Breaking:** Removed `WindowBuilderExtWindows::with_theme` and `WindowBuilderExtWayland::with_wayland_csd_theme` in favour of `WindowBuilder::with_theme`.
|
|
||||||
- **Breaking:** Removed `WindowExtWindows::theme` in favour of `Window::theme`.
|
|
||||||
- Enabled `doc_auto_cfg` when generating docs on docs.rs for feature labels.
|
|
||||||
- **Breaking:** On Android, switched to using [`android-activity`](https://github.com/rib/android-activity) crate as a glue layer instead of [`ndk-glue`](https://github.com/rust-windowing/android-ndk-rs/tree/master/ndk-glue). See [README.md#Android](https://github.com/rust-windowing/winit#Android) for more details. ([#2444](https://github.com/rust-windowing/winit/pull/2444))
|
|
||||||
- **Breaking:** Removed support for `raw-window-handle` version `0.4`
|
|
||||||
- On Wayland, `RedrawRequested` not emitted during resize.
|
|
||||||
- Add a `set_wait_timeout` function to `ControlFlow` to allow waiting for a `Duration`.
|
|
||||||
- **Breaking:** Remove the unstable `xlib_xconnection()` function from the private interface.
|
|
||||||
- Added Orbital support for Redox OS
|
|
||||||
- On X11, added `drag_resize_window` method.
|
|
||||||
- Added `Window::set_transparent` to provide a hint about transparency of the window on Wayland and macOS.
|
|
||||||
- On macOS, fix the mouse buttons other than left/right/middle being reported as middle.
|
|
||||||
- On Wayland, support fractional scaling via the wp-fractional-scale protocol.
|
|
||||||
- On web, fix removal of mouse event listeners from the global object upon window destruction.
|
|
||||||
- Add WindowAttributes getter to WindowBuilder to allow introspection of default values.
|
|
||||||
- Added `Window::set_ime_purpose` for setting the IME purpose, currently implemented on Wayland only.
|
|
||||||
@@ -1,289 +0,0 @@
|
|||||||
## 0.29.15
|
|
||||||
|
|
||||||
- On X11, fix crash due to xsettings query on systems with incomplete xsettings.
|
|
||||||
|
|
||||||
## 0.29.14
|
|
||||||
|
|
||||||
- On X11/Wayland, fix `text` and `text_with_all_modifiers` not being `None` during compose.
|
|
||||||
- On Wayland, don't reapply cursor grab when unchanged.
|
|
||||||
- On X11, fix a bug where some mouse events would be unexpectedly filtered out.
|
|
||||||
|
|
||||||
## 0.29.13
|
|
||||||
|
|
||||||
- On Web, fix possible crash with `ControlFlow::Wait` and `ControlFlow::WaitUntil`.
|
|
||||||
|
|
||||||
## 0.29.12
|
|
||||||
|
|
||||||
- On X11, fix use after free during xinput2 handling.
|
|
||||||
- On X11, filter close to zero values in mouse device events
|
|
||||||
|
|
||||||
## 0.29.11
|
|
||||||
|
|
||||||
- Fix compatibility with 32-bit platforms without 64-bit atomics.
|
|
||||||
- On macOS, fix incorrect IME cursor rect origin.
|
|
||||||
- On Windows, fixed a race condition when sending an event through the loop proxy.
|
|
||||||
- On X11, fix swapped instance and general class names.
|
|
||||||
- On X11, don't require XIM to run.
|
|
||||||
- On X11, fix xkb state not being updated correctly sometimes leading to wrong input.
|
|
||||||
- On X11, reload dpi on `_XSETTINGS_SETTINGS` update.
|
|
||||||
- On X11, fix deadlock when adjusting DPI and resizing at the same time.
|
|
||||||
- On Wayland, disable `Occluded` event handling.
|
|
||||||
- On Wayland, fix DeviceEvent::Motion not being sent
|
|
||||||
- On Wayland, fix `Focused(false)` being send when other seats still have window focused.
|
|
||||||
- On Wayland, fix `Window::set_{min,max}_inner_size` not always applied.
|
|
||||||
- On Wayland, fix title in CSD not updated from `AboutToWait`.
|
|
||||||
- On Windows, fix inconsistent resizing behavior with multi-monitor setups when repositioning outside the event loop.
|
|
||||||
- On Wayland, fix `WAYLAND_SOCKET` not used when detecting platform.
|
|
||||||
- On Orbital, fix `logical_key` and `text` not reported in `KeyEvent`.
|
|
||||||
- On Orbital, implement `KeyEventExtModifierSupplement`.
|
|
||||||
- On Orbital, map keys to `NamedKey` when possible.
|
|
||||||
- On Orbital, implement `set_cursor_grab`.
|
|
||||||
- On Orbital, implement `set_cursor_visible`.
|
|
||||||
- On Orbital, implement `drag_window`.
|
|
||||||
- On Orbital, implement `drag_resize_window`.
|
|
||||||
- On Orbital, implement `set_transparent`.
|
|
||||||
- On Orbital, implement `set_visible`.
|
|
||||||
- On Orbital, implement `is_visible`.
|
|
||||||
- On Orbital, implement `set_resizable`.
|
|
||||||
- On Orbital, implement `is_resizable`.
|
|
||||||
- On Orbital, implement `set_maximized`.
|
|
||||||
- On Orbital, implement `is_maximized`.
|
|
||||||
- On Orbital, implement `set_decorations`.
|
|
||||||
- On Orbital, implement `is_decorated`.
|
|
||||||
- On Orbital, implement `set_window_level`.
|
|
||||||
- On Orbital, emit `DeviceEvent::MouseMotion`.
|
|
||||||
|
|
||||||
## 0.29.10
|
|
||||||
|
|
||||||
- On Web, account for canvas being focused already before event loop starts.
|
|
||||||
- On Web, increase cursor position accuracy.
|
|
||||||
|
|
||||||
## 0.29.9
|
|
||||||
|
|
||||||
- On X11, fix `NotSupported` error not propagated when creating event loop.
|
|
||||||
- On Wayland, fix resize not issued when scale changes
|
|
||||||
- On X11 and Wayland, fix arrow up on keypad reported as `ArrowLeft`.
|
|
||||||
- On macOS, report correct logical key when Ctrl or Cmd is pressed.
|
|
||||||
|
|
||||||
## 0.29.8
|
|
||||||
|
|
||||||
- On X11, fix IME input lagging behind.
|
|
||||||
- On X11, fix `ModifiersChanged` not sent from xdotool-like input
|
|
||||||
- On X11, fix keymap not updated from xmodmap.
|
|
||||||
- On X11, reduce the amount of time spent fetching screen resources.
|
|
||||||
- On Wayland, fix `Window::request_inner_size` being overwritten by resize.
|
|
||||||
- On Wayland, fix `Window::inner_size` not using the correct rounding.
|
|
||||||
|
|
||||||
## 0.29.7
|
|
||||||
|
|
||||||
- On X11, fix `Xft.dpi` reload during runtime.
|
|
||||||
- On X11, fix window minimize.
|
|
||||||
|
|
||||||
## 0.29.6
|
|
||||||
|
|
||||||
- On Web, fix context menu not being disabled by `with_prevent_default(true)`.
|
|
||||||
- On Wayland, fix `WindowEvent::Destroyed` not being delivered after destroying window.
|
|
||||||
- Fix `EventLoopExtRunOnDemand::run_on_demand` not working for consequent invocation
|
|
||||||
|
|
||||||
## 0.29.5
|
|
||||||
|
|
||||||
- On macOS, remove spurious error logging when handling `Fn`.
|
|
||||||
- On X11, fix an issue where floating point data from the server is
|
|
||||||
misinterpreted during a drag and drop operation.
|
|
||||||
- On X11, fix a bug where focusing the window would panic.
|
|
||||||
- On macOS, fix `refresh_rate_millihertz`.
|
|
||||||
- On Wayland, disable Client Side Decorations when `wl_subcompositor` is not supported.
|
|
||||||
- On X11, fix `Xft.dpi` detection from Xresources.
|
|
||||||
- On Windows, fix consecutive calls to `window.set_fullscreen(Some(Fullscreen::Borderless(None)))` resulting in losing previous window state when eventually exiting fullscreen using `window.set_fullscreen(None)`.
|
|
||||||
- On Wayland, fix resize being sent on focus change.
|
|
||||||
- On Windows, fix `set_ime_cursor_area`.
|
|
||||||
|
|
||||||
## 0.29.4
|
|
||||||
|
|
||||||
- Fix crash when running iOS app on macOS.
|
|
||||||
- On X11, check common alternative cursor names when loading cursor.
|
|
||||||
- On X11, reload the DPI after a property change event.
|
|
||||||
- On Windows, fix so `drag_window` and `drag_resize_window` can be called from another thread.
|
|
||||||
- On Windows, fix `set_control_flow` in `AboutToWait` not being taken in account.
|
|
||||||
- On macOS, send a `Resized` event after each `ScaleFactorChanged` event.
|
|
||||||
- On Wayland, fix `wl_surface` being destroyed before associated objects.
|
|
||||||
- On macOS, fix assertion when pressing `Fn` key.
|
|
||||||
- On Windows, add `WindowBuilderExtWindows::with_clip_children` to control `WS_CLIPCHILDREN` style.
|
|
||||||
|
|
||||||
## 0.29.3
|
|
||||||
|
|
||||||
- On Wayland, apply correct scale to `PhysicalSize` passed in `WindowBuilder::with_inner_size` when possible.
|
|
||||||
- On Wayland, fix `RedrawRequested` being always sent without decorations and `sctk-adwaita` feature.
|
|
||||||
- On Wayland, ignore resize requests when the window is fully tiled.
|
|
||||||
- On Wayland, use `configure_bounds` to constrain `with_inner_size` when compositor wants users to pick size.
|
|
||||||
- On Windows, fix deadlock when accessing the state during `Cursor{Enter,Leave}`.
|
|
||||||
- On Windows, add support for `Window::set_transparent`.
|
|
||||||
- On macOS, fix deadlock when entering a nested event loop from an event handler.
|
|
||||||
- On macOS, add support for `Window::set_blur`.
|
|
||||||
|
|
||||||
## 0.29.2
|
|
||||||
|
|
||||||
- **Breaking:** Bump MSRV from `1.60` to `1.65`.
|
|
||||||
- **Breaking:** Add `Event::MemoryWarning`; implemented on iOS/Android.
|
|
||||||
- **Breaking:** Bump `ndk` version to `0.8.0`, ndk-sys to `0.5.0`, `android-activity` to `0.5.0`.
|
|
||||||
- **Breaking:** Change default `ControlFlow` from `Poll` to `Wait`.
|
|
||||||
- **Breaking:** Move `Event::RedrawRequested` to `WindowEvent::RedrawRequested`.
|
|
||||||
- **Breaking:** Moved `ControlFlow::Exit` to `EventLoopWindowTarget::exit()` and `EventLoopWindowTarget::exiting()` and removed `ControlFlow::ExitWithCode(_)` entirely.
|
|
||||||
- **Breaking:** Moved `ControlFlow` to `EventLoopWindowTarget::set_control_flow()` and `EventLoopWindowTarget::control_flow()`.
|
|
||||||
- **Breaking:** `EventLoop::new` and `EventLoopBuilder::build` now return `Result<Self, EventLoopError>`
|
|
||||||
- **Breaking:** `WINIT_UNIX_BACKEND` was removed in favor of standard `WAYLAND_DISPLAY` and `DISPLAY` variables.
|
|
||||||
- **Breaking:** on Wayland, dispatching user created Wayland queue won't wake up the loop unless winit has event to send back.
|
|
||||||
- **Breaking:** remove `DeviceEvent::Text`.
|
|
||||||
- **Breaking:** Remove lifetime parameter from `Event` and `WindowEvent`.
|
|
||||||
- **Breaking:** Rename `Window::set_inner_size` to `Window::request_inner_size` and indicate if the size was applied immediately.
|
|
||||||
- **Breaking:** `ActivationTokenDone` event which could be requested with the new `startup_notify` module, see its docs for more.
|
|
||||||
- **Breaking:** `ScaleFactorChanged` now contains a writer instead of a reference to update inner size.
|
|
||||||
- **Breaking** `run() -> !` has been replaced by `run() -> Result<(), EventLoopError>` for returning errors without calling `std::process::exit()` ([#2767](https://github.com/rust-windowing/winit/pull/2767))
|
|
||||||
- **Breaking** Removed `EventLoopExtRunReturn` / `run_return` in favor of `EventLoopExtPumpEvents` / `pump_events` and `EventLoopExtRunOnDemand` / `run_on_demand` ([#2767](https://github.com/rust-windowing/winit/pull/2767))
|
|
||||||
- `RedrawRequested` is no longer guaranteed to be emitted after `MainEventsCleared`, it is now platform-specific when the event is emitted after being requested via `redraw_request()`.
|
|
||||||
- On Windows, `RedrawRequested` is now driven by `WM_PAINT` messages which are requested via `redraw_request()`
|
|
||||||
- **Breaking** `LoopDestroyed` renamed to `LoopExiting` ([#2900](https://github.com/rust-windowing/winit/issues/2900))
|
|
||||||
- **Breaking** `RedrawEventsCleared` removed ([#2900](https://github.com/rust-windowing/winit/issues/2900))
|
|
||||||
- **Breaking** `MainEventsCleared` removed ([#2900](https://github.com/rust-windowing/winit/issues/2900))
|
|
||||||
- **Breaking:** Remove all deprecated `modifiers` fields.
|
|
||||||
- **Breaking:** Rename `DeviceEventFilter` to `DeviceEvents` reversing the behavior of variants.
|
|
||||||
- **Breaking** Add `AboutToWait` event which is emitted when the event loop is about to block and wait for new events ([#2900](https://github.com/rust-windowing/winit/issues/2900))
|
|
||||||
- **Breaking:** Rename `EventLoopWindowTarget::set_device_event_filter` to `listen_device_events`.
|
|
||||||
- **Breaking:** Rename `Window::set_ime_position` to `Window::set_ime_cursor_area` adding a way to set exclusive zone.
|
|
||||||
- **Breaking:** `with_x11_visual` now takes the visual ID instead of the bare pointer.
|
|
||||||
- **Breaking** `MouseButton` now supports `Back` and `Forward` variants, emitted from mouse events on Wayland, X11, Windows, macOS and Web.
|
|
||||||
- **Breaking:** On Web, `instant` is now replaced by `web_time`.
|
|
||||||
- **Breaking:** On Web, dropped support for Safari versions below 13.1.
|
|
||||||
- **Breaking:** On Web, the canvas output bitmap size is no longer adjusted.
|
|
||||||
- **Breaking:** On Web, the canvas size is not controlled by Winit anymore and external changes to the canvas size will be reported through `WindowEvent::Resized`.
|
|
||||||
- **Breaking:** Updated `bitflags` crate version to `2`, which changes the API on exposed types.
|
|
||||||
- **Breaking:** `CursorIcon::Arrow` was removed.
|
|
||||||
- **Breaking:** `CursorIcon::Hand` is now named `CursorIcon::Pointer`.
|
|
||||||
- **Breaking:** `CursorIcon` is now used from the `cursor-icon` crate.
|
|
||||||
- **Breaking:** `WindowExtWebSys::canvas()` now returns an `Option`.
|
|
||||||
- **Breaking:** Overhaul keyboard input handling.
|
|
||||||
- Replace `KeyboardInput` with `KeyEvent` and `RawKeyEvent`.
|
|
||||||
- Change `WindowEvent::KeyboardInput` to contain a `KeyEvent`.
|
|
||||||
- Change `Event::Key` to contain a `RawKeyEvent`.
|
|
||||||
- Remove `Event::ReceivedCharacter`. In its place, you should use
|
|
||||||
`KeyEvent.text` in combination with `WindowEvent::Ime`.
|
|
||||||
- Replace `VirtualKeyCode` with the `Key` enum.
|
|
||||||
- Replace `ScanCode` with the `KeyCode` enum.
|
|
||||||
- Rename `ModifiersState::LOGO` to `SUPER` and `ModifiersState::CTRL` to `CONTROL`.
|
|
||||||
- Add `PhysicalKey` wrapping `KeyCode` and `NativeKeyCode`.
|
|
||||||
- Add `KeyCode` to refer to keys (roughly) by their physical location.
|
|
||||||
- Add `NativeKeyCode` to represent raw `KeyCode`s which Winit doesn't
|
|
||||||
understand.
|
|
||||||
- Add `Key` to represent the keys after they've been interpreted by the
|
|
||||||
active (software) keyboard layout.
|
|
||||||
- Add `NamedKey` to represent the categorized keys.
|
|
||||||
- Add `NativeKey` to represent raw `Key`s which Winit doesn't understand.
|
|
||||||
- Add `KeyLocation` to tell apart `Key`s which usually "mean" the same thing,
|
|
||||||
but can appear simultaneously in different spots on the same keyboard
|
|
||||||
layout.
|
|
||||||
- Add `Window::reset_dead_keys` to enable application-controlled cancellation
|
|
||||||
of dead key sequences.
|
|
||||||
- Add `KeyEventExtModifierSupplement` to expose additional (and less
|
|
||||||
portable) interpretations of a given key-press.
|
|
||||||
- Add `PhysicalKeyExtScancode`, which lets you convert between scancodes and
|
|
||||||
`PhysicalKey`.
|
|
||||||
- `ModifiersChanged` now uses dedicated `Modifiers` struct.
|
|
||||||
- Removed platform-specific extensions that should be retrieved through `raw-window-handle` trait implementations instead:
|
|
||||||
- `platform::windows::HINSTANCE`.
|
|
||||||
- `WindowExtWindows::hinstance`.
|
|
||||||
- `WindowExtWindows::hwnd`.
|
|
||||||
- `WindowExtIOS::ui_window`.
|
|
||||||
- `WindowExtIOS::ui_view_controller`.
|
|
||||||
- `WindowExtIOS::ui_view`.
|
|
||||||
- `WindowExtMacOS::ns_window`.
|
|
||||||
- `WindowExtMacOS::ns_view`.
|
|
||||||
- `EventLoopWindowTargetExtWayland::wayland_display`.
|
|
||||||
- `WindowExtWayland::wayland_surface`.
|
|
||||||
- `WindowExtWayland::wayland_display`.
|
|
||||||
- `WindowExtX11::xlib_window`.
|
|
||||||
- `WindowExtX11::xlib_display`.
|
|
||||||
- `WindowExtX11::xlib_screen_id`.
|
|
||||||
- `WindowExtX11::xcb_connection`.
|
|
||||||
- Reexport `raw-window-handle` in `window` module.
|
|
||||||
- Add `ElementState::is_pressed`.
|
|
||||||
- Add `Window::pre_present_notify` to notify winit before presenting to the windowing system.
|
|
||||||
- Add `Window::set_blur` to request a blur behind the window; implemented on Wayland for now.
|
|
||||||
- Add `Window::show_window_menu` to request a titlebar/system menu; implemented on Wayland/Windows for now.
|
|
||||||
- Implement `AsFd`/`AsRawFd` for `EventLoop<T>` on X11 and Wayland.
|
|
||||||
- Implement `PartialOrd` and `Ord` for `MouseButton`.
|
|
||||||
- Implement `PartialOrd` and `Ord` on types in the `dpi` module.
|
|
||||||
- Make `WindowBuilder` `Send + Sync`.
|
|
||||||
- Make iOS `MonitorHandle` and `VideoMode` usable from other threads.
|
|
||||||
- Make iOS windows usable from other threads.
|
|
||||||
- On Android, add force data to touch events.
|
|
||||||
- On Android, added `EventLoopBuilderExtAndroid::handle_volume_keys` to indicate that the application will handle the volume keys manually.
|
|
||||||
- On Android, fix `DeviceId` to contain device id's.
|
|
||||||
- On Orbital, fix `ModifiersChanged` not being sent.
|
|
||||||
- On Wayland, `Window::outer_size` now accounts for **client side** decorations.
|
|
||||||
- On Wayland, add `Window::drag_resize_window` method.
|
|
||||||
- On Wayland, remove `WINIT_WAYLAND_CSD_THEME` variable.
|
|
||||||
- On Wayland, fix `TouchPhase::Canceled` being sent for moved events.
|
|
||||||
- On Wayland, fix forward compatibility issues.
|
|
||||||
- On Wayland, fix initial window size not restored for maximized/fullscreened on startup window.
|
|
||||||
- On Wayland, fix maximized startup not taking full size on GNOME.
|
|
||||||
- On Wayland, fix maximized window creation and window geometry handling.
|
|
||||||
- On Wayland, fix window not checking that it actually got initial configure event.
|
|
||||||
- On Wayland, make double clicking and moving the CSD frame more reliable.
|
|
||||||
- On Wayland, support `Occluded` event with xdg-shell v6
|
|
||||||
- On Wayland, use frame callbacks to throttle `RedrawRequested` events so redraws will align with compositor.
|
|
||||||
- On Web, `ControlFlow::WaitUntil` now uses the Prioritized Task Scheduling API. `setTimeout()`, with a trick to circumvent throttling to 4ms, is used as a fallback.
|
|
||||||
- On Web, `EventLoopProxy` now implements `Send`.
|
|
||||||
- On Web, `Window` now implements `Send` and `Sync`.
|
|
||||||
- On Web, account for CSS `padding`, `border`, and `margin` when getting or setting the canvas position.
|
|
||||||
- On Web, add Fullscreen API compatibility for Safari.
|
|
||||||
- On Web, add `DeviceEvent::Motion`, `DeviceEvent::MouseWheel`, `DeviceEvent::Button` and `DeviceEvent::Key` support.
|
|
||||||
- On Web, add `EventLoopWindowTargetExtWebSys` and `PollStrategy`, which allows to set different strategies for `ControlFlow::Poll`. By default the Prioritized Task Scheduling API is used, but an option to use `Window.requestIdleCallback` is available as well. Both use `setTimeout()`, with a trick to circumvent throttling to 4ms, as a fallback.
|
|
||||||
- On Web, add `WindowBuilderExtWebSys::with_append()` to append the canvas element to the web page on creation.
|
|
||||||
- On Web, allow event loops to be recreated with `spawn`.
|
|
||||||
- On Web, enable event propagation.
|
|
||||||
- On Web, fix `ControlFlow::WaitUntil` to never wake up **before** the given time.
|
|
||||||
- On Web, fix `DeviceEvent::MouseMotion` only being emitted for each canvas instead of the whole window.
|
|
||||||
- On Web, fix `Window:::set_fullscreen` doing nothing when called outside the event loop but during transient activation.
|
|
||||||
- On Web, fix pen treated as mouse input.
|
|
||||||
- On Web, fix pointer button events not being processed when a buttons is already pressed.
|
|
||||||
- On Web, fix scale factor resize suggestion always overwriting the canvas size.
|
|
||||||
- On Web, fix some `WindowBuilder` methods doing nothing.
|
|
||||||
- On Web, fix some `Window` methods using incorrect HTML attributes instead of CSS properties.
|
|
||||||
- On Web, fix the bfcache by not using the `beforeunload` event and map bfcache loading/unloading to `Suspended`/`Resumed` events.
|
|
||||||
- On Web, fix touch input not gaining or loosing focus.
|
|
||||||
- On Web, fix touch location to be as accurate as mouse position.
|
|
||||||
- On Web, handle coalesced pointer events, which increases the resolution of pointer inputs.
|
|
||||||
- On Web, implement `Window::focus_window()`.
|
|
||||||
- On Web, implement `Window::set_(min|max)_inner_size()`.
|
|
||||||
- On Web, implement `WindowEvent::Occluded`.
|
|
||||||
- On Web, never return a `MonitorHandle`.
|
|
||||||
- On Web, prevent clicks on the canvas to select text.
|
|
||||||
- On Web, remove any fullscreen requests from the queue when an external fullscreen activation was detected.
|
|
||||||
- On Web, remove unnecessary `Window::is_dark_mode()`, which was replaced with `Window::theme()`.
|
|
||||||
- On Web, respect `EventLoopWindowTarget::listen_device_events()` settings.
|
|
||||||
- On Web, scale factor and dark mode detection are now more robust.
|
|
||||||
- On Web, send mouse position on button release as well.
|
|
||||||
- On Web, take all transient activations on the canvas and window into account to queue a fullscreen request.
|
|
||||||
- On Web, use `Window.requestAnimationFrame()` to throttle `RedrawRequested` events.
|
|
||||||
- On Web, use the correct canvas size when calculating the new size during scale factor change, instead of using the output bitmap size.
|
|
||||||
- On Web: fix `Window::request_redraw` not waking the event loop when called from outside the loop.
|
|
||||||
- On Web: fix position of touch events to be relative to the canvas.
|
|
||||||
- On Windows, add `drag_resize_window` method support.
|
|
||||||
- On Windows, add horizontal MouseWheel `DeviceEvent`.
|
|
||||||
- On Windows, added `WindowBuilderExtWindows::with_class_name` to customize the internal class name.
|
|
||||||
- On Windows, fix IME APIs not working when from non event loop thread.
|
|
||||||
- On Windows, fix `CursorEnter/Left` not being sent when grabbing the mouse.
|
|
||||||
- On Windows, fix `RedrawRequested` not being delivered when calling `Window::request_redraw` from `RedrawRequested`.
|
|
||||||
- On Windows, port to `windows-sys` version 0.48.0.
|
|
||||||
- On X11, add a `with_embedded_parent_window` function to the window builder to allow embedding a window into another window.
|
|
||||||
- On X11, fix event loop not waking up on `ControlFlow::Poll` and `ControlFlow::WaitUntil`.
|
|
||||||
- On X11, fix false positive flagging of key repeats when pressing different keys with no release between presses.
|
|
||||||
- On X11, set `visual_id` in returned `raw-window-handle`.
|
|
||||||
- On iOS, add ability to change the status bar style.
|
|
||||||
- On iOS, add force data to touch events when using the Apple Pencil.
|
|
||||||
- On iOS, always wake the event loop when transitioning from `ControlFlow::Poll` to `ControlFlow::Poll`.
|
|
||||||
- On iOS, send events `WindowEvent::Occluded(false)`, `WindowEvent::Occluded(true)` when application enters/leaves foreground.
|
|
||||||
- On macOS, add tabbing APIs on `WindowExtMacOS` and `EventLoopWindowTargetExtMacOS`.
|
|
||||||
- On macOS, fix assertion when pressing `Globe` key.
|
|
||||||
- On macOS, fix crash in `window.set_minimized(false)`.
|
|
||||||
- On macOS, fix crash when dropping `Window`.
|
|
||||||
@@ -1,249 +0,0 @@
|
|||||||
## 0.30.2
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- On Web, fix `EventLoopProxy::send_event()` triggering event loop immediately
|
|
||||||
when not called from inside the event loop. Now queues a microtask instead.
|
|
||||||
- On Web, stop overwriting default cursor with `CursorIcon::Default`.
|
|
||||||
- On Web, prevent crash when using `InnerSizeWriter::request_inner_size()`.
|
|
||||||
- On macOS, fix not working opacity for entire window.
|
|
||||||
|
|
||||||
## 0.30.1
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Reexport `raw-window-handle` versions 0.4 and 0.5 as `raw_window_handle_04` and `raw_window_handle_05`.
|
|
||||||
- Implement `ApplicationHandler` for `&mut` references and heap allocations to something that implements `ApplicationHandler`.
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- On macOS, fix panic on exit when dropping windows outside the event loop.
|
|
||||||
- On macOS, fix window dragging glitches when dragging across a monitor boundary with different scale factor.
|
|
||||||
- On macOS, fix the range in `Ime::Preedit`.
|
|
||||||
- On macOS, use the system's internal mechanisms for queuing events.
|
|
||||||
- On macOS, handle events directly instead of queuing when possible.
|
|
||||||
|
|
||||||
## 0.30.0
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add `OwnedDisplayHandle` type for allowing safe display handle usage outside of
|
|
||||||
trivial cases.
|
|
||||||
- Add `ApplicationHandler<T>` trait which mimics `Event<T>`.
|
|
||||||
- Add `WindowBuilder::with_cursor` and `Window::set_cursor` which takes a
|
|
||||||
`CursorIcon` or `CustomCursor`.
|
|
||||||
- Add `Sync` implementation for `EventLoopProxy<T: Send>`.
|
|
||||||
- Add `Window::default_attributes` to get default `WindowAttributes`.
|
|
||||||
- Add `EventLoop::builder` to get `EventLoopBuilder` without export.
|
|
||||||
- Add `CustomCursor::from_rgba` to allow creating cursor images from RGBA data.
|
|
||||||
- Add `CustomCursorExtWebSys::from_url` to allow loading cursor images from URLs.
|
|
||||||
- Add `CustomCursorExtWebSys::from_animation` to allow creating animated
|
|
||||||
cursors from other `CustomCursor`s.
|
|
||||||
- Add `{Active,}EventLoop::create_custom_cursor` to load custom cursor image sources.
|
|
||||||
- Add `ActiveEventLoop::create_window` and `EventLoop::create_window`.
|
|
||||||
- Add `CustomCursor` which could be set via `Window::set_cursor`, implemented on
|
|
||||||
Windows, macOS, X11, Wayland, and Web.
|
|
||||||
- On Web, add to toggle calling `Event.preventDefault()` on `Window`.
|
|
||||||
- On iOS, add `PinchGesture`, `DoubleTapGesture`, `PanGesture` and `RotationGesture`.
|
|
||||||
- on iOS, use `UIGestureRecognizerDelegate` for fine grained control of gesture recognizers.
|
|
||||||
- On macOS, add services menu.
|
|
||||||
- On Windows, add `with_title_text_color`, and `with_corner_preference` on
|
|
||||||
`WindowAttributesExtWindows`.
|
|
||||||
- On Windows, implement resize increments.
|
|
||||||
- On Windows, add `AnyThread` API to access window handle off the main thread.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Bump MSRV from `1.65` to `1.70`.
|
|
||||||
- On Wayland, bump `sctk-adwaita` to `0.9.0`, which changed system library
|
|
||||||
crates. This change is a **cascading breaking change**, you must do breaking
|
|
||||||
change as well, even if you don't expose winit.
|
|
||||||
- Rename `TouchpadMagnify` to `PinchGesture`.
|
|
||||||
- Rename `SmartMagnify` to `DoubleTapGesture`.
|
|
||||||
- Rename `TouchpadRotate` to `RotationGesture`.
|
|
||||||
- Rename `EventLoopWindowTarget` to `ActiveEventLoop`.
|
|
||||||
- Rename `platform::x11::XWindowType` to `platform::x11::WindowType`.
|
|
||||||
- Rename `VideoMode` to `VideoModeHandle` to represent that it doesn't hold
|
|
||||||
static data.
|
|
||||||
- Make `Debug` formatting of `WindowId` more concise.
|
|
||||||
- Move `dpi` types to its own crate, and re-export it from the root crate.
|
|
||||||
- Replace `log` with `tracing`, use `log` feature on `tracing` to restore old
|
|
||||||
behavior.
|
|
||||||
- `EventLoop::with_user_event` now returns `EventLoopBuilder`.
|
|
||||||
- On Web, return `HandleError::Unavailable` when a window handle is not available.
|
|
||||||
- On Web, return `RawWindowHandle::WebCanvas` instead of `RawWindowHandle::Web`.
|
|
||||||
- On Web, remove queuing fullscreen request in absence of transient activation.
|
|
||||||
- On iOS, return `HandleError::Unavailable` when a window handle is not available.
|
|
||||||
- On macOS, return `HandleError::Unavailable` when a window handle is not available.
|
|
||||||
- On Windows, remove `WS_CAPTION`, `WS_BORDER`, and `WS_EX_WINDOWEDGE` styles
|
|
||||||
for child windows without decorations.
|
|
||||||
- On Android, bump `ndk` to `0.9.0` and `android-activity` to `0.6.0`,
|
|
||||||
and remove unused direct dependency on `ndk-sys`.
|
|
||||||
|
|
||||||
### Deprecated
|
|
||||||
|
|
||||||
- Deprecate `EventLoop::run`, use `EventLoop::run_app`.
|
|
||||||
- Deprecate `EventLoopExtRunOnDemand::run_on_demand`, use `EventLoop::run_app_on_demand`.
|
|
||||||
- Deprecate `EventLoopExtPumpEvents::pump_events`, use `EventLoopExtPumpEvents::pump_app_events`.
|
|
||||||
|
|
||||||
The new `app` APIs accept a newly added `ApplicationHandler<T>` instead of
|
|
||||||
`Fn`. The semantics are mostly the same, given that the capture list of the
|
|
||||||
closure is your new `State`. Consider the following code:
|
|
||||||
|
|
||||||
```rust,no_run
|
|
||||||
use winit::event::Event;
|
|
||||||
use winit::event_loop::EventLoop;
|
|
||||||
use winit::window::Window;
|
|
||||||
|
|
||||||
struct MyUserEvent;
|
|
||||||
|
|
||||||
let event_loop = EventLoop::<MyUserEvent>::with_user_event().build().unwrap();
|
|
||||||
let window = event_loop.create_window(Window::default_attributes()).unwrap();
|
|
||||||
let mut counter = 0;
|
|
||||||
|
|
||||||
let _ = event_loop.run(move |event, event_loop| {
|
|
||||||
match event {
|
|
||||||
Event::AboutToWait => {
|
|
||||||
window.request_redraw();
|
|
||||||
counter += 1;
|
|
||||||
}
|
|
||||||
Event::WindowEvent { window_id, event } => {
|
|
||||||
// Handle window event.
|
|
||||||
}
|
|
||||||
Event::UserEvent(event) => {
|
|
||||||
// Handle user event.
|
|
||||||
}
|
|
||||||
Event::DeviceEvent { device_id, event } => {
|
|
||||||
// Handle device event.
|
|
||||||
}
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
To migrate this code, you should move all the captured values into some
|
|
||||||
newtype `State` and implement `ApplicationHandler` for this type. Finally,
|
|
||||||
we move particular `match event` arms into methods on `ApplicationHandler`,
|
|
||||||
for example:
|
|
||||||
|
|
||||||
```rust,no_run
|
|
||||||
use winit::application::ApplicationHandler;
|
|
||||||
use winit::event::{Event, WindowEvent, DeviceEvent, DeviceId};
|
|
||||||
use winit::event_loop::{EventLoop, ActiveEventLoop};
|
|
||||||
use winit::window::{Window, WindowId};
|
|
||||||
|
|
||||||
struct MyUserEvent;
|
|
||||||
|
|
||||||
struct State {
|
|
||||||
window: Window,
|
|
||||||
counter: i32,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ApplicationHandler<MyUserEvent> for State {
|
|
||||||
fn user_event(&mut self, event_loop: &ActiveEventLoop, user_event: MyUserEvent) {
|
|
||||||
// Handle user event.
|
|
||||||
}
|
|
||||||
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
// Your application got resumed.
|
|
||||||
}
|
|
||||||
|
|
||||||
fn window_event(&mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent) {
|
|
||||||
// Handle window event.
|
|
||||||
}
|
|
||||||
|
|
||||||
fn device_event(&mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent) {
|
|
||||||
// Handle device event.
|
|
||||||
}
|
|
||||||
|
|
||||||
fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
self.window.request_redraw();
|
|
||||||
self.counter += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let event_loop = EventLoop::<MyUserEvent>::with_user_event().build().unwrap();
|
|
||||||
#[allow(deprecated)]
|
|
||||||
let window = event_loop.create_window(Window::default_attributes()).unwrap();
|
|
||||||
let mut state = State { window, counter: 0 };
|
|
||||||
|
|
||||||
let _ = event_loop.run_app(&mut state);
|
|
||||||
```
|
|
||||||
|
|
||||||
Please submit your feedback after migrating in [this issue](https://github.com/rust-windowing/winit/issues/3626).
|
|
||||||
|
|
||||||
- Deprecate `Window::set_cursor_icon`, use `Window::set_cursor`.
|
|
||||||
|
|
||||||
### Removed
|
|
||||||
|
|
||||||
- Remove `Window::new`, use `ActiveEventLoop::create_window` instead.
|
|
||||||
|
|
||||||
You now have to create your windows inside the actively running event loop
|
|
||||||
(usually the `new_events(cause: StartCause::Init)` or `resumed()` events),
|
|
||||||
and can no longer do it before the application has properly launched.
|
|
||||||
This change is done to fix many long-standing issues on iOS and macOS, and
|
|
||||||
will improve things on Wayland once fully implemented.
|
|
||||||
|
|
||||||
To ease migration, we provide the deprecated `EventLoop::create_window` that
|
|
||||||
will allow you to bypass this restriction in this release.
|
|
||||||
|
|
||||||
Using the migration example from above, you can change your code as follows:
|
|
||||||
|
|
||||||
```rust,no_run
|
|
||||||
use winit::application::ApplicationHandler;
|
|
||||||
use winit::event::{Event, WindowEvent, DeviceEvent, DeviceId};
|
|
||||||
use winit::event_loop::{EventLoop, ActiveEventLoop};
|
|
||||||
use winit::window::{Window, WindowId};
|
|
||||||
|
|
||||||
#[derive(Default)]
|
|
||||||
struct State {
|
|
||||||
// Use an `Option` to allow the window to not be available until the
|
|
||||||
// application is properly running.
|
|
||||||
window: Option<Window>,
|
|
||||||
counter: i32,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ApplicationHandler for State {
|
|
||||||
// This is a common indicator that you can create a window.
|
|
||||||
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
self.window = Some(event_loop.create_window(Window::default_attributes()).unwrap());
|
|
||||||
}
|
|
||||||
fn window_event(&mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent) {
|
|
||||||
// `unwrap` is fine, the window will always be available when
|
|
||||||
// receiving a window event.
|
|
||||||
let window = self.window.as_ref().unwrap();
|
|
||||||
// Handle window event.
|
|
||||||
}
|
|
||||||
fn device_event(&mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent) {
|
|
||||||
// Handle window event.
|
|
||||||
}
|
|
||||||
fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
if let Some(window) = self.window.as_ref() {
|
|
||||||
window.request_redraw();
|
|
||||||
self.counter += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let event_loop = EventLoop::new().unwrap();
|
|
||||||
let mut state = State::default();
|
|
||||||
let _ = event_loop.run_app(&mut state);
|
|
||||||
```
|
|
||||||
|
|
||||||
- Remove `Deref` implementation for `EventLoop` that gave `EventLoopWindowTarget`.
|
|
||||||
- Remove `WindowBuilder` in favor of `WindowAttributes`.
|
|
||||||
- Remove Generic parameter `T` from `ActiveEventLoop`.
|
|
||||||
- Remove `EventLoopBuilder::with_user_event`, use `EventLoop::with_user_event`.
|
|
||||||
- Remove Redundant `EventLoopError::AlreadyRunning`.
|
|
||||||
- Remove `WindowAttributes::fullscreen` and expose as field directly.
|
|
||||||
- On X11, remove `platform::x11::XNotSupported` export.
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- On Web, fix setting cursor icon overriding cursor visibility.
|
|
||||||
- On Windows, fix cursor not confined to center of window when grabbed and hidden.
|
|
||||||
- On macOS, fix sequence of mouse events being out of order when dragging on the trackpad.
|
|
||||||
- On Wayland, fix decoration glitch on close with some compositors.
|
|
||||||
- On Android, fix a regression introduced in #2748 to allow volume key events to be received again.
|
|
||||||
- On Windows, don't return a valid window handle outside of the GUI thread.
|
|
||||||
- On macOS, don't set the background color when initializing a window with transparency.
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
## 0.8.3
|
|
||||||
|
|
||||||
- Fixed issue of calls to `set_inner_size` blocking on Windows.
|
|
||||||
- Mapped `ISO_Left_Tab` to `VirtualKeyCode::Tab` to make the key work with modifiers
|
|
||||||
- Fixed the X11 backed on 32bit targets
|
|
||||||
|
|
||||||
## 0.8.2
|
|
||||||
|
|
||||||
- Uniformize keyboard scancode values across Wayland and X11 (#297).
|
|
||||||
- Internal rework of the wayland event loop
|
|
||||||
- Added method `os::linux::WindowExt::is_ready`
|
|
||||||
|
|
||||||
## 0.8.1
|
|
||||||
|
|
||||||
- Added various methods to `os::linux::EventsLoopExt`, plus some hidden items necessary to make
|
|
||||||
glutin work.
|
|
||||||
|
|
||||||
## 0.8.0
|
|
||||||
|
|
||||||
- Added `Window::set_maximized`, `WindowAttributes::maximized` and `WindowBuilder::with_maximized`.
|
|
||||||
- Added `Window::set_fullscreen`.
|
|
||||||
- Changed `with_fullscreen` to take a `Option<MonitorId>` instead of a `MonitorId`.
|
|
||||||
- Removed `MonitorId::get_native_identifier()` in favor of platform-specific traits in the `os`
|
|
||||||
module.
|
|
||||||
- Changed `get_available_monitors()` and `get_primary_monitor()` to be methods of `EventsLoop`
|
|
||||||
instead of stand-alone methods.
|
|
||||||
- Changed `EventsLoop` to be tied to a specific X11 or Wayland connection.
|
|
||||||
- Added a `os::linux::EventsLoopExt` trait that makes it possible to configure the connection.
|
|
||||||
- Fixed the emscripten code, which now compiles.
|
|
||||||
- Changed the X11 fullscreen code to use `xrandr` instead of `xxf86vm`.
|
|
||||||
- Fixed the Wayland backend to produce `Refresh` event after window creation.
|
|
||||||
- Changed the `Suspended` event to be outside of `WindowEvent`.
|
|
||||||
- Fixed the X11 backend sometimes reporting the wrong virtual key (#273).
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
## 0.9.0
|
|
||||||
|
|
||||||
- Added event `WindowEvent::HiDPIFactorChanged`.
|
|
||||||
- Added method `MonitorId::get_hidpi_factor`.
|
|
||||||
- Deprecated `get_inner_size_pixels` and `get_inner_size_points` methods of `Window` in favor of
|
|
||||||
`get_inner_size`.
|
|
||||||
- **Breaking:** `EventsLoop` is `!Send` and `!Sync` because of platform-dependant constraints,
|
|
||||||
but `Window`, `WindowId`, `DeviceId` and `MonitorId` guaranteed to be `Send`.
|
|
||||||
- `MonitorId::get_position` now returns `(i32, i32)` instead of `(u32, u32)`.
|
|
||||||
- Rewrite of the wayland backend to use wayland-client-0.11
|
|
||||||
- Support for dead keys on wayland for keyboard utf8 input
|
|
||||||
- Monitor enumeration on Windows is now implemented using `EnumDisplayMonitors` instead of
|
|
||||||
`EnumDisplayDevices`. This changes the value returned by `MonitorId::get_name()`.
|
|
||||||
- On Windows added `MonitorIdExt::hmonitor` method
|
|
||||||
- Impl `Clone` for `EventsLoopProxy`
|
|
||||||
- `EventsLoop::get_primary_monitor()` on X11 will fallback to any available monitor if no primary is found
|
|
||||||
- Support for touch event on wayland
|
|
||||||
- `WindowEvent`s `MouseMoved`, `MouseEntered`, and `MouseLeft` have been renamed to
|
|
||||||
`CursorMoved`, `CursorEntered`, and `CursorLeft`.
|
|
||||||
- New `DeviceEvent`s added, `MouseMotion` and `MouseWheel`.
|
|
||||||
- Send `CursorMoved` event after `CursorEntered` and `Focused` events.
|
|
||||||
- Add support for `ModifiersState`, `MouseMove`, `MouseInput`, `MouseMotion` for emscripten backend.
|
|
||||||
207
src/lib.rs
207
src/lib.rs
@@ -1,207 +0,0 @@
|
|||||||
//! Winit is a cross-platform window creation and event loop management library.
|
|
||||||
//!
|
|
||||||
//! # Building windows
|
|
||||||
//!
|
|
||||||
//! Before you can create a [`Window`], you first need to build an [`EventLoop`]. This is done with
|
|
||||||
//! the [`EventLoop::new()`] function.
|
|
||||||
//!
|
|
||||||
//! ```no_run
|
|
||||||
//! use winit::event_loop::EventLoop;
|
|
||||||
//! let event_loop = EventLoop::new().unwrap();
|
|
||||||
//! ```
|
|
||||||
//!
|
|
||||||
//! Then you create a [`Window`] with [`create_window`].
|
|
||||||
//!
|
|
||||||
//! # Event handling
|
|
||||||
//!
|
|
||||||
//! Once a [`Window`] has been created, it will generate different *events*. A [`Window`] object can
|
|
||||||
//! generate [`WindowEvent`]s when certain input events occur, such as a cursor moving over the
|
|
||||||
//! window or a key getting pressed while the window is focused. Devices can generate
|
|
||||||
//! [`DeviceEvent`]s, which contain unfiltered event data that isn't specific to a certain window.
|
|
||||||
//! Some user activity, like mouse movement, can generate both a [`WindowEvent`] *and* a
|
|
||||||
//! [`DeviceEvent`]. You can also create and handle your own custom [`Event::UserEvent`]s, if
|
|
||||||
//! desired.
|
|
||||||
//!
|
|
||||||
//! You can retrieve events by calling [`EventLoop::run_app()`]. This function will
|
|
||||||
//! dispatch events for every [`Window`] that was created with that particular [`EventLoop`], and
|
|
||||||
//! will run until [`exit()`] is used, at which point [`Event::LoopExiting`].
|
|
||||||
//!
|
|
||||||
//! Winit no longer uses a `EventLoop::poll_events() -> impl Iterator<Event>`-based event loop
|
|
||||||
//! model, since that can't be implemented properly on some platforms (e.g web, iOS) and works
|
|
||||||
//! poorly on most other platforms. However, this model can be re-implemented to an extent with
|
|
||||||
#![cfg_attr(
|
|
||||||
any(windows_platform, macos_platform, android_platform, x11_platform, wayland_platform),
|
|
||||||
doc = "[`EventLoopExtPumpEvents::pump_app_events()`][platform::pump_events::EventLoopExtPumpEvents::pump_app_events()]"
|
|
||||||
)]
|
|
||||||
#![cfg_attr(
|
|
||||||
not(any(windows_platform, macos_platform, android_platform, x11_platform, wayland_platform)),
|
|
||||||
doc = "`EventLoopExtPumpEvents::pump_app_events()`"
|
|
||||||
)]
|
|
||||||
//! [^1]. See that method's documentation for more reasons about why
|
|
||||||
//! it's discouraged beyond compatibility reasons.
|
|
||||||
//!
|
|
||||||
//!
|
|
||||||
//! ```no_run
|
|
||||||
//! use winit::application::ApplicationHandler;
|
|
||||||
//! use winit::event::WindowEvent;
|
|
||||||
//! use winit::event_loop::{ActiveEventLoop, ControlFlow, EventLoop};
|
|
||||||
//! use winit::window::{Window, WindowId};
|
|
||||||
//!
|
|
||||||
//! #[derive(Default)]
|
|
||||||
//! struct App {
|
|
||||||
//! window: Option<Window>,
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! impl ApplicationHandler for App {
|
|
||||||
//! fn resumed(&mut self, event_loop: &ActiveEventLoop) {
|
|
||||||
//! self.window = Some(event_loop.create_window(Window::default_attributes()).unwrap());
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! fn window_event(&mut self, event_loop: &ActiveEventLoop, id: WindowId, event: WindowEvent) {
|
|
||||||
//! match event {
|
|
||||||
//! WindowEvent::CloseRequested => {
|
|
||||||
//! println!("The close button was pressed; stopping");
|
|
||||||
//! event_loop.exit();
|
|
||||||
//! },
|
|
||||||
//! WindowEvent::RedrawRequested => {
|
|
||||||
//! // Redraw the application.
|
|
||||||
//! //
|
|
||||||
//! // It's preferable for applications that do not render continuously to render in
|
|
||||||
//! // this event rather than in AboutToWait, since rendering in here allows
|
|
||||||
//! // the program to gracefully handle redraws requested by the OS.
|
|
||||||
//!
|
|
||||||
//! // Draw.
|
|
||||||
//!
|
|
||||||
//! // Queue a RedrawRequested event.
|
|
||||||
//! //
|
|
||||||
//! // You only need to call this if you've determined that you need to redraw in
|
|
||||||
//! // applications which do not always need to. Applications that redraw continuously
|
|
||||||
//! // can render here instead.
|
|
||||||
//! self.window.as_ref().unwrap().request_redraw();
|
|
||||||
//! }
|
|
||||||
//! _ => (),
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! let event_loop = EventLoop::new().unwrap();
|
|
||||||
//!
|
|
||||||
//! // ControlFlow::Poll continuously runs the event loop, even if the OS hasn't
|
|
||||||
//! // dispatched any events. This is ideal for games and similar applications.
|
|
||||||
//! event_loop.set_control_flow(ControlFlow::Poll);
|
|
||||||
//!
|
|
||||||
//! // ControlFlow::Wait pauses the event loop if no events are available to process.
|
|
||||||
//! // This is ideal for non-game applications that only update in response to user
|
|
||||||
//! // input, and uses significantly less power/CPU time than ControlFlow::Poll.
|
|
||||||
//! event_loop.set_control_flow(ControlFlow::Wait);
|
|
||||||
//!
|
|
||||||
//! let mut app = App::default();
|
|
||||||
//! event_loop.run_app(&mut app);
|
|
||||||
//! ```
|
|
||||||
//!
|
|
||||||
//! [`WindowEvent`] has a [`WindowId`] member. In multi-window environments, it should be
|
|
||||||
//! compared to the value returned by [`Window::id()`] to determine which [`Window`]
|
|
||||||
//! dispatched the event.
|
|
||||||
//!
|
|
||||||
//! # Drawing on the window
|
|
||||||
//!
|
|
||||||
//! Winit doesn't directly provide any methods for drawing on a [`Window`]. However, it allows you
|
|
||||||
//! to retrieve the raw handle of the window and display (see the [`platform`] module and/or the
|
|
||||||
//! [`raw_window_handle`] and [`raw_display_handle`] methods), which in turn allows
|
|
||||||
//! you to create an OpenGL/Vulkan/DirectX/Metal/etc. context that can be used to render graphics.
|
|
||||||
//!
|
|
||||||
//! Note that many platforms will display garbage data in the window's client area if the
|
|
||||||
//! application doesn't render anything to the window by the time the desktop compositor is ready to
|
|
||||||
//! display the window to the user. If you notice this happening, you should create the window with
|
|
||||||
//! [`visible` set to `false`][crate::window::WindowAttributes::with_visible] and explicitly make
|
|
||||||
//! the window visible only once you're ready to render into it.
|
|
||||||
//!
|
|
||||||
//! # UI scaling
|
|
||||||
//!
|
|
||||||
//! UI scaling is important, go read the docs for the [`dpi`] crate for an
|
|
||||||
//! introduction.
|
|
||||||
//!
|
|
||||||
//! All of Winit's functions return physical types, but can take either logical or physical
|
|
||||||
//! coordinates as input, allowing you to use the most convenient coordinate system for your
|
|
||||||
//! particular application.
|
|
||||||
//!
|
|
||||||
//! Winit will dispatch a [`ScaleFactorChanged`] event whenever a window's scale factor has changed.
|
|
||||||
//! This can happen if the user drags their window from a standard-resolution monitor to a high-DPI
|
|
||||||
//! monitor or if the user changes their DPI settings. This allows you to rescale your application's
|
|
||||||
//! UI elements and adjust how the platform changes the window's size to reflect the new scale
|
|
||||||
//! factor. If a window hasn't received a [`ScaleFactorChanged`] event, its scale factor
|
|
||||||
//! can be found by calling [`window.scale_factor()`].
|
|
||||||
//!
|
|
||||||
//! [`ScaleFactorChanged`]: event::WindowEvent::ScaleFactorChanged
|
|
||||||
//! [`window.scale_factor()`]: window::Window::scale_factor
|
|
||||||
//!
|
|
||||||
//! # Cargo Features
|
|
||||||
//!
|
|
||||||
//! Winit provides the following Cargo features:
|
|
||||||
//!
|
|
||||||
//! * `x11` (enabled by default): On Unix platforms, enables the X11 backend.
|
|
||||||
//! * `wayland` (enabled by default): On Unix platforms, enables the Wayland backend.
|
|
||||||
//! * `rwh_04`: Implement `raw-window-handle v0.4` traits.
|
|
||||||
//! * `rwh_05`: Implement `raw-window-handle v0.5` traits.
|
|
||||||
//! * `rwh_06`: Implement `raw-window-handle v0.6` traits.
|
|
||||||
//! * `serde`: Enables serialization/deserialization of certain types with [Serde](https://crates.io/crates/serde).
|
|
||||||
//! * `mint`: Enables mint (math interoperability standard types) conversions.
|
|
||||||
//!
|
|
||||||
//! See the [`platform`] module for documentation on platform-specific cargo
|
|
||||||
//! features.
|
|
||||||
//!
|
|
||||||
//! [`EventLoop`]: event_loop::EventLoop
|
|
||||||
//! [`EventLoop::new()`]: event_loop::EventLoop::new
|
|
||||||
//! [`EventLoop::run_app()`]: event_loop::EventLoop::run_app
|
|
||||||
//! [`exit()`]: event_loop::ActiveEventLoop::exit
|
|
||||||
//! [`Window`]: window::Window
|
|
||||||
//! [`WindowId`]: window::WindowId
|
|
||||||
//! [`WindowAttributes`]: window::WindowAttributes
|
|
||||||
//! [window_new]: window::Window::new
|
|
||||||
//! [`create_window`]: event_loop::ActiveEventLoop::create_window
|
|
||||||
//! [`Window::id()`]: window::Window::id
|
|
||||||
//! [`WindowEvent`]: event::WindowEvent
|
|
||||||
//! [`DeviceEvent`]: event::DeviceEvent
|
|
||||||
//! [`Event::UserEvent`]: event::Event::UserEvent
|
|
||||||
//! [`Event::LoopExiting`]: event::Event::LoopExiting
|
|
||||||
//! [`raw_window_handle`]: ./window/struct.Window.html#method.raw_window_handle
|
|
||||||
//! [`raw_display_handle`]: ./window/struct.Window.html#method.raw_display_handle
|
|
||||||
//! [^1]: `EventLoopExtPumpEvents::pump_app_events()` is only available on Windows, macOS, Android, X11 and Wayland.
|
|
||||||
|
|
||||||
#![deny(rust_2018_idioms)]
|
|
||||||
#![deny(rustdoc::broken_intra_doc_links)]
|
|
||||||
#![deny(clippy::all)]
|
|
||||||
#![deny(unsafe_op_in_unsafe_fn)]
|
|
||||||
#![cfg_attr(clippy, deny(warnings))]
|
|
||||||
// Doc feature labels can be tested locally by running RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly
|
|
||||||
// doc
|
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg_hide), doc(cfg_hide(doc, docsrs)))]
|
|
||||||
#![allow(clippy::missing_safety_doc)]
|
|
||||||
|
|
||||||
#[cfg(feature = "rwh_04")]
|
|
||||||
pub use rwh_04 as raw_window_handle_04;
|
|
||||||
#[cfg(feature = "rwh_05")]
|
|
||||||
pub use rwh_05 as raw_window_handle_05;
|
|
||||||
#[cfg(feature = "rwh_06")]
|
|
||||||
pub use rwh_06 as raw_window_handle;
|
|
||||||
|
|
||||||
// Re-export DPI types so that users don't have to put it in Cargo.toml.
|
|
||||||
#[doc(inline)]
|
|
||||||
pub use dpi;
|
|
||||||
|
|
||||||
pub mod application;
|
|
||||||
#[cfg(any(doc, doctest, test))]
|
|
||||||
pub mod changelog;
|
|
||||||
#[macro_use]
|
|
||||||
pub mod error;
|
|
||||||
mod cursor;
|
|
||||||
pub mod event;
|
|
||||||
pub mod event_loop;
|
|
||||||
mod icon;
|
|
||||||
pub mod keyboard;
|
|
||||||
pub mod monitor;
|
|
||||||
mod platform_impl;
|
|
||||||
mod utils;
|
|
||||||
pub mod window;
|
|
||||||
|
|
||||||
pub mod platform;
|
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
//! # Android
|
|
||||||
//!
|
|
||||||
//! The Android backend builds on (and exposes types from) the [`ndk`](https://docs.rs/ndk/) crate.
|
|
||||||
//!
|
|
||||||
//! Native Android applications need some form of "glue" crate that is responsible
|
|
||||||
//! for defining the main entry point for your Rust application as well as tracking
|
|
||||||
//! various life-cycle events and synchronizing with the main JVM thread.
|
|
||||||
//!
|
|
||||||
//! Winit uses the [android-activity](https://docs.rs/android-activity/) as a
|
|
||||||
//! glue crate (prior to `0.28` it used
|
|
||||||
//! [ndk-glue](https://github.com/rust-windowing/android-ndk-rs/tree/master/ndk-glue)).
|
|
||||||
//!
|
|
||||||
//! The version of the glue crate that your application depends on _must_ match the
|
|
||||||
//! version that Winit depends on because the glue crate is responsible for your
|
|
||||||
//! application's main entry point. If Cargo resolves multiple versions, they will
|
|
||||||
//! clash.
|
|
||||||
//!
|
|
||||||
//! `winit` glue compatibility table:
|
|
||||||
//!
|
|
||||||
//! | winit | ndk-glue |
|
|
||||||
//! | :---: | :--------------------------: |
|
|
||||||
//! | 0.30 | `android-activity = "0.6"` |
|
|
||||||
//! | 0.29 | `android-activity = "0.5"` |
|
|
||||||
//! | 0.28 | `android-activity = "0.4"` |
|
|
||||||
//! | 0.27 | `ndk-glue = "0.7"` |
|
|
||||||
//! | 0.26 | `ndk-glue = "0.5"` |
|
|
||||||
//! | 0.25 | `ndk-glue = "0.3"` |
|
|
||||||
//! | 0.24 | `ndk-glue = "0.2"` |
|
|
||||||
//!
|
|
||||||
//! The recommended way to avoid a conflict with the glue version is to avoid explicitly
|
|
||||||
//! depending on the `android-activity` crate, and instead consume the API that
|
|
||||||
//! is re-exported by Winit under `winit::platform::android::activity::*`
|
|
||||||
//!
|
|
||||||
//! Running on an Android device needs a dynamic system library. Add this to Cargo.toml:
|
|
||||||
//!
|
|
||||||
//! ```toml
|
|
||||||
//! [lib]
|
|
||||||
//! name = "main"
|
|
||||||
//! crate-type = ["cdylib"]
|
|
||||||
//! ```
|
|
||||||
//!
|
|
||||||
//! All Android applications are based on an `Activity` subclass, and the
|
|
||||||
//! `android-activity` crate is designed to support different choices for this base
|
|
||||||
//! class. Your application _must_ specify the base class it needs via a feature flag:
|
|
||||||
//!
|
|
||||||
//! | Base Class | Feature Flag | Notes |
|
|
||||||
//! | :--------------: | :---------------: | :-----: |
|
|
||||||
//! | `NativeActivity` | `android-native-activity` | Built-in to Android - it is possible to use without compiling any Java or Kotlin code. Java or Kotlin code may be needed to subclass `NativeActivity` to access some platform features. It does not derive from the [`AndroidAppCompat`] base class.|
|
|
||||||
//! | [`GameActivity`] | `android-game-activity` | Derives from [`AndroidAppCompat`], a defacto standard `Activity` base class that helps support a wider range of Android versions. Requires a build system that can compile Java or Kotlin and fetch Android dependencies from a [Maven repository][agdk_jetpack] (or link with an embedded [release][agdk_releases] of [`GameActivity`]) |
|
|
||||||
//!
|
|
||||||
//! [`GameActivity`]: https://developer.android.com/games/agdk/game-activity
|
|
||||||
//! [`GameTextInput`]: https://developer.android.com/games/agdk/add-support-for-text-input
|
|
||||||
//! [`AndroidAppCompat`]: https://developer.android.com/reference/androidx/appcompat/app/AppCompatActivity
|
|
||||||
//! [agdk_jetpack]: https://developer.android.com/jetpack/androidx/releases/games
|
|
||||||
//! [agdk_releases]: https://developer.android.com/games/agdk/download#agdk-libraries
|
|
||||||
//! [Gradle]: https://developer.android.com/studio/build
|
|
||||||
//!
|
|
||||||
//! For more details, refer to these `android-activity` [example applications](https://github.com/rust-mobile/android-activity/tree/main/examples).
|
|
||||||
//!
|
|
||||||
//! ## Converting from `ndk-glue` to `android-activity`
|
|
||||||
//!
|
|
||||||
//! If your application is currently based on `NativeActivity` via the `ndk-glue` crate and building
|
|
||||||
//! with `cargo apk`, then the minimal changes would be:
|
|
||||||
//! 1. Remove `ndk-glue` from your `Cargo.toml`
|
|
||||||
//! 2. Enable the `"android-native-activity"` feature for Winit: `winit = { version = "0.30.2",
|
|
||||||
//! features = [ "android-native-activity" ] }`
|
|
||||||
//! 3. Add an `android_main` entrypoint (as above), instead of using the '`[ndk_glue::main]` proc
|
|
||||||
//! macro from `ndk-macros` (optionally add a dependency on `android_logger` and initialize
|
|
||||||
//! logging as above).
|
|
||||||
//! 4. Pass a clone of the `AndroidApp` that your application receives to Winit when building your
|
|
||||||
//! event loop (as shown above).
|
|
||||||
|
|
||||||
use crate::event_loop::{ActiveEventLoop, EventLoop, EventLoopBuilder};
|
|
||||||
use crate::window::{Window, WindowAttributes};
|
|
||||||
|
|
||||||
use self::activity::{AndroidApp, ConfigurationRef, Rect};
|
|
||||||
|
|
||||||
/// Additional methods on [`EventLoop`] that are specific to Android.
|
|
||||||
pub trait EventLoopExtAndroid {}
|
|
||||||
|
|
||||||
impl<T> EventLoopExtAndroid for EventLoop<T> {}
|
|
||||||
|
|
||||||
/// Additional methods on [`ActiveEventLoop`] that are specific to Android.
|
|
||||||
pub trait ActiveEventLoopExtAndroid {}
|
|
||||||
|
|
||||||
/// Additional methods on [`Window`] that are specific to Android.
|
|
||||||
pub trait WindowExtAndroid {
|
|
||||||
fn content_rect(&self) -> Rect;
|
|
||||||
|
|
||||||
fn config(&self) -> ConfigurationRef;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WindowExtAndroid for Window {
|
|
||||||
fn content_rect(&self) -> Rect {
|
|
||||||
self.window.content_rect()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn config(&self) -> ConfigurationRef {
|
|
||||||
self.window.config()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ActiveEventLoopExtAndroid for ActiveEventLoop {}
|
|
||||||
|
|
||||||
/// Additional methods on [`WindowAttributes`] that are specific to Android.
|
|
||||||
pub trait WindowAttributesExtAndroid {}
|
|
||||||
|
|
||||||
impl WindowAttributesExtAndroid for WindowAttributes {}
|
|
||||||
|
|
||||||
pub trait EventLoopBuilderExtAndroid {
|
|
||||||
/// Associates the `AndroidApp` that was passed to `android_main()` with the event loop
|
|
||||||
///
|
|
||||||
/// This must be called on Android since the `AndroidApp` is not global state.
|
|
||||||
fn with_android_app(&mut self, app: AndroidApp) -> &mut Self;
|
|
||||||
|
|
||||||
/// Calling this will mark the volume keys to be manually handled by the application
|
|
||||||
///
|
|
||||||
/// Default is to let the operating system handle the volume keys
|
|
||||||
fn handle_volume_keys(&mut self) -> &mut Self;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> EventLoopBuilderExtAndroid for EventLoopBuilder<T> {
|
|
||||||
fn with_android_app(&mut self, app: AndroidApp) -> &mut Self {
|
|
||||||
self.platform_specific.android_app = Some(app);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn handle_volume_keys(&mut self) -> &mut Self {
|
|
||||||
self.platform_specific.ignore_volume_keys = false;
|
|
||||||
self
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Re-export of the `android_activity` API
|
|
||||||
///
|
|
||||||
/// Winit re-exports the `android_activity` API for convenience so that most
|
|
||||||
/// applications can rely on the Winit crate to resolve the required version of
|
|
||||||
/// `android_activity` and avoid any chance of a conflict between Winit and the
|
|
||||||
/// application crate.
|
|
||||||
///
|
|
||||||
/// Unlike most libraries there can only be a single implementation
|
|
||||||
/// of the `android_activity` glue crate linked with an application because
|
|
||||||
/// it is responsible for the application's `android_main()` entry point.
|
|
||||||
///
|
|
||||||
/// Since Winit depends on a specific version of `android_activity` the simplest
|
|
||||||
/// way to avoid creating a conflict is for applications to avoid explicitly
|
|
||||||
/// depending on the `android_activity` crate, and instead consume the API that
|
|
||||||
/// is re-exported by Winit.
|
|
||||||
///
|
|
||||||
/// For compatibility applications should then import the `AndroidApp` type for
|
|
||||||
/// their `android_main(app: AndroidApp)` function like:
|
|
||||||
/// ```rust
|
|
||||||
/// #[cfg(target_os = "android")]
|
|
||||||
/// use winit::platform::android::activity::AndroidApp;
|
|
||||||
/// ```
|
|
||||||
pub mod activity {
|
|
||||||
// We enable the `"native-activity"` feature just so that we can build the
|
|
||||||
// docs, but it'll be very confusing for users to see the docs with that
|
|
||||||
// feature enabled, so we avoid inlining it so that they're forced to view
|
|
||||||
// it on the crate's own docs.rs page.
|
|
||||||
#[doc(no_inline)]
|
|
||||||
#[cfg(android_platform)]
|
|
||||||
pub use android_activity::*;
|
|
||||||
|
|
||||||
#[cfg(not(android_platform))]
|
|
||||||
#[doc(hidden)]
|
|
||||||
pub struct Rect;
|
|
||||||
#[cfg(not(android_platform))]
|
|
||||||
#[doc(hidden)]
|
|
||||||
pub struct ConfigurationRef;
|
|
||||||
#[cfg(not(android_platform))]
|
|
||||||
#[doc(hidden)]
|
|
||||||
pub struct AndroidApp;
|
|
||||||
}
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
//! # Orbital / Redox OS
|
|
||||||
//!
|
|
||||||
//! Redox OS has some functionality not yet present that will be implemented
|
|
||||||
//! when its orbital display server provides it.
|
|
||||||
|
|
||||||
// There are no Orbital specific traits yet.
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
use objc2::{declare_class, mutability, ClassType, DeclaredClass};
|
|
||||||
use objc2_foundation::{MainThreadMarker, NSObject};
|
|
||||||
use objc2_ui_kit::UIApplication;
|
|
||||||
|
|
||||||
use super::app_state::{self, send_occluded_event_for_all_windows, EventWrapper};
|
|
||||||
use crate::event::Event;
|
|
||||||
|
|
||||||
declare_class!(
|
|
||||||
pub struct AppDelegate;
|
|
||||||
|
|
||||||
unsafe impl ClassType for AppDelegate {
|
|
||||||
type Super = NSObject;
|
|
||||||
type Mutability = mutability::InteriorMutable;
|
|
||||||
const NAME: &'static str = "WinitApplicationDelegate";
|
|
||||||
}
|
|
||||||
|
|
||||||
impl DeclaredClass for AppDelegate {}
|
|
||||||
|
|
||||||
// UIApplicationDelegate protocol
|
|
||||||
unsafe impl AppDelegate {
|
|
||||||
#[method(application:didFinishLaunchingWithOptions:)]
|
|
||||||
fn did_finish_launching(&self, _application: &UIApplication, _: *mut NSObject) -> bool {
|
|
||||||
app_state::did_finish_launching(MainThreadMarker::new().unwrap());
|
|
||||||
true
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationDidBecomeActive:)]
|
|
||||||
fn did_become_active(&self, _application: &UIApplication) {
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, EventWrapper::StaticEvent(Event::Resumed))
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationWillResignActive:)]
|
|
||||||
fn will_resign_active(&self, _application: &UIApplication) {
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, EventWrapper::StaticEvent(Event::Suspended))
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationWillEnterForeground:)]
|
|
||||||
fn will_enter_foreground(&self, application: &UIApplication) {
|
|
||||||
send_occluded_event_for_all_windows(application, false);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationDidEnterBackground:)]
|
|
||||||
fn did_enter_background(&self, application: &UIApplication) {
|
|
||||||
send_occluded_event_for_all_windows(application, true);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationWillTerminate:)]
|
|
||||||
fn will_terminate(&self, application: &UIApplication) {
|
|
||||||
app_state::terminated(application);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationDidReceiveMemoryWarning:)]
|
|
||||||
fn did_receive_memory_warning(&self, _application: &UIApplication) {
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, EventWrapper::StaticEvent(Event::MemoryWarning))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
#![allow(clippy::let_unit_value)]
|
|
||||||
|
|
||||||
mod app_delegate;
|
|
||||||
mod app_state;
|
|
||||||
mod event_loop;
|
|
||||||
mod monitor;
|
|
||||||
mod view;
|
|
||||||
mod view_controller;
|
|
||||||
mod window;
|
|
||||||
|
|
||||||
use std::fmt;
|
|
||||||
|
|
||||||
use crate::event::DeviceId as RootDeviceId;
|
|
||||||
|
|
||||||
pub(crate) use self::event_loop::{
|
|
||||||
ActiveEventLoop, EventLoop, EventLoopProxy, OwnedDisplayHandle,
|
|
||||||
PlatformSpecificEventLoopAttributes,
|
|
||||||
};
|
|
||||||
pub(crate) use self::monitor::{MonitorHandle, VideoModeHandle};
|
|
||||||
pub(crate) use self::window::{PlatformSpecificWindowAttributes, Window, WindowId};
|
|
||||||
pub(crate) use crate::cursor::{
|
|
||||||
NoCustomCursor as PlatformCustomCursor, NoCustomCursor as PlatformCustomCursorSource,
|
|
||||||
};
|
|
||||||
pub(crate) use crate::icon::NoIcon as PlatformIcon;
|
|
||||||
pub(crate) use crate::platform_impl::Fullscreen;
|
|
||||||
|
|
||||||
/// There is no way to detect which device that performed a certain event in
|
|
||||||
/// UIKit (i.e. you can't differentiate between different external keyboards,
|
|
||||||
/// or whether it was the main touchscreen, assistive technologies, or some
|
|
||||||
/// other pointer device that caused a touch event).
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
||||||
pub struct DeviceId;
|
|
||||||
|
|
||||||
impl DeviceId {
|
|
||||||
pub const unsafe fn dummy() -> Self {
|
|
||||||
DeviceId
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) const DEVICE_ID: RootDeviceId = RootDeviceId(DeviceId);
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
|
||||||
pub struct KeyEventExtra {}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub enum OsError {}
|
|
||||||
|
|
||||||
impl fmt::Display for OsError {
|
|
||||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
||||||
write!(f, "os error")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,515 +0,0 @@
|
|||||||
#![allow(clippy::unnecessary_cast)]
|
|
||||||
use std::cell::{Cell, RefCell};
|
|
||||||
|
|
||||||
use objc2::rc::Retained;
|
|
||||||
use objc2::runtime::{NSObjectProtocol, ProtocolObject};
|
|
||||||
use objc2::{declare_class, msg_send, msg_send_id, mutability, sel, ClassType, DeclaredClass};
|
|
||||||
use objc2_foundation::{CGFloat, CGPoint, CGRect, MainThreadMarker, NSObject, NSSet};
|
|
||||||
use objc2_ui_kit::{
|
|
||||||
UICoordinateSpace, UIEvent, UIForceTouchCapability, UIGestureRecognizer,
|
|
||||||
UIGestureRecognizerDelegate, UIGestureRecognizerState, UIPanGestureRecognizer,
|
|
||||||
UIPinchGestureRecognizer, UIResponder, UIRotationGestureRecognizer, UITapGestureRecognizer,
|
|
||||||
UITouch, UITouchPhase, UITouchType, UITraitEnvironment, UIView,
|
|
||||||
};
|
|
||||||
|
|
||||||
use super::app_state::{self, EventWrapper};
|
|
||||||
use super::window::WinitUIWindow;
|
|
||||||
use crate::dpi::PhysicalPosition;
|
|
||||||
use crate::event::{Event, Force, Touch, TouchPhase, WindowEvent};
|
|
||||||
use crate::platform_impl::platform::DEVICE_ID;
|
|
||||||
use crate::window::{WindowAttributes, WindowId as RootWindowId};
|
|
||||||
|
|
||||||
pub struct WinitViewState {
|
|
||||||
pinch_gesture_recognizer: RefCell<Option<Retained<UIPinchGestureRecognizer>>>,
|
|
||||||
doubletap_gesture_recognizer: RefCell<Option<Retained<UITapGestureRecognizer>>>,
|
|
||||||
rotation_gesture_recognizer: RefCell<Option<Retained<UIRotationGestureRecognizer>>>,
|
|
||||||
pan_gesture_recognizer: RefCell<Option<Retained<UIPanGestureRecognizer>>>,
|
|
||||||
|
|
||||||
// for iOS delta references the start of the Gesture
|
|
||||||
rotation_last_delta: Cell<CGFloat>,
|
|
||||||
pinch_last_delta: Cell<CGFloat>,
|
|
||||||
pan_last_delta: Cell<CGPoint>,
|
|
||||||
}
|
|
||||||
|
|
||||||
declare_class!(
|
|
||||||
pub(crate) struct WinitView;
|
|
||||||
|
|
||||||
unsafe impl ClassType for WinitView {
|
|
||||||
#[inherits(UIResponder, NSObject)]
|
|
||||||
type Super = UIView;
|
|
||||||
type Mutability = mutability::MainThreadOnly;
|
|
||||||
const NAME: &'static str = "WinitUIView";
|
|
||||||
}
|
|
||||||
|
|
||||||
impl DeclaredClass for WinitView {
|
|
||||||
type Ivars = WinitViewState;
|
|
||||||
}
|
|
||||||
|
|
||||||
unsafe impl WinitView {
|
|
||||||
#[method(drawRect:)]
|
|
||||||
fn draw_rect(&self, rect: CGRect) {
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
app_state::handle_nonuser_event(
|
|
||||||
mtm,
|
|
||||||
EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::RedrawRequested,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
let _: () = unsafe { msg_send![super(self), drawRect: rect] };
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(layoutSubviews)]
|
|
||||||
fn layout_subviews(&self) {
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
let _: () = unsafe { msg_send![super(self), layoutSubviews] };
|
|
||||||
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
let window_bounds = window.bounds();
|
|
||||||
let screen = window.screen();
|
|
||||||
let screen_space = screen.coordinateSpace();
|
|
||||||
let screen_frame = self.convertRect_toCoordinateSpace(window_bounds, &screen_space);
|
|
||||||
let scale_factor = screen.scale();
|
|
||||||
let size = crate::dpi::LogicalSize {
|
|
||||||
width: screen_frame.size.width as f64,
|
|
||||||
height: screen_frame.size.height as f64,
|
|
||||||
}
|
|
||||||
.to_physical(scale_factor as f64);
|
|
||||||
|
|
||||||
// If the app is started in landscape, the view frame and window bounds can be mismatched.
|
|
||||||
// The view frame will be in portrait and the window bounds in landscape. So apply the
|
|
||||||
// window bounds to the view frame to make it consistent.
|
|
||||||
let view_frame = self.frame();
|
|
||||||
if view_frame != window_bounds {
|
|
||||||
self.setFrame(window_bounds);
|
|
||||||
}
|
|
||||||
|
|
||||||
app_state::handle_nonuser_event(
|
|
||||||
mtm,
|
|
||||||
EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::Resized(size),
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(setContentScaleFactor:)]
|
|
||||||
fn set_content_scale_factor(&self, untrusted_scale_factor: CGFloat) {
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
let _: () =
|
|
||||||
unsafe { msg_send![super(self), setContentScaleFactor: untrusted_scale_factor] };
|
|
||||||
|
|
||||||
// `window` is null when `setContentScaleFactor` is invoked prior to `[UIWindow
|
|
||||||
// makeKeyAndVisible]` at window creation time (either manually or internally by
|
|
||||||
// UIKit when the `UIView` is first created), in which case we send no events here
|
|
||||||
let window = match self.window() {
|
|
||||||
Some(window) => window,
|
|
||||||
None => return,
|
|
||||||
};
|
|
||||||
// `setContentScaleFactor` may be called with a value of 0, which means "reset the
|
|
||||||
// content scale factor to a device-specific default value", so we can't use the
|
|
||||||
// parameter here. We can query the actual factor using the getter
|
|
||||||
let scale_factor = self.contentScaleFactor();
|
|
||||||
assert!(
|
|
||||||
!scale_factor.is_nan()
|
|
||||||
&& scale_factor.is_finite()
|
|
||||||
&& scale_factor.is_sign_positive()
|
|
||||||
&& scale_factor > 0.0,
|
|
||||||
"invalid scale_factor set on UIView",
|
|
||||||
);
|
|
||||||
let scale_factor = scale_factor as f64;
|
|
||||||
let bounds = self.bounds();
|
|
||||||
let screen = window.screen();
|
|
||||||
let screen_space = screen.coordinateSpace();
|
|
||||||
let screen_frame = self.convertRect_toCoordinateSpace(bounds, &screen_space);
|
|
||||||
let size = crate::dpi::LogicalSize {
|
|
||||||
width: screen_frame.size.width as f64,
|
|
||||||
height: screen_frame.size.height as f64,
|
|
||||||
};
|
|
||||||
let window_id = RootWindowId(window.id());
|
|
||||||
app_state::handle_nonuser_events(
|
|
||||||
mtm,
|
|
||||||
std::iter::once(EventWrapper::ScaleFactorChanged(
|
|
||||||
app_state::ScaleFactorChanged {
|
|
||||||
window,
|
|
||||||
scale_factor,
|
|
||||||
suggested_size: size.to_physical(scale_factor),
|
|
||||||
},
|
|
||||||
))
|
|
||||||
.chain(std::iter::once(EventWrapper::StaticEvent(
|
|
||||||
Event::WindowEvent {
|
|
||||||
window_id,
|
|
||||||
event: WindowEvent::Resized(size.to_physical(scale_factor)),
|
|
||||||
},
|
|
||||||
))),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(touchesBegan:withEvent:)]
|
|
||||||
fn touches_began(&self, touches: &NSSet<UITouch>, _event: Option<&UIEvent>) {
|
|
||||||
self.handle_touches(touches)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(touchesMoved:withEvent:)]
|
|
||||||
fn touches_moved(&self, touches: &NSSet<UITouch>, _event: Option<&UIEvent>) {
|
|
||||||
self.handle_touches(touches)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(touchesEnded:withEvent:)]
|
|
||||||
fn touches_ended(&self, touches: &NSSet<UITouch>, _event: Option<&UIEvent>) {
|
|
||||||
self.handle_touches(touches)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(touchesCancelled:withEvent:)]
|
|
||||||
fn touches_cancelled(&self, touches: &NSSet<UITouch>, _event: Option<&UIEvent>) {
|
|
||||||
self.handle_touches(touches)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(pinchGesture:)]
|
|
||||||
fn pinch_gesture(&self, recognizer: &UIPinchGestureRecognizer) {
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
|
|
||||||
let (phase, delta) = match recognizer.state() {
|
|
||||||
UIGestureRecognizerState::Began => {
|
|
||||||
self.ivars().pinch_last_delta.set(recognizer.scale());
|
|
||||||
(TouchPhase::Started, 0.0)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Changed => {
|
|
||||||
let last_scale: f64 = self.ivars().pinch_last_delta.replace(recognizer.scale());
|
|
||||||
(TouchPhase::Moved, recognizer.scale() - last_scale)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Ended => {
|
|
||||||
let last_scale: f64 = self.ivars().pinch_last_delta.replace(0.0);
|
|
||||||
(TouchPhase::Moved, recognizer.scale() - last_scale)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Cancelled | UIGestureRecognizerState::Failed => {
|
|
||||||
self.ivars().rotation_last_delta.set(0.0);
|
|
||||||
// Pass -delta so that action is reversed
|
|
||||||
(TouchPhase::Cancelled, -recognizer.scale())
|
|
||||||
}
|
|
||||||
state => panic!("unexpected recognizer state: {:?}", state),
|
|
||||||
};
|
|
||||||
|
|
||||||
let gesture_event = EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::PinchGesture {
|
|
||||||
device_id: DEVICE_ID,
|
|
||||||
delta: delta as f64,
|
|
||||||
phase,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, gesture_event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(doubleTapGesture:)]
|
|
||||||
fn double_tap_gesture(&self, recognizer: &UITapGestureRecognizer) {
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
|
|
||||||
if recognizer.state() == UIGestureRecognizerState::Ended {
|
|
||||||
let gesture_event = EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::DoubleTapGesture {
|
|
||||||
device_id: DEVICE_ID,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, gesture_event);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(rotationGesture:)]
|
|
||||||
fn rotation_gesture(&self, recognizer: &UIRotationGestureRecognizer) {
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
|
|
||||||
let (phase, delta) = match recognizer.state() {
|
|
||||||
UIGestureRecognizerState::Began => {
|
|
||||||
self.ivars().rotation_last_delta.set(0.0);
|
|
||||||
|
|
||||||
(TouchPhase::Started, 0.0)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Changed => {
|
|
||||||
let last_rotation = self.ivars().rotation_last_delta.replace(recognizer.rotation());
|
|
||||||
|
|
||||||
(TouchPhase::Moved, recognizer.rotation() - last_rotation)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Ended => {
|
|
||||||
let last_rotation = self.ivars().rotation_last_delta.replace(0.0);
|
|
||||||
|
|
||||||
(TouchPhase::Ended, recognizer.rotation() - last_rotation)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Cancelled | UIGestureRecognizerState::Failed => {
|
|
||||||
self.ivars().rotation_last_delta.set(0.0);
|
|
||||||
|
|
||||||
// Pass -delta so that action is reversed
|
|
||||||
(TouchPhase::Cancelled, -recognizer.rotation())
|
|
||||||
}
|
|
||||||
state => panic!("unexpected recognizer state: {:?}", state),
|
|
||||||
};
|
|
||||||
|
|
||||||
// Make delta negative to match macos, convert to degrees
|
|
||||||
let gesture_event = EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::RotationGesture {
|
|
||||||
device_id: DEVICE_ID,
|
|
||||||
delta: -delta.to_degrees() as _,
|
|
||||||
phase,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, gesture_event);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(panGesture:)]
|
|
||||||
fn pan_gesture(&self, recognizer: &UIPanGestureRecognizer) {
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
|
|
||||||
let translation = recognizer.translationInView(Some(self));
|
|
||||||
|
|
||||||
let (phase, dx, dy) = match recognizer.state() {
|
|
||||||
UIGestureRecognizerState::Began => {
|
|
||||||
self.ivars().pan_last_delta.set(translation);
|
|
||||||
|
|
||||||
(TouchPhase::Started, 0.0, 0.0)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Changed => {
|
|
||||||
let last_pan: CGPoint = self.ivars().pan_last_delta.replace(translation);
|
|
||||||
|
|
||||||
let dx = translation.x - last_pan.x;
|
|
||||||
let dy = translation.y - last_pan.y;
|
|
||||||
|
|
||||||
(TouchPhase::Moved, dx, dy)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Ended => {
|
|
||||||
let last_pan: CGPoint = self.ivars().pan_last_delta.replace(CGPoint{x:0.0, y:0.0});
|
|
||||||
|
|
||||||
let dx = translation.x - last_pan.x;
|
|
||||||
let dy = translation.y - last_pan.y;
|
|
||||||
|
|
||||||
(TouchPhase::Ended, dx, dy)
|
|
||||||
}
|
|
||||||
UIGestureRecognizerState::Cancelled | UIGestureRecognizerState::Failed => {
|
|
||||||
let last_pan: CGPoint = self.ivars().pan_last_delta.replace(CGPoint{x:0.0, y:0.0});
|
|
||||||
|
|
||||||
// Pass -delta so that action is reversed
|
|
||||||
(TouchPhase::Cancelled, -last_pan.x, -last_pan.y)
|
|
||||||
}
|
|
||||||
state => panic!("unexpected recognizer state: {:?}", state),
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
let gesture_event = EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::PanGesture {
|
|
||||||
device_id: DEVICE_ID,
|
|
||||||
delta: PhysicalPosition::new(dx as _, dy as _),
|
|
||||||
phase,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_event(mtm, gesture_event);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
unsafe impl NSObjectProtocol for WinitView {}
|
|
||||||
|
|
||||||
unsafe impl UIGestureRecognizerDelegate for WinitView {
|
|
||||||
#[method(gestureRecognizer:shouldRecognizeSimultaneouslyWithGestureRecognizer:)]
|
|
||||||
fn should_recognize_simultaneously(&self, _gesture_recognizer: &UIGestureRecognizer, _other_gesture_recognizer: &UIGestureRecognizer) -> bool {
|
|
||||||
true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
impl WinitView {
|
|
||||||
pub(crate) fn new(
|
|
||||||
mtm: MainThreadMarker,
|
|
||||||
window_attributes: &WindowAttributes,
|
|
||||||
frame: CGRect,
|
|
||||||
) -> Retained<Self> {
|
|
||||||
let this = mtm.alloc().set_ivars(WinitViewState {
|
|
||||||
pinch_gesture_recognizer: RefCell::new(None),
|
|
||||||
doubletap_gesture_recognizer: RefCell::new(None),
|
|
||||||
rotation_gesture_recognizer: RefCell::new(None),
|
|
||||||
pan_gesture_recognizer: RefCell::new(None),
|
|
||||||
|
|
||||||
rotation_last_delta: Cell::new(0.0),
|
|
||||||
pinch_last_delta: Cell::new(0.0),
|
|
||||||
pan_last_delta: Cell::new(CGPoint { x: 0.0, y: 0.0 }),
|
|
||||||
});
|
|
||||||
let this: Retained<Self> = unsafe { msg_send_id![super(this), initWithFrame: frame] };
|
|
||||||
|
|
||||||
this.setMultipleTouchEnabled(true);
|
|
||||||
|
|
||||||
if let Some(scale_factor) = window_attributes.platform_specific.scale_factor {
|
|
||||||
this.setContentScaleFactor(scale_factor as _);
|
|
||||||
}
|
|
||||||
|
|
||||||
this
|
|
||||||
}
|
|
||||||
|
|
||||||
fn window(&self) -> Option<Retained<WinitUIWindow>> {
|
|
||||||
// SAFETY: `WinitView`s are always installed in a `WinitUIWindow`
|
|
||||||
(**self).window().map(|window| unsafe { Retained::cast(window) })
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn recognize_pinch_gesture(&self, should_recognize: bool) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
if should_recognize {
|
|
||||||
if self.ivars().pinch_gesture_recognizer.borrow().is_none() {
|
|
||||||
let pinch = unsafe {
|
|
||||||
UIPinchGestureRecognizer::initWithTarget_action(
|
|
||||||
mtm.alloc(),
|
|
||||||
Some(self),
|
|
||||||
Some(sel!(pinchGesture:)),
|
|
||||||
)
|
|
||||||
};
|
|
||||||
pinch.setDelegate(Some(ProtocolObject::from_ref(self)));
|
|
||||||
self.addGestureRecognizer(&pinch);
|
|
||||||
self.ivars().pinch_gesture_recognizer.replace(Some(pinch));
|
|
||||||
}
|
|
||||||
} else if let Some(recognizer) = self.ivars().pinch_gesture_recognizer.take() {
|
|
||||||
self.removeGestureRecognizer(&recognizer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn recognize_pan_gesture(
|
|
||||||
&self,
|
|
||||||
should_recognize: bool,
|
|
||||||
minimum_number_of_touches: u8,
|
|
||||||
maximum_number_of_touches: u8,
|
|
||||||
) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
if should_recognize {
|
|
||||||
if self.ivars().pan_gesture_recognizer.borrow().is_none() {
|
|
||||||
let pan = unsafe {
|
|
||||||
UIPanGestureRecognizer::initWithTarget_action(
|
|
||||||
mtm.alloc(),
|
|
||||||
Some(self),
|
|
||||||
Some(sel!(panGesture:)),
|
|
||||||
)
|
|
||||||
};
|
|
||||||
pan.setDelegate(Some(ProtocolObject::from_ref(self)));
|
|
||||||
pan.setMinimumNumberOfTouches(minimum_number_of_touches as _);
|
|
||||||
pan.setMaximumNumberOfTouches(maximum_number_of_touches as _);
|
|
||||||
self.addGestureRecognizer(&pan);
|
|
||||||
self.ivars().pan_gesture_recognizer.replace(Some(pan));
|
|
||||||
}
|
|
||||||
} else if let Some(recognizer) = self.ivars().pan_gesture_recognizer.take() {
|
|
||||||
self.removeGestureRecognizer(&recognizer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn recognize_doubletap_gesture(&self, should_recognize: bool) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
if should_recognize {
|
|
||||||
if self.ivars().doubletap_gesture_recognizer.borrow().is_none() {
|
|
||||||
let tap = unsafe {
|
|
||||||
UITapGestureRecognizer::initWithTarget_action(
|
|
||||||
mtm.alloc(),
|
|
||||||
Some(self),
|
|
||||||
Some(sel!(doubleTapGesture:)),
|
|
||||||
)
|
|
||||||
};
|
|
||||||
tap.setDelegate(Some(ProtocolObject::from_ref(self)));
|
|
||||||
tap.setNumberOfTapsRequired(2);
|
|
||||||
tap.setNumberOfTouchesRequired(1);
|
|
||||||
self.addGestureRecognizer(&tap);
|
|
||||||
self.ivars().doubletap_gesture_recognizer.replace(Some(tap));
|
|
||||||
}
|
|
||||||
} else if let Some(recognizer) = self.ivars().doubletap_gesture_recognizer.take() {
|
|
||||||
self.removeGestureRecognizer(&recognizer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn recognize_rotation_gesture(&self, should_recognize: bool) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
if should_recognize {
|
|
||||||
if self.ivars().rotation_gesture_recognizer.borrow().is_none() {
|
|
||||||
let rotation = unsafe {
|
|
||||||
UIRotationGestureRecognizer::initWithTarget_action(
|
|
||||||
mtm.alloc(),
|
|
||||||
Some(self),
|
|
||||||
Some(sel!(rotationGesture:)),
|
|
||||||
)
|
|
||||||
};
|
|
||||||
rotation.setDelegate(Some(ProtocolObject::from_ref(self)));
|
|
||||||
self.addGestureRecognizer(&rotation);
|
|
||||||
self.ivars().rotation_gesture_recognizer.replace(Some(rotation));
|
|
||||||
}
|
|
||||||
} else if let Some(recognizer) = self.ivars().rotation_gesture_recognizer.take() {
|
|
||||||
self.removeGestureRecognizer(&recognizer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn handle_touches(&self, touches: &NSSet<UITouch>) {
|
|
||||||
let window = self.window().unwrap();
|
|
||||||
let mut touch_events = Vec::new();
|
|
||||||
let os_supports_force = app_state::os_capabilities().force_touch;
|
|
||||||
for touch in touches {
|
|
||||||
let logical_location = touch.locationInView(None);
|
|
||||||
let touch_type = touch.r#type();
|
|
||||||
let force = if os_supports_force {
|
|
||||||
let trait_collection = self.traitCollection();
|
|
||||||
let touch_capability = trait_collection.forceTouchCapability();
|
|
||||||
// Both the OS _and_ the device need to be checked for force touch support.
|
|
||||||
if touch_capability == UIForceTouchCapability::Available
|
|
||||||
|| touch_type == UITouchType::Pencil
|
|
||||||
{
|
|
||||||
let force = touch.force();
|
|
||||||
let max_possible_force = touch.maximumPossibleForce();
|
|
||||||
let altitude_angle: Option<f64> = if touch_type == UITouchType::Pencil {
|
|
||||||
let angle = touch.altitudeAngle();
|
|
||||||
Some(angle as _)
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
};
|
|
||||||
Some(Force::Calibrated {
|
|
||||||
force: force as _,
|
|
||||||
max_possible_force: max_possible_force as _,
|
|
||||||
altitude_angle,
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
};
|
|
||||||
let touch_id = touch as *const UITouch as u64;
|
|
||||||
let phase = touch.phase();
|
|
||||||
let phase = match phase {
|
|
||||||
UITouchPhase::Began => TouchPhase::Started,
|
|
||||||
UITouchPhase::Moved => TouchPhase::Moved,
|
|
||||||
// 2 is UITouchPhase::Stationary and is not expected here
|
|
||||||
UITouchPhase::Ended => TouchPhase::Ended,
|
|
||||||
UITouchPhase::Cancelled => TouchPhase::Cancelled,
|
|
||||||
_ => panic!("unexpected touch phase: {phase:?}"),
|
|
||||||
};
|
|
||||||
|
|
||||||
let physical_location = {
|
|
||||||
let scale_factor = self.contentScaleFactor();
|
|
||||||
PhysicalPosition::from_logical::<(f64, f64), f64>(
|
|
||||||
(logical_location.x as _, logical_location.y as _),
|
|
||||||
scale_factor as f64,
|
|
||||||
)
|
|
||||||
};
|
|
||||||
touch_events.push(EventWrapper::StaticEvent(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window.id()),
|
|
||||||
event: WindowEvent::Touch(Touch {
|
|
||||||
device_id: DEVICE_ID,
|
|
||||||
id: touch_id,
|
|
||||||
location: physical_location,
|
|
||||||
force,
|
|
||||||
phase,
|
|
||||||
}),
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
let mtm = MainThreadMarker::new().unwrap();
|
|
||||||
app_state::handle_nonuser_events(mtm, touch_events);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,176 +0,0 @@
|
|||||||
use std::cell::Cell;
|
|
||||||
|
|
||||||
use objc2::rc::Retained;
|
|
||||||
use objc2::{declare_class, msg_send_id, mutability, ClassType, DeclaredClass};
|
|
||||||
use objc2_foundation::{MainThreadMarker, NSObject};
|
|
||||||
use objc2_ui_kit::{
|
|
||||||
UIDevice, UIInterfaceOrientationMask, UIRectEdge, UIResponder, UIStatusBarStyle,
|
|
||||||
UIUserInterfaceIdiom, UIView, UIViewController,
|
|
||||||
};
|
|
||||||
|
|
||||||
use super::app_state::{self};
|
|
||||||
use crate::platform::ios::{ScreenEdge, StatusBarStyle, ValidOrientations};
|
|
||||||
use crate::window::WindowAttributes;
|
|
||||||
|
|
||||||
pub struct ViewControllerState {
|
|
||||||
prefers_status_bar_hidden: Cell<bool>,
|
|
||||||
preferred_status_bar_style: Cell<UIStatusBarStyle>,
|
|
||||||
prefers_home_indicator_auto_hidden: Cell<bool>,
|
|
||||||
supported_orientations: Cell<UIInterfaceOrientationMask>,
|
|
||||||
preferred_screen_edges_deferring_system_gestures: Cell<UIRectEdge>,
|
|
||||||
}
|
|
||||||
|
|
||||||
declare_class!(
|
|
||||||
pub(crate) struct WinitViewController;
|
|
||||||
|
|
||||||
unsafe impl ClassType for WinitViewController {
|
|
||||||
#[inherits(UIResponder, NSObject)]
|
|
||||||
type Super = UIViewController;
|
|
||||||
type Mutability = mutability::MainThreadOnly;
|
|
||||||
const NAME: &'static str = "WinitUIViewController";
|
|
||||||
}
|
|
||||||
|
|
||||||
impl DeclaredClass for WinitViewController {
|
|
||||||
type Ivars = ViewControllerState;
|
|
||||||
}
|
|
||||||
|
|
||||||
unsafe impl WinitViewController {
|
|
||||||
#[method(shouldAutorotate)]
|
|
||||||
fn should_autorotate(&self) -> bool {
|
|
||||||
true
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(prefersStatusBarHidden)]
|
|
||||||
fn prefers_status_bar_hidden(&self) -> bool {
|
|
||||||
self.ivars().prefers_status_bar_hidden.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(preferredStatusBarStyle)]
|
|
||||||
fn preferred_status_bar_style(&self) -> UIStatusBarStyle {
|
|
||||||
self.ivars().preferred_status_bar_style.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(prefersHomeIndicatorAutoHidden)]
|
|
||||||
fn prefers_home_indicator_auto_hidden(&self) -> bool {
|
|
||||||
self.ivars().prefers_home_indicator_auto_hidden.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(supportedInterfaceOrientations)]
|
|
||||||
fn supported_orientations(&self) -> UIInterfaceOrientationMask {
|
|
||||||
self.ivars().supported_orientations.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(preferredScreenEdgesDeferringSystemGestures)]
|
|
||||||
fn preferred_screen_edges_deferring_system_gestures(&self) -> UIRectEdge {
|
|
||||||
self.ivars()
|
|
||||||
.preferred_screen_edges_deferring_system_gestures
|
|
||||||
.get()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
impl WinitViewController {
|
|
||||||
pub(crate) fn set_prefers_status_bar_hidden(&self, val: bool) {
|
|
||||||
self.ivars().prefers_status_bar_hidden.set(val);
|
|
||||||
self.setNeedsStatusBarAppearanceUpdate();
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn set_preferred_status_bar_style(&self, val: StatusBarStyle) {
|
|
||||||
let val = match val {
|
|
||||||
StatusBarStyle::Default => UIStatusBarStyle::Default,
|
|
||||||
StatusBarStyle::LightContent => UIStatusBarStyle::LightContent,
|
|
||||||
StatusBarStyle::DarkContent => UIStatusBarStyle::DarkContent,
|
|
||||||
};
|
|
||||||
self.ivars().preferred_status_bar_style.set(val);
|
|
||||||
self.setNeedsStatusBarAppearanceUpdate();
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn set_prefers_home_indicator_auto_hidden(&self, val: bool) {
|
|
||||||
self.ivars().prefers_home_indicator_auto_hidden.set(val);
|
|
||||||
let os_capabilities = app_state::os_capabilities();
|
|
||||||
if os_capabilities.home_indicator_hidden {
|
|
||||||
self.setNeedsUpdateOfHomeIndicatorAutoHidden();
|
|
||||||
} else {
|
|
||||||
os_capabilities.home_indicator_hidden_err_msg("ignoring")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn set_preferred_screen_edges_deferring_system_gestures(&self, val: ScreenEdge) {
|
|
||||||
let val = {
|
|
||||||
assert_eq!(val.bits() & !ScreenEdge::ALL.bits(), 0, "invalid `ScreenEdge`");
|
|
||||||
UIRectEdge(val.bits().into())
|
|
||||||
};
|
|
||||||
self.ivars().preferred_screen_edges_deferring_system_gestures.set(val);
|
|
||||||
let os_capabilities = app_state::os_capabilities();
|
|
||||||
if os_capabilities.defer_system_gestures {
|
|
||||||
self.setNeedsUpdateOfScreenEdgesDeferringSystemGestures();
|
|
||||||
} else {
|
|
||||||
os_capabilities.defer_system_gestures_err_msg("ignoring")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn set_supported_interface_orientations(
|
|
||||||
&self,
|
|
||||||
mtm: MainThreadMarker,
|
|
||||||
valid_orientations: ValidOrientations,
|
|
||||||
) {
|
|
||||||
let mask = match (valid_orientations, UIDevice::currentDevice(mtm).userInterfaceIdiom()) {
|
|
||||||
(ValidOrientations::LandscapeAndPortrait, UIUserInterfaceIdiom::Phone) => {
|
|
||||||
UIInterfaceOrientationMask::AllButUpsideDown
|
|
||||||
},
|
|
||||||
(ValidOrientations::LandscapeAndPortrait, _) => UIInterfaceOrientationMask::All,
|
|
||||||
(ValidOrientations::Landscape, _) => UIInterfaceOrientationMask::Landscape,
|
|
||||||
(ValidOrientations::Portrait, UIUserInterfaceIdiom::Phone) => {
|
|
||||||
UIInterfaceOrientationMask::Portrait
|
|
||||||
},
|
|
||||||
(ValidOrientations::Portrait, _) => {
|
|
||||||
UIInterfaceOrientationMask::Portrait
|
|
||||||
| UIInterfaceOrientationMask::PortraitUpsideDown
|
|
||||||
},
|
|
||||||
};
|
|
||||||
self.ivars().supported_orientations.set(mask);
|
|
||||||
#[allow(deprecated)]
|
|
||||||
UIViewController::attemptRotationToDeviceOrientation(mtm);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn new(
|
|
||||||
mtm: MainThreadMarker,
|
|
||||||
window_attributes: &WindowAttributes,
|
|
||||||
view: &UIView,
|
|
||||||
) -> Retained<Self> {
|
|
||||||
// These are set properly below, we just to set them to something in the meantime.
|
|
||||||
let this = mtm.alloc().set_ivars(ViewControllerState {
|
|
||||||
prefers_status_bar_hidden: Cell::new(false),
|
|
||||||
preferred_status_bar_style: Cell::new(UIStatusBarStyle::Default),
|
|
||||||
prefers_home_indicator_auto_hidden: Cell::new(false),
|
|
||||||
supported_orientations: Cell::new(UIInterfaceOrientationMask::All),
|
|
||||||
preferred_screen_edges_deferring_system_gestures: Cell::new(UIRectEdge::empty()),
|
|
||||||
});
|
|
||||||
let this: Retained<Self> = unsafe { msg_send_id![super(this), init] };
|
|
||||||
|
|
||||||
this.set_prefers_status_bar_hidden(
|
|
||||||
window_attributes.platform_specific.prefers_status_bar_hidden,
|
|
||||||
);
|
|
||||||
|
|
||||||
this.set_preferred_status_bar_style(
|
|
||||||
window_attributes.platform_specific.preferred_status_bar_style,
|
|
||||||
);
|
|
||||||
|
|
||||||
this.set_supported_interface_orientations(
|
|
||||||
mtm,
|
|
||||||
window_attributes.platform_specific.valid_orientations,
|
|
||||||
);
|
|
||||||
|
|
||||||
this.set_prefers_home_indicator_auto_hidden(
|
|
||||||
window_attributes.platform_specific.prefers_home_indicator_hidden,
|
|
||||||
);
|
|
||||||
|
|
||||||
this.set_preferred_screen_edges_deferring_system_gestures(
|
|
||||||
window_attributes.platform_specific.preferred_screen_edges_deferring_system_gestures,
|
|
||||||
);
|
|
||||||
|
|
||||||
this.setView(Some(view));
|
|
||||||
|
|
||||||
this
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
pub mod xkb;
|
|
||||||
@@ -1,123 +0,0 @@
|
|||||||
//! XKB compose handling.
|
|
||||||
|
|
||||||
use std::env;
|
|
||||||
use std::ffi::CString;
|
|
||||||
use std::ops::Deref;
|
|
||||||
use std::os::unix::ffi::OsStringExt;
|
|
||||||
use std::ptr::NonNull;
|
|
||||||
|
|
||||||
use super::{XkbContext, XKBCH};
|
|
||||||
use smol_str::SmolStr;
|
|
||||||
use xkbcommon_dl::{
|
|
||||||
xkb_compose_compile_flags, xkb_compose_feed_result, xkb_compose_state, xkb_compose_state_flags,
|
|
||||||
xkb_compose_status, xkb_compose_table, xkb_keysym_t,
|
|
||||||
};
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub struct XkbComposeTable {
|
|
||||||
table: NonNull<xkb_compose_table>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl XkbComposeTable {
|
|
||||||
pub fn new(context: &XkbContext) -> Option<Self> {
|
|
||||||
let locale = env::var_os("LC_ALL")
|
|
||||||
.and_then(|v| if v.is_empty() { None } else { Some(v) })
|
|
||||||
.or_else(|| env::var_os("LC_CTYPE"))
|
|
||||||
.and_then(|v| if v.is_empty() { None } else { Some(v) })
|
|
||||||
.or_else(|| env::var_os("LANG"))
|
|
||||||
.and_then(|v| if v.is_empty() { None } else { Some(v) })
|
|
||||||
.unwrap_or_else(|| "C".into());
|
|
||||||
let locale = CString::new(locale.into_vec()).unwrap();
|
|
||||||
|
|
||||||
let table = unsafe {
|
|
||||||
(XKBCH.xkb_compose_table_new_from_locale)(
|
|
||||||
context.as_ptr(),
|
|
||||||
locale.as_ptr(),
|
|
||||||
xkb_compose_compile_flags::XKB_COMPOSE_COMPILE_NO_FLAGS,
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
let table = NonNull::new(table)?;
|
|
||||||
Some(Self { table })
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Create new state with the given compose table.
|
|
||||||
pub fn new_state(&self) -> Option<XkbComposeState> {
|
|
||||||
let state = unsafe {
|
|
||||||
(XKBCH.xkb_compose_state_new)(
|
|
||||||
self.table.as_ptr(),
|
|
||||||
xkb_compose_state_flags::XKB_COMPOSE_STATE_NO_FLAGS,
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
let state = NonNull::new(state)?;
|
|
||||||
Some(XkbComposeState { state })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Deref for XkbComposeTable {
|
|
||||||
type Target = NonNull<xkb_compose_table>;
|
|
||||||
|
|
||||||
fn deref(&self) -> &Self::Target {
|
|
||||||
&self.table
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Drop for XkbComposeTable {
|
|
||||||
fn drop(&mut self) {
|
|
||||||
unsafe {
|
|
||||||
(XKBCH.xkb_compose_table_unref)(self.table.as_ptr());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub struct XkbComposeState {
|
|
||||||
state: NonNull<xkb_compose_state>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl XkbComposeState {
|
|
||||||
pub fn get_string(&mut self, scratch_buffer: &mut Vec<u8>) -> Option<SmolStr> {
|
|
||||||
super::make_string_with(scratch_buffer, |ptr, len| unsafe {
|
|
||||||
(XKBCH.xkb_compose_state_get_utf8)(self.state.as_ptr(), ptr, len)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn feed(&mut self, keysym: xkb_keysym_t) -> ComposeStatus {
|
|
||||||
let feed_result = unsafe { (XKBCH.xkb_compose_state_feed)(self.state.as_ptr(), keysym) };
|
|
||||||
match feed_result {
|
|
||||||
xkb_compose_feed_result::XKB_COMPOSE_FEED_IGNORED => ComposeStatus::Ignored,
|
|
||||||
xkb_compose_feed_result::XKB_COMPOSE_FEED_ACCEPTED => {
|
|
||||||
ComposeStatus::Accepted(self.status())
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn reset(&mut self) {
|
|
||||||
unsafe {
|
|
||||||
(XKBCH.xkb_compose_state_reset)(self.state.as_ptr());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn status(&mut self) -> xkb_compose_status {
|
|
||||||
unsafe { (XKBCH.xkb_compose_state_get_status)(self.state.as_ptr()) }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Drop for XkbComposeState {
|
|
||||||
fn drop(&mut self) {
|
|
||||||
unsafe {
|
|
||||||
(XKBCH.xkb_compose_state_unref)(self.state.as_ptr());
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Copy, Clone, Debug)]
|
|
||||||
pub enum ComposeStatus {
|
|
||||||
Accepted(xkb_compose_status),
|
|
||||||
Ignored,
|
|
||||||
None,
|
|
||||||
}
|
|
||||||
@@ -1,416 +0,0 @@
|
|||||||
use std::ops::Deref;
|
|
||||||
use std::os::raw::c_char;
|
|
||||||
use std::ptr::{self, NonNull};
|
|
||||||
use std::sync::atomic::{AtomicBool, Ordering};
|
|
||||||
|
|
||||||
use crate::utils::Lazy;
|
|
||||||
use smol_str::SmolStr;
|
|
||||||
#[cfg(wayland_platform)]
|
|
||||||
use std::os::unix::io::OwnedFd;
|
|
||||||
use tracing::warn;
|
|
||||||
use xkbcommon_dl::{
|
|
||||||
self as xkb, xkb_compose_status, xkb_context, xkb_context_flags, xkbcommon_compose_handle,
|
|
||||||
xkbcommon_handle, XkbCommon, XkbCommonCompose,
|
|
||||||
};
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
use {x11_dl::xlib_xcb::xcb_connection_t, xkbcommon_dl::x11::xkbcommon_x11_handle};
|
|
||||||
|
|
||||||
use crate::event::{ElementState, KeyEvent};
|
|
||||||
use crate::keyboard::{Key, KeyLocation};
|
|
||||||
use crate::platform_impl::KeyEventExtra;
|
|
||||||
|
|
||||||
mod compose;
|
|
||||||
mod keymap;
|
|
||||||
mod state;
|
|
||||||
|
|
||||||
use compose::{ComposeStatus, XkbComposeState, XkbComposeTable};
|
|
||||||
use keymap::XkbKeymap;
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub use keymap::raw_keycode_to_physicalkey;
|
|
||||||
pub use keymap::{physicalkey_to_scancode, scancode_to_physicalkey};
|
|
||||||
pub use state::XkbState;
|
|
||||||
|
|
||||||
// TODO: Wire this up without using a static `AtomicBool`.
|
|
||||||
static RESET_DEAD_KEYS: AtomicBool = AtomicBool::new(false);
|
|
||||||
|
|
||||||
static XKBH: Lazy<&'static XkbCommon> = Lazy::new(xkbcommon_handle);
|
|
||||||
static XKBCH: Lazy<&'static XkbCommonCompose> = Lazy::new(xkbcommon_compose_handle);
|
|
||||||
#[cfg(feature = "x11")]
|
|
||||||
static XKBXH: Lazy<&'static xkb::x11::XkbCommonX11> = Lazy::new(xkbcommon_x11_handle);
|
|
||||||
|
|
||||||
#[inline(always)]
|
|
||||||
pub fn reset_dead_keys() {
|
|
||||||
RESET_DEAD_KEYS.store(true, Ordering::SeqCst);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub enum Error {
|
|
||||||
/// libxkbcommon is not available
|
|
||||||
XKBNotFound,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub struct Context {
|
|
||||||
// NOTE: field order matters.
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub core_keyboard_id: i32,
|
|
||||||
state: Option<XkbState>,
|
|
||||||
keymap: Option<XkbKeymap>,
|
|
||||||
compose_state1: Option<XkbComposeState>,
|
|
||||||
compose_state2: Option<XkbComposeState>,
|
|
||||||
_compose_table: Option<XkbComposeTable>,
|
|
||||||
context: XkbContext,
|
|
||||||
scratch_buffer: Vec<u8>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Context {
|
|
||||||
pub fn new() -> Result<Self, Error> {
|
|
||||||
if xkb::xkbcommon_option().is_none() {
|
|
||||||
return Err(Error::XKBNotFound);
|
|
||||||
}
|
|
||||||
|
|
||||||
let context = XkbContext::new()?;
|
|
||||||
let mut compose_table = XkbComposeTable::new(&context);
|
|
||||||
let mut compose_state1 = compose_table.as_ref().and_then(|table| table.new_state());
|
|
||||||
let mut compose_state2 = compose_table.as_ref().and_then(|table| table.new_state());
|
|
||||||
|
|
||||||
// Disable compose if anything compose related failed to initialize.
|
|
||||||
if compose_table.is_none() || compose_state1.is_none() || compose_state2.is_none() {
|
|
||||||
compose_state2 = None;
|
|
||||||
compose_state1 = None;
|
|
||||||
compose_table = None;
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(Self {
|
|
||||||
state: None,
|
|
||||||
keymap: None,
|
|
||||||
compose_state1,
|
|
||||||
compose_state2,
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
core_keyboard_id: 0,
|
|
||||||
_compose_table: compose_table,
|
|
||||||
context,
|
|
||||||
scratch_buffer: Vec::with_capacity(8),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "x11")]
|
|
||||||
pub fn from_x11_xkb(xcb: *mut xcb_connection_t) -> Result<Self, Error> {
|
|
||||||
let result = unsafe {
|
|
||||||
(XKBXH.xkb_x11_setup_xkb_extension)(
|
|
||||||
xcb,
|
|
||||||
1,
|
|
||||||
2,
|
|
||||||
xkbcommon_dl::x11::xkb_x11_setup_xkb_extension_flags::XKB_X11_SETUP_XKB_EXTENSION_NO_FLAGS,
|
|
||||||
ptr::null_mut(),
|
|
||||||
ptr::null_mut(),
|
|
||||||
ptr::null_mut(),
|
|
||||||
ptr::null_mut(),
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
if result != 1 {
|
|
||||||
return Err(Error::XKBNotFound);
|
|
||||||
}
|
|
||||||
|
|
||||||
let mut this = Self::new()?;
|
|
||||||
this.core_keyboard_id = unsafe { (XKBXH.xkb_x11_get_core_keyboard_device_id)(xcb) };
|
|
||||||
this.set_keymap_from_x11(xcb);
|
|
||||||
Ok(this)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn state_mut(&mut self) -> Option<&mut XkbState> {
|
|
||||||
self.state.as_mut()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn keymap_mut(&mut self) -> Option<&mut XkbKeymap> {
|
|
||||||
self.keymap.as_mut()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(wayland_platform)]
|
|
||||||
pub fn set_keymap_from_fd(&mut self, fd: OwnedFd, size: usize) {
|
|
||||||
let keymap = XkbKeymap::from_fd(&self.context, fd, size);
|
|
||||||
let state = keymap.as_ref().and_then(XkbState::new_wayland);
|
|
||||||
if keymap.is_none() || state.is_none() {
|
|
||||||
warn!("failed to update xkb keymap");
|
|
||||||
}
|
|
||||||
self.state = state;
|
|
||||||
self.keymap = keymap;
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub fn set_keymap_from_x11(&mut self, xcb: *mut xcb_connection_t) {
|
|
||||||
let keymap = XkbKeymap::from_x11_keymap(&self.context, xcb, self.core_keyboard_id);
|
|
||||||
let state = keymap.as_ref().and_then(|keymap| XkbState::new_x11(xcb, keymap));
|
|
||||||
if keymap.is_none() || state.is_none() {
|
|
||||||
warn!("failed to update xkb keymap");
|
|
||||||
}
|
|
||||||
self.state = state;
|
|
||||||
self.keymap = keymap;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Key builder context with the user provided xkb state.
|
|
||||||
pub fn key_context(&mut self) -> Option<KeyContext<'_>> {
|
|
||||||
let state = self.state.as_mut()?;
|
|
||||||
let keymap = self.keymap.as_mut()?;
|
|
||||||
let compose_state1 = self.compose_state1.as_mut();
|
|
||||||
let compose_state2 = self.compose_state2.as_mut();
|
|
||||||
let scratch_buffer = &mut self.scratch_buffer;
|
|
||||||
Some(KeyContext { state, keymap, compose_state1, compose_state2, scratch_buffer })
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Key builder context with the user provided xkb state.
|
|
||||||
///
|
|
||||||
/// Should be used when the original context must not be altered.
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub fn key_context_with_state<'a>(
|
|
||||||
&'a mut self,
|
|
||||||
state: &'a mut XkbState,
|
|
||||||
) -> Option<KeyContext<'a>> {
|
|
||||||
let keymap = self.keymap.as_mut()?;
|
|
||||||
let compose_state1 = self.compose_state1.as_mut();
|
|
||||||
let compose_state2 = self.compose_state2.as_mut();
|
|
||||||
let scratch_buffer = &mut self.scratch_buffer;
|
|
||||||
Some(KeyContext { state, keymap, compose_state1, compose_state2, scratch_buffer })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct KeyContext<'a> {
|
|
||||||
pub state: &'a mut XkbState,
|
|
||||||
pub keymap: &'a mut XkbKeymap,
|
|
||||||
compose_state1: Option<&'a mut XkbComposeState>,
|
|
||||||
compose_state2: Option<&'a mut XkbComposeState>,
|
|
||||||
scratch_buffer: &'a mut Vec<u8>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'a> KeyContext<'a> {
|
|
||||||
pub fn process_key_event(
|
|
||||||
&mut self,
|
|
||||||
keycode: u32,
|
|
||||||
state: ElementState,
|
|
||||||
repeat: bool,
|
|
||||||
) -> KeyEvent {
|
|
||||||
let mut event =
|
|
||||||
KeyEventResults::new(self, keycode, !repeat && state == ElementState::Pressed);
|
|
||||||
let physical_key = keymap::raw_keycode_to_physicalkey(keycode);
|
|
||||||
let (logical_key, location) = event.key();
|
|
||||||
let text = event.text();
|
|
||||||
let (key_without_modifiers, _) = event.key_without_modifiers();
|
|
||||||
let text_with_all_modifiers = event.text_with_all_modifiers();
|
|
||||||
|
|
||||||
let platform_specific = KeyEventExtra { text_with_all_modifiers, key_without_modifiers };
|
|
||||||
|
|
||||||
KeyEvent { physical_key, logical_key, text, location, state, repeat, platform_specific }
|
|
||||||
}
|
|
||||||
|
|
||||||
fn keysym_to_utf8_raw(&mut self, keysym: u32) -> Option<SmolStr> {
|
|
||||||
self.scratch_buffer.clear();
|
|
||||||
self.scratch_buffer.reserve(8);
|
|
||||||
loop {
|
|
||||||
let bytes_written = unsafe {
|
|
||||||
(XKBH.xkb_keysym_to_utf8)(
|
|
||||||
keysym,
|
|
||||||
self.scratch_buffer.as_mut_ptr().cast(),
|
|
||||||
self.scratch_buffer.capacity(),
|
|
||||||
)
|
|
||||||
};
|
|
||||||
if bytes_written == 0 {
|
|
||||||
return None;
|
|
||||||
} else if bytes_written == -1 {
|
|
||||||
self.scratch_buffer.reserve(8);
|
|
||||||
} else {
|
|
||||||
unsafe { self.scratch_buffer.set_len(bytes_written.try_into().unwrap()) };
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove the null-terminator
|
|
||||||
self.scratch_buffer.pop();
|
|
||||||
byte_slice_to_smol_str(self.scratch_buffer)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
struct KeyEventResults<'a, 'b> {
|
|
||||||
context: &'a mut KeyContext<'b>,
|
|
||||||
keycode: u32,
|
|
||||||
keysym: u32,
|
|
||||||
compose: ComposeStatus,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'a, 'b> KeyEventResults<'a, 'b> {
|
|
||||||
fn new(context: &'a mut KeyContext<'b>, keycode: u32, compose: bool) -> Self {
|
|
||||||
let keysym = context.state.get_one_sym_raw(keycode);
|
|
||||||
|
|
||||||
let compose = if let Some(state) = context.compose_state1.as_mut().filter(|_| compose) {
|
|
||||||
if RESET_DEAD_KEYS.swap(false, Ordering::SeqCst) {
|
|
||||||
state.reset();
|
|
||||||
context.compose_state2.as_mut().unwrap().reset();
|
|
||||||
}
|
|
||||||
state.feed(keysym)
|
|
||||||
} else {
|
|
||||||
ComposeStatus::None
|
|
||||||
};
|
|
||||||
|
|
||||||
KeyEventResults { context, keycode, keysym, compose }
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn key(&mut self) -> (Key, KeyLocation) {
|
|
||||||
let (key, location) = match self.keysym_to_key(self.keysym) {
|
|
||||||
Ok(known) => return known,
|
|
||||||
Err(undefined) => undefined,
|
|
||||||
};
|
|
||||||
|
|
||||||
if let ComposeStatus::Accepted(xkb_compose_status::XKB_COMPOSE_COMPOSING) = self.compose {
|
|
||||||
let compose_state = self.context.compose_state2.as_mut().unwrap();
|
|
||||||
// When pressing a dead key twice, the non-combining variant of that character will
|
|
||||||
// be produced. Since this function only concerns itself with a single keypress, we
|
|
||||||
// simulate this double press here by feeding the keysym to the compose state
|
|
||||||
// twice.
|
|
||||||
|
|
||||||
compose_state.feed(self.keysym);
|
|
||||||
if matches!(compose_state.feed(self.keysym), ComposeStatus::Accepted(_)) {
|
|
||||||
// Extracting only a single `char` here *should* be fine, assuming that no
|
|
||||||
// dead key's non-combining variant ever occupies more than one `char`.
|
|
||||||
let text = compose_state.get_string(self.context.scratch_buffer);
|
|
||||||
let key = Key::Dead(text.and_then(|s| s.chars().next()));
|
|
||||||
(key, location)
|
|
||||||
} else {
|
|
||||||
(key, location)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
let key = self
|
|
||||||
.composed_text()
|
|
||||||
.unwrap_or_else(|_| self.context.keysym_to_utf8_raw(self.keysym))
|
|
||||||
.map(Key::Character)
|
|
||||||
.unwrap_or(key);
|
|
||||||
(key, location)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn key_without_modifiers(&mut self) -> (Key, KeyLocation) {
|
|
||||||
// This will become a pointer to an array which libxkbcommon owns, so we don't need to
|
|
||||||
// deallocate it.
|
|
||||||
let layout = self.context.state.layout(self.keycode);
|
|
||||||
let keysym = self.context.keymap.first_keysym_by_level(layout, self.keycode);
|
|
||||||
|
|
||||||
match self.keysym_to_key(keysym) {
|
|
||||||
Ok((key, location)) => (key, location),
|
|
||||||
Err((key, location)) => {
|
|
||||||
let key =
|
|
||||||
self.context.keysym_to_utf8_raw(keysym).map(Key::Character).unwrap_or(key);
|
|
||||||
(key, location)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn keysym_to_key(&self, keysym: u32) -> Result<(Key, KeyLocation), (Key, KeyLocation)> {
|
|
||||||
let location = keymap::keysym_location(keysym);
|
|
||||||
let key = keymap::keysym_to_key(keysym);
|
|
||||||
if matches!(key, Key::Unidentified(_)) {
|
|
||||||
Err((key, location))
|
|
||||||
} else {
|
|
||||||
Ok((key, location))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn text(&mut self) -> Option<SmolStr> {
|
|
||||||
self.composed_text().unwrap_or_else(|_| self.context.keysym_to_utf8_raw(self.keysym))
|
|
||||||
}
|
|
||||||
|
|
||||||
// The current behaviour makes it so composing a character overrides attempts to input a
|
|
||||||
// control character with the `Ctrl` key. We can potentially add a configuration option
|
|
||||||
// if someone specifically wants the oppsite behaviour.
|
|
||||||
pub fn text_with_all_modifiers(&mut self) -> Option<SmolStr> {
|
|
||||||
match self.composed_text() {
|
|
||||||
Ok(text) => text,
|
|
||||||
Err(_) => self.context.state.get_utf8_raw(self.keycode, self.context.scratch_buffer),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn composed_text(&mut self) -> Result<Option<SmolStr>, ()> {
|
|
||||||
match self.compose {
|
|
||||||
ComposeStatus::Accepted(status) => match status {
|
|
||||||
xkb_compose_status::XKB_COMPOSE_COMPOSED => {
|
|
||||||
let state = self.context.compose_state1.as_mut().unwrap();
|
|
||||||
Ok(state.get_string(self.context.scratch_buffer))
|
|
||||||
},
|
|
||||||
xkb_compose_status::XKB_COMPOSE_COMPOSING
|
|
||||||
| xkb_compose_status::XKB_COMPOSE_CANCELLED => Ok(None),
|
|
||||||
xkb_compose_status::XKB_COMPOSE_NOTHING => Err(()),
|
|
||||||
},
|
|
||||||
_ => Err(()),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub struct XkbContext {
|
|
||||||
context: NonNull<xkb_context>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl XkbContext {
|
|
||||||
pub fn new() -> Result<Self, Error> {
|
|
||||||
let context = unsafe { (XKBH.xkb_context_new)(xkb_context_flags::XKB_CONTEXT_NO_FLAGS) };
|
|
||||||
|
|
||||||
let context = match NonNull::new(context) {
|
|
||||||
Some(context) => context,
|
|
||||||
None => return Err(Error::XKBNotFound),
|
|
||||||
};
|
|
||||||
|
|
||||||
Ok(Self { context })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Drop for XkbContext {
|
|
||||||
fn drop(&mut self) {
|
|
||||||
unsafe {
|
|
||||||
(XKBH.xkb_context_unref)(self.context.as_ptr());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Deref for XkbContext {
|
|
||||||
type Target = NonNull<xkb_context>;
|
|
||||||
|
|
||||||
fn deref(&self) -> &Self::Target {
|
|
||||||
&self.context
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Shared logic for constructing a string with `xkb_compose_state_get_utf8` and
|
|
||||||
/// `xkb_state_key_get_utf8`.
|
|
||||||
fn make_string_with<F>(scratch_buffer: &mut Vec<u8>, mut f: F) -> Option<SmolStr>
|
|
||||||
where
|
|
||||||
F: FnMut(*mut c_char, usize) -> i32,
|
|
||||||
{
|
|
||||||
let size = f(ptr::null_mut(), 0);
|
|
||||||
if size == 0 {
|
|
||||||
return None;
|
|
||||||
}
|
|
||||||
let size = usize::try_from(size).unwrap();
|
|
||||||
scratch_buffer.clear();
|
|
||||||
// The allocated buffer must include space for the null-terminator.
|
|
||||||
scratch_buffer.reserve(size + 1);
|
|
||||||
unsafe {
|
|
||||||
let written = f(scratch_buffer.as_mut_ptr().cast(), scratch_buffer.capacity());
|
|
||||||
if usize::try_from(written).unwrap() != size {
|
|
||||||
// This will likely never happen.
|
|
||||||
return None;
|
|
||||||
}
|
|
||||||
scratch_buffer.set_len(size);
|
|
||||||
};
|
|
||||||
|
|
||||||
byte_slice_to_smol_str(scratch_buffer)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NOTE: This is track_caller so we can have more informative line numbers when logging
|
|
||||||
#[track_caller]
|
|
||||||
fn byte_slice_to_smol_str(bytes: &[u8]) -> Option<SmolStr> {
|
|
||||||
std::str::from_utf8(bytes)
|
|
||||||
.map(SmolStr::new)
|
|
||||||
.map_err(|e| {
|
|
||||||
tracing::warn!("UTF-8 received from libxkbcommon ({:?}) was invalid: {e}", bytes)
|
|
||||||
})
|
|
||||||
.ok()
|
|
||||||
}
|
|
||||||
@@ -1,189 +0,0 @@
|
|||||||
//! XKB state.
|
|
||||||
|
|
||||||
use std::os::raw::c_char;
|
|
||||||
use std::ptr::NonNull;
|
|
||||||
|
|
||||||
use smol_str::SmolStr;
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
use x11_dl::xlib_xcb::xcb_connection_t;
|
|
||||||
use xkbcommon_dl::{
|
|
||||||
self as xkb, xkb_keycode_t, xkb_keysym_t, xkb_layout_index_t, xkb_state, xkb_state_component,
|
|
||||||
};
|
|
||||||
|
|
||||||
use crate::platform_impl::common::xkb::keymap::XkbKeymap;
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
use crate::platform_impl::common::xkb::XKBXH;
|
|
||||||
use crate::platform_impl::common::xkb::{make_string_with, XKBH};
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub struct XkbState {
|
|
||||||
state: NonNull<xkb_state>,
|
|
||||||
modifiers: ModifiersState,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl XkbState {
|
|
||||||
#[cfg(wayland_platform)]
|
|
||||||
pub fn new_wayland(keymap: &XkbKeymap) -> Option<Self> {
|
|
||||||
let state = NonNull::new(unsafe { (XKBH.xkb_state_new)(keymap.as_ptr()) })?;
|
|
||||||
Some(Self::new_inner(state))
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub fn new_x11(xcb: *mut xcb_connection_t, keymap: &XkbKeymap) -> Option<Self> {
|
|
||||||
let state = unsafe {
|
|
||||||
(XKBXH.xkb_x11_state_new_from_device)(keymap.as_ptr(), xcb, keymap._core_keyboard_id)
|
|
||||||
};
|
|
||||||
let state = NonNull::new(state)?;
|
|
||||||
Some(Self::new_inner(state))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn new_inner(state: NonNull<xkb_state>) -> Self {
|
|
||||||
let modifiers = ModifiersState::default();
|
|
||||||
let mut this = Self { state, modifiers };
|
|
||||||
this.reload_modifiers();
|
|
||||||
this
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn get_one_sym_raw(&mut self, keycode: xkb_keycode_t) -> xkb_keysym_t {
|
|
||||||
unsafe { (XKBH.xkb_state_key_get_one_sym)(self.state.as_ptr(), keycode) }
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn layout(&mut self, key: xkb_keycode_t) -> xkb_layout_index_t {
|
|
||||||
unsafe { (XKBH.xkb_state_key_get_layout)(self.state.as_ptr(), key) }
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub fn depressed_modifiers(&mut self) -> xkb::xkb_mod_mask_t {
|
|
||||||
unsafe {
|
|
||||||
(XKBH.xkb_state_serialize_mods)(
|
|
||||||
self.state.as_ptr(),
|
|
||||||
xkb_state_component::XKB_STATE_MODS_DEPRESSED,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub fn latched_modifiers(&mut self) -> xkb::xkb_mod_mask_t {
|
|
||||||
unsafe {
|
|
||||||
(XKBH.xkb_state_serialize_mods)(
|
|
||||||
self.state.as_ptr(),
|
|
||||||
xkb_state_component::XKB_STATE_MODS_LATCHED,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(x11_platform)]
|
|
||||||
pub fn locked_modifiers(&mut self) -> xkb::xkb_mod_mask_t {
|
|
||||||
unsafe {
|
|
||||||
(XKBH.xkb_state_serialize_mods)(
|
|
||||||
self.state.as_ptr(),
|
|
||||||
xkb_state_component::XKB_STATE_MODS_LOCKED,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn get_utf8_raw(
|
|
||||||
&mut self,
|
|
||||||
keycode: xkb_keycode_t,
|
|
||||||
scratch_buffer: &mut Vec<u8>,
|
|
||||||
) -> Option<SmolStr> {
|
|
||||||
make_string_with(scratch_buffer, |ptr, len| unsafe {
|
|
||||||
(XKBH.xkb_state_key_get_utf8)(self.state.as_ptr(), keycode, ptr, len)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn modifiers(&self) -> ModifiersState {
|
|
||||||
self.modifiers
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn update_modifiers(
|
|
||||||
&mut self,
|
|
||||||
mods_depressed: u32,
|
|
||||||
mods_latched: u32,
|
|
||||||
mods_locked: u32,
|
|
||||||
depressed_group: u32,
|
|
||||||
latched_group: u32,
|
|
||||||
locked_group: u32,
|
|
||||||
) {
|
|
||||||
let mask = unsafe {
|
|
||||||
(XKBH.xkb_state_update_mask)(
|
|
||||||
self.state.as_ptr(),
|
|
||||||
mods_depressed,
|
|
||||||
mods_latched,
|
|
||||||
mods_locked,
|
|
||||||
depressed_group,
|
|
||||||
latched_group,
|
|
||||||
locked_group,
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
if mask.contains(xkb_state_component::XKB_STATE_MODS_EFFECTIVE) {
|
|
||||||
// Effective value of mods have changed, we need to update our state.
|
|
||||||
self.reload_modifiers();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Reload the modifiers.
|
|
||||||
fn reload_modifiers(&mut self) {
|
|
||||||
self.modifiers.ctrl = self.mod_name_is_active(xkb::XKB_MOD_NAME_CTRL);
|
|
||||||
self.modifiers.alt = self.mod_name_is_active(xkb::XKB_MOD_NAME_ALT);
|
|
||||||
self.modifiers.shift = self.mod_name_is_active(xkb::XKB_MOD_NAME_SHIFT);
|
|
||||||
self.modifiers.caps_lock = self.mod_name_is_active(xkb::XKB_MOD_NAME_CAPS);
|
|
||||||
self.modifiers.logo = self.mod_name_is_active(xkb::XKB_MOD_NAME_LOGO);
|
|
||||||
self.modifiers.num_lock = self.mod_name_is_active(xkb::XKB_MOD_NAME_NUM);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Check if the modifier is active within xkb.
|
|
||||||
fn mod_name_is_active(&mut self, name: &[u8]) -> bool {
|
|
||||||
unsafe {
|
|
||||||
(XKBH.xkb_state_mod_name_is_active)(
|
|
||||||
self.state.as_ptr(),
|
|
||||||
name.as_ptr() as *const c_char,
|
|
||||||
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
|
|
||||||
) > 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Drop for XkbState {
|
|
||||||
fn drop(&mut self) {
|
|
||||||
unsafe {
|
|
||||||
(XKBH.xkb_state_unref)(self.state.as_ptr());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents the current state of the keyboard modifiers
|
|
||||||
///
|
|
||||||
/// Each field of this struct represents a modifier and is `true` if this modifier is active.
|
|
||||||
///
|
|
||||||
/// For some modifiers, this means that the key is currently pressed, others are toggled
|
|
||||||
/// (like caps lock).
|
|
||||||
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
|
|
||||||
pub struct ModifiersState {
|
|
||||||
/// The "control" key
|
|
||||||
pub ctrl: bool,
|
|
||||||
/// The "alt" key
|
|
||||||
pub alt: bool,
|
|
||||||
/// The "shift" key
|
|
||||||
pub shift: bool,
|
|
||||||
/// The "Caps lock" key
|
|
||||||
pub caps_lock: bool,
|
|
||||||
/// The "logo" key
|
|
||||||
///
|
|
||||||
/// Also known as the "windows" key on most keyboards
|
|
||||||
pub logo: bool,
|
|
||||||
/// The "Num lock" key
|
|
||||||
pub num_lock: bool,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<ModifiersState> for crate::keyboard::ModifiersState {
|
|
||||||
fn from(mods: ModifiersState) -> crate::keyboard::ModifiersState {
|
|
||||||
let mut to_mods = crate::keyboard::ModifiersState::empty();
|
|
||||||
to_mods.set(crate::keyboard::ModifiersState::SHIFT, mods.shift);
|
|
||||||
to_mods.set(crate::keyboard::ModifiersState::CONTROL, mods.ctrl);
|
|
||||||
to_mods.set(crate::keyboard::ModifiersState::ALT, mods.alt);
|
|
||||||
to_mods.set(crate::keyboard::ModifiersState::SUPER, mods.logo);
|
|
||||||
to_mods
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +0,0 @@
|
|||||||
pub use x11_dl::error::OpenError;
|
|
||||||
pub use x11_dl::xcursor::*;
|
|
||||||
pub use x11_dl::xinput2::*;
|
|
||||||
pub use x11_dl::xlib::*;
|
|
||||||
pub use x11_dl::xlib_xcb::*;
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
use std::ffi::c_int;
|
|
||||||
use std::sync::Arc;
|
|
||||||
|
|
||||||
use x11_dl::xlib::{self, XEvent, XGenericEventCookie};
|
|
||||||
|
|
||||||
use crate::platform_impl::x11::XConnection;
|
|
||||||
|
|
||||||
/// XEvents of type GenericEvent store their actual data in an XGenericEventCookie data structure.
|
|
||||||
/// This is a wrapper to extract the cookie from a GenericEvent XEvent and release the cookie data
|
|
||||||
/// once it has been processed
|
|
||||||
pub struct GenericEventCookie {
|
|
||||||
cookie: XGenericEventCookie,
|
|
||||||
xconn: Arc<XConnection>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl GenericEventCookie {
|
|
||||||
pub fn from_event(xconn: Arc<XConnection>, event: XEvent) -> Option<GenericEventCookie> {
|
|
||||||
unsafe {
|
|
||||||
let mut cookie: XGenericEventCookie = From::from(event);
|
|
||||||
if (xconn.xlib.XGetEventData)(xconn.display, &mut cookie) == xlib::True {
|
|
||||||
Some(GenericEventCookie { cookie, xconn })
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn extension(&self) -> u8 {
|
|
||||||
self.cookie.extension as u8
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn evtype(&self) -> c_int {
|
|
||||||
self.cookie.evtype
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Borrow inner event data as `&T`.
|
|
||||||
///
|
|
||||||
/// ## SAFETY
|
|
||||||
///
|
|
||||||
/// The caller must ensure that the event has the `T` inside of it.
|
|
||||||
#[inline]
|
|
||||||
pub unsafe fn as_event<T>(&self) -> &T {
|
|
||||||
unsafe { &*(self.cookie.data as *const _) }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Drop for GenericEventCookie {
|
|
||||||
fn drop(&mut self) {
|
|
||||||
unsafe {
|
|
||||||
(self.xconn.xlib.XFreeEventData)(self.xconn.display, &mut self.cookie);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
//! Utilities for handling mouse events.
|
|
||||||
|
|
||||||
/// Recorded mouse delta designed to filter out noise.
|
|
||||||
pub struct Delta<T> {
|
|
||||||
x: T,
|
|
||||||
y: T,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Default> Default for Delta<T> {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self { x: Default::default(), y: Default::default() }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Default> Delta<T> {
|
|
||||||
pub(crate) fn set_x(&mut self, x: T) {
|
|
||||||
self.x = x;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn set_y(&mut self, y: T) {
|
|
||||||
self.y = y;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
macro_rules! consume {
|
|
||||||
($this:expr, $ty:ty) => {{
|
|
||||||
let this = $this;
|
|
||||||
let (x, y) = match (this.x.abs() < <$ty>::EPSILON, this.y.abs() < <$ty>::EPSILON) {
|
|
||||||
(true, true) => return None,
|
|
||||||
(false, true) => (this.x, 0.0),
|
|
||||||
(true, false) => (0.0, this.y),
|
|
||||||
(false, false) => (this.x, this.y),
|
|
||||||
};
|
|
||||||
|
|
||||||
Some((x, y))
|
|
||||||
}};
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Delta<f32> {
|
|
||||||
pub(crate) fn consume(self) -> Option<(f32, f32)> {
|
|
||||||
consume!(self, f32)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Delta<f64> {
|
|
||||||
pub(crate) fn consume(self) -> Option<(f64, f64)> {
|
|
||||||
consume!(self, f64)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
use std::collections::HashSet;
|
|
||||||
use std::slice;
|
|
||||||
|
|
||||||
use x11_dl::xlib::{KeyCode as XKeyCode, XModifierKeymap};
|
|
||||||
|
|
||||||
// Offsets within XModifierKeymap to each set of keycodes.
|
|
||||||
// We are only interested in Shift, Control, Alt, and Logo.
|
|
||||||
//
|
|
||||||
// There are 8 sets total. The order of keycode sets is:
|
|
||||||
// Shift, Lock, Control, Mod1 (Alt), Mod2, Mod3, Mod4 (Logo), Mod5
|
|
||||||
//
|
|
||||||
// https://tronche.com/gui/x/xlib/input/XSetModifierMapping.html
|
|
||||||
const NUM_MODS: usize = 8;
|
|
||||||
|
|
||||||
/// Track which keys are modifiers, so we can properly replay them when they were filtered.
|
|
||||||
#[derive(Debug, Default)]
|
|
||||||
pub struct ModifierKeymap {
|
|
||||||
// Maps keycodes to modifiers
|
|
||||||
modifiers: HashSet<XKeyCode>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ModifierKeymap {
|
|
||||||
pub fn new() -> ModifierKeymap {
|
|
||||||
ModifierKeymap::default()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn is_modifier(&self, keycode: XKeyCode) -> bool {
|
|
||||||
self.modifiers.contains(&keycode)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn reload_from_x_connection(&mut self, xconn: &super::XConnection) {
|
|
||||||
unsafe {
|
|
||||||
let keymap = (xconn.xlib.XGetModifierMapping)(xconn.display);
|
|
||||||
|
|
||||||
if keymap.is_null() {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
self.reset_from_x_keymap(&*keymap);
|
|
||||||
|
|
||||||
(xconn.xlib.XFreeModifiermap)(keymap);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn reset_from_x_keymap(&mut self, keymap: &XModifierKeymap) {
|
|
||||||
let keys_per_mod = keymap.max_keypermod as usize;
|
|
||||||
|
|
||||||
let keys = unsafe {
|
|
||||||
slice::from_raw_parts(keymap.modifiermap as *const _, keys_per_mod * NUM_MODS)
|
|
||||||
};
|
|
||||||
self.modifiers.clear();
|
|
||||||
for key in keys {
|
|
||||||
self.modifiers.insert(*key);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,424 +0,0 @@
|
|||||||
use std::cell::{Cell, RefCell};
|
|
||||||
use std::mem;
|
|
||||||
use std::rc::Weak;
|
|
||||||
use std::time::Instant;
|
|
||||||
|
|
||||||
use objc2::rc::Retained;
|
|
||||||
use objc2::{declare_class, msg_send_id, mutability, ClassType, DeclaredClass};
|
|
||||||
use objc2_app_kit::{NSApplication, NSApplicationActivationPolicy, NSApplicationDelegate};
|
|
||||||
use objc2_foundation::{MainThreadMarker, NSNotification, NSObject, NSObjectProtocol};
|
|
||||||
|
|
||||||
use super::event_handler::EventHandler;
|
|
||||||
use super::event_loop::{stop_app_immediately, ActiveEventLoop, PanicInfo};
|
|
||||||
use super::observer::{EventLoopWaker, RunLoop};
|
|
||||||
use super::{menu, WindowId, DEVICE_ID};
|
|
||||||
use crate::event::{DeviceEvent, Event, StartCause, WindowEvent};
|
|
||||||
use crate::event_loop::{ActiveEventLoop as RootActiveEventLoop, ControlFlow};
|
|
||||||
use crate::window::WindowId as RootWindowId;
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub(super) struct AppState {
|
|
||||||
activation_policy: NSApplicationActivationPolicy,
|
|
||||||
default_menu: bool,
|
|
||||||
activate_ignoring_other_apps: bool,
|
|
||||||
run_loop: RunLoop,
|
|
||||||
event_handler: EventHandler,
|
|
||||||
stop_on_launch: Cell<bool>,
|
|
||||||
stop_before_wait: Cell<bool>,
|
|
||||||
stop_after_wait: Cell<bool>,
|
|
||||||
stop_on_redraw: Cell<bool>,
|
|
||||||
/// Whether `applicationDidFinishLaunching:` has been run or not.
|
|
||||||
is_launched: Cell<bool>,
|
|
||||||
/// Whether an `EventLoop` is currently running.
|
|
||||||
is_running: Cell<bool>,
|
|
||||||
/// Whether the user has requested the event loop to exit.
|
|
||||||
exit: Cell<bool>,
|
|
||||||
control_flow: Cell<ControlFlow>,
|
|
||||||
waker: RefCell<EventLoopWaker>,
|
|
||||||
start_time: Cell<Option<Instant>>,
|
|
||||||
wait_timeout: Cell<Option<Instant>>,
|
|
||||||
pending_redraw: RefCell<Vec<WindowId>>,
|
|
||||||
// NOTE: This is strongly referenced by our `NSWindowDelegate` and our `NSView` subclass, and
|
|
||||||
// as such should be careful to not add fields that, in turn, strongly reference those.
|
|
||||||
}
|
|
||||||
|
|
||||||
declare_class!(
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub(super) struct ApplicationDelegate;
|
|
||||||
|
|
||||||
unsafe impl ClassType for ApplicationDelegate {
|
|
||||||
type Super = NSObject;
|
|
||||||
type Mutability = mutability::MainThreadOnly;
|
|
||||||
const NAME: &'static str = "WinitApplicationDelegate";
|
|
||||||
}
|
|
||||||
|
|
||||||
impl DeclaredClass for ApplicationDelegate {
|
|
||||||
type Ivars = AppState;
|
|
||||||
}
|
|
||||||
|
|
||||||
unsafe impl NSObjectProtocol for ApplicationDelegate {}
|
|
||||||
|
|
||||||
unsafe impl NSApplicationDelegate for ApplicationDelegate {
|
|
||||||
#[method(applicationDidFinishLaunching:)]
|
|
||||||
fn app_did_finish_launching(&self, notification: &NSNotification) {
|
|
||||||
self.did_finish_launching(notification)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[method(applicationWillTerminate:)]
|
|
||||||
fn app_will_terminate(&self, notification: &NSNotification) {
|
|
||||||
self.will_terminate(notification)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
impl ApplicationDelegate {
|
|
||||||
pub(super) fn new(
|
|
||||||
mtm: MainThreadMarker,
|
|
||||||
activation_policy: NSApplicationActivationPolicy,
|
|
||||||
default_menu: bool,
|
|
||||||
activate_ignoring_other_apps: bool,
|
|
||||||
) -> Retained<Self> {
|
|
||||||
let this = mtm.alloc().set_ivars(AppState {
|
|
||||||
activation_policy,
|
|
||||||
default_menu,
|
|
||||||
activate_ignoring_other_apps,
|
|
||||||
run_loop: RunLoop::main(mtm),
|
|
||||||
event_handler: EventHandler::new(),
|
|
||||||
stop_on_launch: Cell::new(false),
|
|
||||||
stop_before_wait: Cell::new(false),
|
|
||||||
stop_after_wait: Cell::new(false),
|
|
||||||
stop_on_redraw: Cell::new(false),
|
|
||||||
is_launched: Cell::new(false),
|
|
||||||
is_running: Cell::new(false),
|
|
||||||
exit: Cell::new(false),
|
|
||||||
control_flow: Cell::new(ControlFlow::default()),
|
|
||||||
waker: RefCell::new(EventLoopWaker::new()),
|
|
||||||
start_time: Cell::new(None),
|
|
||||||
wait_timeout: Cell::new(None),
|
|
||||||
pending_redraw: RefCell::new(vec![]),
|
|
||||||
});
|
|
||||||
unsafe { msg_send_id![super(this), init] }
|
|
||||||
}
|
|
||||||
|
|
||||||
// NOTE: This will, globally, only be run once, no matter how many
|
|
||||||
// `EventLoop`s the user creates.
|
|
||||||
fn did_finish_launching(&self, _notification: &NSNotification) {
|
|
||||||
trace_scope!("applicationDidFinishLaunching:");
|
|
||||||
self.ivars().is_launched.set(true);
|
|
||||||
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
// We need to delay setting the activation policy and activating the app
|
|
||||||
// until `applicationDidFinishLaunching` has been called. Otherwise the
|
|
||||||
// menu bar is initially unresponsive on macOS 10.15.
|
|
||||||
app.setActivationPolicy(self.ivars().activation_policy);
|
|
||||||
|
|
||||||
window_activation_hack(&app);
|
|
||||||
#[allow(deprecated)]
|
|
||||||
app.activateIgnoringOtherApps(self.ivars().activate_ignoring_other_apps);
|
|
||||||
|
|
||||||
if self.ivars().default_menu {
|
|
||||||
// The menubar initialization should be before the `NewEvents` event, to allow
|
|
||||||
// overriding of the default menu even if it's created
|
|
||||||
menu::initialize(&app);
|
|
||||||
}
|
|
||||||
|
|
||||||
self.ivars().waker.borrow_mut().start();
|
|
||||||
|
|
||||||
self.set_is_running(true);
|
|
||||||
self.dispatch_init_events();
|
|
||||||
|
|
||||||
// If the application is being launched via `EventLoop::pump_app_events()` then we'll
|
|
||||||
// want to stop the app once it is launched (and return to the external loop)
|
|
||||||
//
|
|
||||||
// In this case we still want to consider Winit's `EventLoop` to be "running",
|
|
||||||
// so we call `start_running()` above.
|
|
||||||
if self.ivars().stop_on_launch.get() {
|
|
||||||
// NOTE: the original idea had been to only stop the underlying `RunLoop`
|
|
||||||
// for the app but that didn't work as expected (`-[NSApplication run]`
|
|
||||||
// effectively ignored the attempt to stop the RunLoop and re-started it).
|
|
||||||
//
|
|
||||||
// So we return from `pump_events` by stopping the application.
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
stop_app_immediately(&app);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn will_terminate(&self, _notification: &NSNotification) {
|
|
||||||
trace_scope!("applicationWillTerminate:");
|
|
||||||
// TODO: Notify every window that it will be destroyed, like done in iOS?
|
|
||||||
self.internal_exit();
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn get(mtm: MainThreadMarker) -> Retained<Self> {
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
let delegate =
|
|
||||||
unsafe { app.delegate() }.expect("a delegate was not configured on the application");
|
|
||||||
if delegate.is_kind_of::<Self>() {
|
|
||||||
// SAFETY: Just checked that the delegate is an instance of `ApplicationDelegate`
|
|
||||||
unsafe { Retained::cast(delegate) }
|
|
||||||
} else {
|
|
||||||
panic!("tried to get a delegate that was not the one Winit has registered")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Place the event handler in the application delegate for the duration
|
|
||||||
/// of the given closure.
|
|
||||||
pub fn set_event_handler<R>(
|
|
||||||
&self,
|
|
||||||
handler: impl FnMut(Event<HandlePendingUserEvents>, &RootActiveEventLoop),
|
|
||||||
closure: impl FnOnce() -> R,
|
|
||||||
) -> R {
|
|
||||||
self.ivars().event_handler.set(handler, closure)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// If `pump_events` is called to progress the event loop then we
|
|
||||||
/// bootstrap the event loop via `-[NSApplication run]` but will use
|
|
||||||
/// `CFRunLoopRunInMode` for subsequent calls to `pump_events`.
|
|
||||||
pub fn set_stop_on_launch(&self) {
|
|
||||||
self.ivars().stop_on_launch.set(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_stop_before_wait(&self, value: bool) {
|
|
||||||
self.ivars().stop_before_wait.set(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_stop_after_wait(&self, value: bool) {
|
|
||||||
self.ivars().stop_after_wait.set(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_stop_on_redraw(&self, value: bool) {
|
|
||||||
self.ivars().stop_on_redraw.set(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_wait_timeout(&self, value: Option<Instant>) {
|
|
||||||
self.ivars().wait_timeout.set(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Clears the `running` state and resets the `control_flow` state when an `EventLoop` exits.
|
|
||||||
///
|
|
||||||
/// NOTE: that if the `NSApplication` has been launched then that state is preserved,
|
|
||||||
/// and we won't need to re-launch the app if subsequent EventLoops are run.
|
|
||||||
pub fn internal_exit(&self) {
|
|
||||||
self.handle_event(Event::LoopExiting);
|
|
||||||
|
|
||||||
self.set_is_running(false);
|
|
||||||
self.set_stop_on_redraw(false);
|
|
||||||
self.set_stop_before_wait(false);
|
|
||||||
self.set_stop_after_wait(false);
|
|
||||||
self.set_wait_timeout(None);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn is_launched(&self) -> bool {
|
|
||||||
self.ivars().is_launched.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_is_running(&self, value: bool) {
|
|
||||||
self.ivars().is_running.set(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn is_running(&self) -> bool {
|
|
||||||
self.ivars().is_running.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn exit(&self) {
|
|
||||||
self.ivars().exit.set(true)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn clear_exit(&self) {
|
|
||||||
self.ivars().exit.set(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn exiting(&self) -> bool {
|
|
||||||
self.ivars().exit.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_control_flow(&self, value: ControlFlow) {
|
|
||||||
self.ivars().control_flow.set(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn control_flow(&self) -> ControlFlow {
|
|
||||||
self.ivars().control_flow.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn maybe_queue_window_event(&self, window_id: WindowId, event: WindowEvent) {
|
|
||||||
self.maybe_queue_event(Event::WindowEvent { window_id: RootWindowId(window_id), event });
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn handle_window_event(&self, window_id: WindowId, event: WindowEvent) {
|
|
||||||
self.handle_event(Event::WindowEvent { window_id: RootWindowId(window_id), event });
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn maybe_queue_device_event(&self, event: DeviceEvent) {
|
|
||||||
self.maybe_queue_event(Event::DeviceEvent { device_id: DEVICE_ID, event });
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn handle_redraw(&self, window_id: WindowId) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
// Redraw request might come out of order from the OS.
|
|
||||||
// -> Don't go back into the event handler when our callstack originates from there
|
|
||||||
if !self.ivars().event_handler.in_use() {
|
|
||||||
self.handle_event(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window_id),
|
|
||||||
event: WindowEvent::RedrawRequested,
|
|
||||||
});
|
|
||||||
|
|
||||||
// `pump_events` will request to stop immediately _after_ dispatching RedrawRequested
|
|
||||||
// events as a way to ensure that `pump_events` can't block an external loop
|
|
||||||
// indefinitely
|
|
||||||
if self.ivars().stop_on_redraw.get() {
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
stop_app_immediately(&app);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn queue_redraw(&self, window_id: WindowId) {
|
|
||||||
let mut pending_redraw = self.ivars().pending_redraw.borrow_mut();
|
|
||||||
if !pending_redraw.contains(&window_id) {
|
|
||||||
pending_redraw.push(window_id);
|
|
||||||
}
|
|
||||||
self.ivars().run_loop.wakeup();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[track_caller]
|
|
||||||
fn maybe_queue_event(&self, event: Event<HandlePendingUserEvents>) {
|
|
||||||
// Most programmer actions in AppKit (e.g. change window fullscreen, set focused, etc.)
|
|
||||||
// result in an event being queued, and applied at a later point.
|
|
||||||
//
|
|
||||||
// However, it is not documented which actions do this, and which ones are done immediately,
|
|
||||||
// so to make sure that we don't encounter re-entrancy issues, we first check if we're
|
|
||||||
// currently handling another event, and if we are, we queue the event instead.
|
|
||||||
if !self.ivars().event_handler.in_use() {
|
|
||||||
self.handle_event(event);
|
|
||||||
} else {
|
|
||||||
tracing::debug!(?event, "had to queue event since another is currently being handled");
|
|
||||||
let this = self.retain();
|
|
||||||
self.ivars().run_loop.queue_closure(move || this.handle_event(event));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[track_caller]
|
|
||||||
fn handle_event(&self, event: Event<HandlePendingUserEvents>) {
|
|
||||||
self.ivars().event_handler.handle_event(event, &ActiveEventLoop::new_root(self.retain()))
|
|
||||||
}
|
|
||||||
|
|
||||||
/// dispatch `NewEvents(Init)` + `Resumed`
|
|
||||||
pub fn dispatch_init_events(&self) {
|
|
||||||
self.handle_event(Event::NewEvents(StartCause::Init));
|
|
||||||
// NB: For consistency all platforms must emit a 'resumed' event even though macOS
|
|
||||||
// applications don't themselves have a formal suspend/resume lifecycle.
|
|
||||||
self.handle_event(Event::Resumed);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Called by RunLoopObserver after finishing waiting for new events
|
|
||||||
pub fn wakeup(&self, panic_info: Weak<PanicInfo>) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
let panic_info = panic_info
|
|
||||||
.upgrade()
|
|
||||||
.expect("The panic info must exist here. This failure indicates a developer error.");
|
|
||||||
|
|
||||||
// Return when in event handler due to https://github.com/rust-windowing/winit/issues/1779
|
|
||||||
if panic_info.is_panicking() || !self.ivars().event_handler.ready() || !self.is_running() {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if self.ivars().stop_after_wait.get() {
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
stop_app_immediately(&app);
|
|
||||||
}
|
|
||||||
|
|
||||||
let start = self.ivars().start_time.get().unwrap();
|
|
||||||
let cause = match self.control_flow() {
|
|
||||||
ControlFlow::Poll => StartCause::Poll,
|
|
||||||
ControlFlow::Wait => StartCause::WaitCancelled { start, requested_resume: None },
|
|
||||||
ControlFlow::WaitUntil(requested_resume) => {
|
|
||||||
if Instant::now() >= requested_resume {
|
|
||||||
StartCause::ResumeTimeReached { start, requested_resume }
|
|
||||||
} else {
|
|
||||||
StartCause::WaitCancelled { start, requested_resume: Some(requested_resume) }
|
|
||||||
}
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
self.handle_event(Event::NewEvents(cause));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Called by RunLoopObserver before waiting for new events
|
|
||||||
pub fn cleared(&self, panic_info: Weak<PanicInfo>) {
|
|
||||||
let mtm = MainThreadMarker::from(self);
|
|
||||||
let panic_info = panic_info
|
|
||||||
.upgrade()
|
|
||||||
.expect("The panic info must exist here. This failure indicates a developer error.");
|
|
||||||
|
|
||||||
// Return when in event handler due to https://github.com/rust-windowing/winit/issues/1779
|
|
||||||
// XXX: how does it make sense that `event_handler.ready()` can ever return `false` here if
|
|
||||||
// we're about to return to the `CFRunLoop` to poll for new events?
|
|
||||||
if panic_info.is_panicking() || !self.ivars().event_handler.ready() || !self.is_running() {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
self.handle_event(Event::UserEvent(HandlePendingUserEvents));
|
|
||||||
|
|
||||||
let redraw = mem::take(&mut *self.ivars().pending_redraw.borrow_mut());
|
|
||||||
for window_id in redraw {
|
|
||||||
self.handle_event(Event::WindowEvent {
|
|
||||||
window_id: RootWindowId(window_id),
|
|
||||||
event: WindowEvent::RedrawRequested,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
self.handle_event(Event::AboutToWait);
|
|
||||||
|
|
||||||
if self.exiting() {
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
stop_app_immediately(&app);
|
|
||||||
}
|
|
||||||
|
|
||||||
if self.ivars().stop_before_wait.get() {
|
|
||||||
let app = NSApplication::sharedApplication(mtm);
|
|
||||||
stop_app_immediately(&app);
|
|
||||||
}
|
|
||||||
self.ivars().start_time.set(Some(Instant::now()));
|
|
||||||
let wait_timeout = self.ivars().wait_timeout.get(); // configured by pump_events
|
|
||||||
let app_timeout = match self.control_flow() {
|
|
||||||
ControlFlow::Wait => None,
|
|
||||||
ControlFlow::Poll => Some(Instant::now()),
|
|
||||||
ControlFlow::WaitUntil(instant) => Some(instant),
|
|
||||||
};
|
|
||||||
self.ivars().waker.borrow_mut().start_at(min_timeout(wait_timeout, app_timeout));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub(crate) struct HandlePendingUserEvents;
|
|
||||||
|
|
||||||
/// Returns the minimum `Option<Instant>`, taking into account that `None`
|
|
||||||
/// equates to an infinite timeout, not a zero timeout (so can't just use
|
|
||||||
/// `Option::min`)
|
|
||||||
fn min_timeout(a: Option<Instant>, b: Option<Instant>) -> Option<Instant> {
|
|
||||||
a.map_or(b, |a_timeout| b.map_or(Some(a_timeout), |b_timeout| Some(a_timeout.min(b_timeout))))
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A hack to make activation of multiple windows work when creating them before
|
|
||||||
/// `applicationDidFinishLaunching:` / `Event::Event::NewEvents(StartCause::Init)`.
|
|
||||||
///
|
|
||||||
/// Alternative to this would be the user calling `window.set_visible(true)` in
|
|
||||||
/// `StartCause::Init`.
|
|
||||||
///
|
|
||||||
/// If this becomes too bothersome to maintain, it can probably be removed
|
|
||||||
/// without too much damage.
|
|
||||||
fn window_activation_hack(app: &NSApplication) {
|
|
||||||
// TODO: Proper ordering of the windows
|
|
||||||
app.windows().into_iter().for_each(|window| {
|
|
||||||
// Call `makeKeyAndOrderFront` if it was called on the window in `WinitWindow::new`
|
|
||||||
// This way we preserve the user's desired initial visibility status
|
|
||||||
// TODO: Also filter on the type/"level" of the window, and maybe other things?
|
|
||||||
if window.isVisible() {
|
|
||||||
tracing::trace!("Activating visible window");
|
|
||||||
window.makeKeyAndOrderFront(None);
|
|
||||||
} else {
|
|
||||||
tracing::trace!("Skipping activating invisible window");
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,139 +0,0 @@
|
|||||||
use std::cell::RefCell;
|
|
||||||
use std::{fmt, mem};
|
|
||||||
|
|
||||||
use super::app_state::HandlePendingUserEvents;
|
|
||||||
use crate::event::Event;
|
|
||||||
use crate::event_loop::ActiveEventLoop as RootActiveEventLoop;
|
|
||||||
|
|
||||||
struct EventHandlerData {
|
|
||||||
#[allow(clippy::type_complexity)]
|
|
||||||
handler: Box<dyn FnMut(Event<HandlePendingUserEvents>, &RootActiveEventLoop) + 'static>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl fmt::Debug for EventHandlerData {
|
|
||||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
||||||
f.debug_struct("EventHandlerData").finish_non_exhaustive()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub(crate) struct EventHandler {
|
|
||||||
/// This can be in the following states:
|
|
||||||
/// - Not registered by the event loop (None).
|
|
||||||
/// - Present (Some(handler)).
|
|
||||||
/// - Currently executing the handler / in use (RefCell borrowed).
|
|
||||||
inner: RefCell<Option<EventHandlerData>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl EventHandler {
|
|
||||||
pub(crate) const fn new() -> Self {
|
|
||||||
Self { inner: RefCell::new(None) }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Set the event loop handler for the duration of the given closure.
|
|
||||||
///
|
|
||||||
/// This is similar to using the `scoped-tls` or `scoped-tls-hkt` crates
|
|
||||||
/// to store the handler in a thread local, such that it can be accessed
|
|
||||||
/// from within the closure.
|
|
||||||
pub(crate) fn set<'handler, R>(
|
|
||||||
&self,
|
|
||||||
handler: impl FnMut(Event<HandlePendingUserEvents>, &RootActiveEventLoop) + 'handler,
|
|
||||||
closure: impl FnOnce() -> R,
|
|
||||||
) -> R {
|
|
||||||
// SAFETY: We extend the lifetime of the handler here so that we can
|
|
||||||
// store it in `EventHandler`'s `RefCell`.
|
|
||||||
//
|
|
||||||
// This is sound, since we make sure to unset the handler again at the
|
|
||||||
// end of this function, and as such the lifetime isn't actually
|
|
||||||
// extended beyond `'handler`.
|
|
||||||
let handler = unsafe {
|
|
||||||
mem::transmute::<
|
|
||||||
Box<dyn FnMut(Event<HandlePendingUserEvents>, &RootActiveEventLoop) + 'handler>,
|
|
||||||
Box<dyn FnMut(Event<HandlePendingUserEvents>, &RootActiveEventLoop) + 'static>,
|
|
||||||
>(Box::new(handler))
|
|
||||||
};
|
|
||||||
|
|
||||||
match self.inner.try_borrow_mut().as_deref_mut() {
|
|
||||||
Ok(Some(_)) => {
|
|
||||||
unreachable!("tried to set handler while another was already set");
|
|
||||||
},
|
|
||||||
Ok(data @ None) => {
|
|
||||||
*data = Some(EventHandlerData { handler });
|
|
||||||
},
|
|
||||||
Err(_) => {
|
|
||||||
unreachable!("tried to set handler that is currently in use");
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
struct ClearOnDrop<'a>(&'a EventHandler);
|
|
||||||
|
|
||||||
impl Drop for ClearOnDrop<'_> {
|
|
||||||
fn drop(&mut self) {
|
|
||||||
match self.0.inner.try_borrow_mut().as_deref_mut() {
|
|
||||||
Ok(data @ Some(_)) => {
|
|
||||||
*data = None;
|
|
||||||
},
|
|
||||||
Ok(None) => {
|
|
||||||
tracing::error!("tried to clear handler, but no handler was set");
|
|
||||||
},
|
|
||||||
Err(_) => {
|
|
||||||
// Note: This is not expected to ever happen, this
|
|
||||||
// module generally controls the `RefCell`, and
|
|
||||||
// prevents it from ever being borrowed outside of it.
|
|
||||||
//
|
|
||||||
// But if it _does_ happen, it is a serious error, and
|
|
||||||
// we must abort the process, it'd be unsound if we
|
|
||||||
// weren't able to unset the handler.
|
|
||||||
eprintln!("tried to clear handler that is currently in use");
|
|
||||||
std::process::abort();
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let _clear_on_drop = ClearOnDrop(self);
|
|
||||||
|
|
||||||
// Note: The RefCell should not be borrowed while executing the
|
|
||||||
// closure, that'd defeat the whole point.
|
|
||||||
closure()
|
|
||||||
|
|
||||||
// `_clear_on_drop` will be dropped here, or when unwinding, ensuring
|
|
||||||
// soundness.
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn in_use(&self) -> bool {
|
|
||||||
self.inner.try_borrow().is_err()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn ready(&self) -> bool {
|
|
||||||
matches!(self.inner.try_borrow().as_deref(), Ok(Some(_)))
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn handle_event(
|
|
||||||
&self,
|
|
||||||
event: Event<HandlePendingUserEvents>,
|
|
||||||
event_loop: &RootActiveEventLoop,
|
|
||||||
) {
|
|
||||||
match self.inner.try_borrow_mut().as_deref_mut() {
|
|
||||||
Ok(Some(EventHandlerData { handler })) => {
|
|
||||||
// It is important that we keep the reference borrowed here,
|
|
||||||
// so that `in_use` can properly detect that the handler is
|
|
||||||
// still in use.
|
|
||||||
//
|
|
||||||
// If the handler unwinds, the `RefMut` will ensure that the
|
|
||||||
// handler is no longer borrowed.
|
|
||||||
(handler)(event, event_loop);
|
|
||||||
},
|
|
||||||
Ok(None) => {
|
|
||||||
// `NSApplication`, our app delegate and this handler are all
|
|
||||||
// global state and so it's not impossible that we could get
|
|
||||||
// an event after the application has exited the `EventLoop`.
|
|
||||||
tracing::error!("tried to run event handler, but no handler was set");
|
|
||||||
},
|
|
||||||
Err(_) => {
|
|
||||||
// Prevent re-entrancy.
|
|
||||||
panic!("tried to handle event while another event is currently being handled");
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
use tracing::trace;
|
|
||||||
|
|
||||||
macro_rules! trace_scope {
|
|
||||||
($s:literal) => {
|
|
||||||
let _crate = $crate::platform_impl::platform::util::TraceGuard::new(module_path!(), $s);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) struct TraceGuard {
|
|
||||||
module_path: &'static str,
|
|
||||||
called_from_fn: &'static str,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TraceGuard {
|
|
||||||
#[inline]
|
|
||||||
pub(crate) fn new(module_path: &'static str, called_from_fn: &'static str) -> Self {
|
|
||||||
trace!(target = module_path, "Triggered `{}`", called_from_fn);
|
|
||||||
Self { module_path, called_from_fn }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Drop for TraceGuard {
|
|
||||||
#[inline]
|
|
||||||
fn drop(&mut self) {
|
|
||||||
trace!(target = self.module_path, "Completed `{}`", self.called_from_fn);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
||||||
pub struct DeviceId(pub i32);
|
|
||||||
|
|
||||||
impl DeviceId {
|
|
||||||
pub const unsafe fn dummy() -> Self {
|
|
||||||
Self(0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
use super::backend;
|
|
||||||
|
|
||||||
use web_time::Instant;
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub enum State {
|
|
||||||
Init,
|
|
||||||
WaitUntil { _timeout: backend::Schedule, start: Instant, end: Instant },
|
|
||||||
Wait { start: Instant },
|
|
||||||
Poll { _request: backend::Schedule },
|
|
||||||
Exit,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl State {
|
|
||||||
pub fn exiting(&self) -> bool {
|
|
||||||
matches!(self, State::Exit)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,522 +0,0 @@
|
|||||||
use smol_str::SmolStr;
|
|
||||||
|
|
||||||
use crate::keyboard::{Key, KeyCode, NamedKey, NativeKey, NativeKeyCode, PhysicalKey};
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
|
|
||||||
pub(crate) struct KeyEventExtra;
|
|
||||||
|
|
||||||
impl Key {
|
|
||||||
pub(crate) fn from_key_attribute_value(kav: &str) -> Self {
|
|
||||||
Key::Named(match kav {
|
|
||||||
"Unidentified" => return Key::Unidentified(NativeKey::Web(SmolStr::new(kav))),
|
|
||||||
"Dead" => return Key::Dead(None),
|
|
||||||
"Alt" => NamedKey::Alt,
|
|
||||||
"AltGraph" => NamedKey::AltGraph,
|
|
||||||
"CapsLock" => NamedKey::CapsLock,
|
|
||||||
"Control" => NamedKey::Control,
|
|
||||||
"Fn" => NamedKey::Fn,
|
|
||||||
"FnLock" => NamedKey::FnLock,
|
|
||||||
"NumLock" => NamedKey::NumLock,
|
|
||||||
"ScrollLock" => NamedKey::ScrollLock,
|
|
||||||
"Shift" => NamedKey::Shift,
|
|
||||||
"Symbol" => NamedKey::Symbol,
|
|
||||||
"SymbolLock" => NamedKey::SymbolLock,
|
|
||||||
"Hyper" => NamedKey::Hyper,
|
|
||||||
"Meta" => NamedKey::Super,
|
|
||||||
"Enter" => NamedKey::Enter,
|
|
||||||
"Tab" => NamedKey::Tab,
|
|
||||||
" " => NamedKey::Space,
|
|
||||||
"ArrowDown" => NamedKey::ArrowDown,
|
|
||||||
"ArrowLeft" => NamedKey::ArrowLeft,
|
|
||||||
"ArrowRight" => NamedKey::ArrowRight,
|
|
||||||
"ArrowUp" => NamedKey::ArrowUp,
|
|
||||||
"End" => NamedKey::End,
|
|
||||||
"Home" => NamedKey::Home,
|
|
||||||
"PageDown" => NamedKey::PageDown,
|
|
||||||
"PageUp" => NamedKey::PageUp,
|
|
||||||
"Backspace" => NamedKey::Backspace,
|
|
||||||
"Clear" => NamedKey::Clear,
|
|
||||||
"Copy" => NamedKey::Copy,
|
|
||||||
"CrSel" => NamedKey::CrSel,
|
|
||||||
"Cut" => NamedKey::Cut,
|
|
||||||
"Delete" => NamedKey::Delete,
|
|
||||||
"EraseEof" => NamedKey::EraseEof,
|
|
||||||
"ExSel" => NamedKey::ExSel,
|
|
||||||
"Insert" => NamedKey::Insert,
|
|
||||||
"Paste" => NamedKey::Paste,
|
|
||||||
"Redo" => NamedKey::Redo,
|
|
||||||
"Undo" => NamedKey::Undo,
|
|
||||||
"Accept" => NamedKey::Accept,
|
|
||||||
"Again" => NamedKey::Again,
|
|
||||||
"Attn" => NamedKey::Attn,
|
|
||||||
"Cancel" => NamedKey::Cancel,
|
|
||||||
"ContextMenu" => NamedKey::ContextMenu,
|
|
||||||
"Escape" => NamedKey::Escape,
|
|
||||||
"Execute" => NamedKey::Execute,
|
|
||||||
"Find" => NamedKey::Find,
|
|
||||||
"Help" => NamedKey::Help,
|
|
||||||
"Pause" => NamedKey::Pause,
|
|
||||||
"Play" => NamedKey::Play,
|
|
||||||
"Props" => NamedKey::Props,
|
|
||||||
"Select" => NamedKey::Select,
|
|
||||||
"ZoomIn" => NamedKey::ZoomIn,
|
|
||||||
"ZoomOut" => NamedKey::ZoomOut,
|
|
||||||
"BrightnessDown" => NamedKey::BrightnessDown,
|
|
||||||
"BrightnessUp" => NamedKey::BrightnessUp,
|
|
||||||
"Eject" => NamedKey::Eject,
|
|
||||||
"LogOff" => NamedKey::LogOff,
|
|
||||||
"Power" => NamedKey::Power,
|
|
||||||
"PowerOff" => NamedKey::PowerOff,
|
|
||||||
"PrintScreen" => NamedKey::PrintScreen,
|
|
||||||
"Hibernate" => NamedKey::Hibernate,
|
|
||||||
"Standby" => NamedKey::Standby,
|
|
||||||
"WakeUp" => NamedKey::WakeUp,
|
|
||||||
"AllCandidates" => NamedKey::AllCandidates,
|
|
||||||
"Alphanumeric" => NamedKey::Alphanumeric,
|
|
||||||
"CodeInput" => NamedKey::CodeInput,
|
|
||||||
"Compose" => NamedKey::Compose,
|
|
||||||
"Convert" => NamedKey::Convert,
|
|
||||||
"FinalMode" => NamedKey::FinalMode,
|
|
||||||
"GroupFirst" => NamedKey::GroupFirst,
|
|
||||||
"GroupLast" => NamedKey::GroupLast,
|
|
||||||
"GroupNext" => NamedKey::GroupNext,
|
|
||||||
"GroupPrevious" => NamedKey::GroupPrevious,
|
|
||||||
"ModeChange" => NamedKey::ModeChange,
|
|
||||||
"NextCandidate" => NamedKey::NextCandidate,
|
|
||||||
"NonConvert" => NamedKey::NonConvert,
|
|
||||||
"PreviousCandidate" => NamedKey::PreviousCandidate,
|
|
||||||
"Process" => NamedKey::Process,
|
|
||||||
"SingleCandidate" => NamedKey::SingleCandidate,
|
|
||||||
"HangulMode" => NamedKey::HangulMode,
|
|
||||||
"HanjaMode" => NamedKey::HanjaMode,
|
|
||||||
"JunjaMode" => NamedKey::JunjaMode,
|
|
||||||
"Eisu" => NamedKey::Eisu,
|
|
||||||
"Hankaku" => NamedKey::Hankaku,
|
|
||||||
"Hiragana" => NamedKey::Hiragana,
|
|
||||||
"HiraganaKatakana" => NamedKey::HiraganaKatakana,
|
|
||||||
"KanaMode" => NamedKey::KanaMode,
|
|
||||||
"KanjiMode" => NamedKey::KanjiMode,
|
|
||||||
"Katakana" => NamedKey::Katakana,
|
|
||||||
"Romaji" => NamedKey::Romaji,
|
|
||||||
"Zenkaku" => NamedKey::Zenkaku,
|
|
||||||
"ZenkakuHankaku" => NamedKey::ZenkakuHankaku,
|
|
||||||
"Soft1" => NamedKey::Soft1,
|
|
||||||
"Soft2" => NamedKey::Soft2,
|
|
||||||
"Soft3" => NamedKey::Soft3,
|
|
||||||
"Soft4" => NamedKey::Soft4,
|
|
||||||
"ChannelDown" => NamedKey::ChannelDown,
|
|
||||||
"ChannelUp" => NamedKey::ChannelUp,
|
|
||||||
"Close" => NamedKey::Close,
|
|
||||||
"MailForward" => NamedKey::MailForward,
|
|
||||||
"MailReply" => NamedKey::MailReply,
|
|
||||||
"MailSend" => NamedKey::MailSend,
|
|
||||||
"MediaClose" => NamedKey::MediaClose,
|
|
||||||
"MediaFastForward" => NamedKey::MediaFastForward,
|
|
||||||
"MediaPause" => NamedKey::MediaPause,
|
|
||||||
"MediaPlay" => NamedKey::MediaPlay,
|
|
||||||
"MediaPlayPause" => NamedKey::MediaPlayPause,
|
|
||||||
"MediaRecord" => NamedKey::MediaRecord,
|
|
||||||
"MediaRewind" => NamedKey::MediaRewind,
|
|
||||||
"MediaStop" => NamedKey::MediaStop,
|
|
||||||
"MediaTrackNext" => NamedKey::MediaTrackNext,
|
|
||||||
"MediaTrackPrevious" => NamedKey::MediaTrackPrevious,
|
|
||||||
"New" => NamedKey::New,
|
|
||||||
"Open" => NamedKey::Open,
|
|
||||||
"Print" => NamedKey::Print,
|
|
||||||
"Save" => NamedKey::Save,
|
|
||||||
"SpellCheck" => NamedKey::SpellCheck,
|
|
||||||
"Key11" => NamedKey::Key11,
|
|
||||||
"Key12" => NamedKey::Key12,
|
|
||||||
"AudioBalanceLeft" => NamedKey::AudioBalanceLeft,
|
|
||||||
"AudioBalanceRight" => NamedKey::AudioBalanceRight,
|
|
||||||
"AudioBassBoostDown" => NamedKey::AudioBassBoostDown,
|
|
||||||
"AudioBassBoostToggle" => NamedKey::AudioBassBoostToggle,
|
|
||||||
"AudioBassBoostUp" => NamedKey::AudioBassBoostUp,
|
|
||||||
"AudioFaderFront" => NamedKey::AudioFaderFront,
|
|
||||||
"AudioFaderRear" => NamedKey::AudioFaderRear,
|
|
||||||
"AudioSurroundModeNext" => NamedKey::AudioSurroundModeNext,
|
|
||||||
"AudioTrebleDown" => NamedKey::AudioTrebleDown,
|
|
||||||
"AudioTrebleUp" => NamedKey::AudioTrebleUp,
|
|
||||||
"AudioVolumeDown" => NamedKey::AudioVolumeDown,
|
|
||||||
"AudioVolumeUp" => NamedKey::AudioVolumeUp,
|
|
||||||
"AudioVolumeMute" => NamedKey::AudioVolumeMute,
|
|
||||||
"MicrophoneToggle" => NamedKey::MicrophoneToggle,
|
|
||||||
"MicrophoneVolumeDown" => NamedKey::MicrophoneVolumeDown,
|
|
||||||
"MicrophoneVolumeUp" => NamedKey::MicrophoneVolumeUp,
|
|
||||||
"MicrophoneVolumeMute" => NamedKey::MicrophoneVolumeMute,
|
|
||||||
"SpeechCorrectionList" => NamedKey::SpeechCorrectionList,
|
|
||||||
"SpeechInputToggle" => NamedKey::SpeechInputToggle,
|
|
||||||
"LaunchApplication1" => NamedKey::LaunchApplication1,
|
|
||||||
"LaunchApplication2" => NamedKey::LaunchApplication2,
|
|
||||||
"LaunchCalendar" => NamedKey::LaunchCalendar,
|
|
||||||
"LaunchContacts" => NamedKey::LaunchContacts,
|
|
||||||
"LaunchMail" => NamedKey::LaunchMail,
|
|
||||||
"LaunchMediaPlayer" => NamedKey::LaunchMediaPlayer,
|
|
||||||
"LaunchMusicPlayer" => NamedKey::LaunchMusicPlayer,
|
|
||||||
"LaunchPhone" => NamedKey::LaunchPhone,
|
|
||||||
"LaunchScreenSaver" => NamedKey::LaunchScreenSaver,
|
|
||||||
"LaunchSpreadsheet" => NamedKey::LaunchSpreadsheet,
|
|
||||||
"LaunchWebBrowser" => NamedKey::LaunchWebBrowser,
|
|
||||||
"LaunchWebCam" => NamedKey::LaunchWebCam,
|
|
||||||
"LaunchWordProcessor" => NamedKey::LaunchWordProcessor,
|
|
||||||
"BrowserBack" => NamedKey::BrowserBack,
|
|
||||||
"BrowserFavorites" => NamedKey::BrowserFavorites,
|
|
||||||
"BrowserForward" => NamedKey::BrowserForward,
|
|
||||||
"BrowserHome" => NamedKey::BrowserHome,
|
|
||||||
"BrowserRefresh" => NamedKey::BrowserRefresh,
|
|
||||||
"BrowserSearch" => NamedKey::BrowserSearch,
|
|
||||||
"BrowserStop" => NamedKey::BrowserStop,
|
|
||||||
"AppSwitch" => NamedKey::AppSwitch,
|
|
||||||
"Call" => NamedKey::Call,
|
|
||||||
"Camera" => NamedKey::Camera,
|
|
||||||
"CameraFocus" => NamedKey::CameraFocus,
|
|
||||||
"EndCall" => NamedKey::EndCall,
|
|
||||||
"GoBack" => NamedKey::GoBack,
|
|
||||||
"GoHome" => NamedKey::GoHome,
|
|
||||||
"HeadsetHook" => NamedKey::HeadsetHook,
|
|
||||||
"LastNumberRedial" => NamedKey::LastNumberRedial,
|
|
||||||
"Notification" => NamedKey::Notification,
|
|
||||||
"MannerMode" => NamedKey::MannerMode,
|
|
||||||
"VoiceDial" => NamedKey::VoiceDial,
|
|
||||||
"TV" => NamedKey::TV,
|
|
||||||
"TV3DMode" => NamedKey::TV3DMode,
|
|
||||||
"TVAntennaCable" => NamedKey::TVAntennaCable,
|
|
||||||
"TVAudioDescription" => NamedKey::TVAudioDescription,
|
|
||||||
"TVAudioDescriptionMixDown" => NamedKey::TVAudioDescriptionMixDown,
|
|
||||||
"TVAudioDescriptionMixUp" => NamedKey::TVAudioDescriptionMixUp,
|
|
||||||
"TVContentsMenu" => NamedKey::TVContentsMenu,
|
|
||||||
"TVDataService" => NamedKey::TVDataService,
|
|
||||||
"TVInput" => NamedKey::TVInput,
|
|
||||||
"TVInputComponent1" => NamedKey::TVInputComponent1,
|
|
||||||
"TVInputComponent2" => NamedKey::TVInputComponent2,
|
|
||||||
"TVInputComposite1" => NamedKey::TVInputComposite1,
|
|
||||||
"TVInputComposite2" => NamedKey::TVInputComposite2,
|
|
||||||
"TVInputHDMI1" => NamedKey::TVInputHDMI1,
|
|
||||||
"TVInputHDMI2" => NamedKey::TVInputHDMI2,
|
|
||||||
"TVInputHDMI3" => NamedKey::TVInputHDMI3,
|
|
||||||
"TVInputHDMI4" => NamedKey::TVInputHDMI4,
|
|
||||||
"TVInputVGA1" => NamedKey::TVInputVGA1,
|
|
||||||
"TVMediaContext" => NamedKey::TVMediaContext,
|
|
||||||
"TVNetwork" => NamedKey::TVNetwork,
|
|
||||||
"TVNumberEntry" => NamedKey::TVNumberEntry,
|
|
||||||
"TVPower" => NamedKey::TVPower,
|
|
||||||
"TVRadioService" => NamedKey::TVRadioService,
|
|
||||||
"TVSatellite" => NamedKey::TVSatellite,
|
|
||||||
"TVSatelliteBS" => NamedKey::TVSatelliteBS,
|
|
||||||
"TVSatelliteCS" => NamedKey::TVSatelliteCS,
|
|
||||||
"TVSatelliteToggle" => NamedKey::TVSatelliteToggle,
|
|
||||||
"TVTerrestrialAnalog" => NamedKey::TVTerrestrialAnalog,
|
|
||||||
"TVTerrestrialDigital" => NamedKey::TVTerrestrialDigital,
|
|
||||||
"TVTimer" => NamedKey::TVTimer,
|
|
||||||
"AVRInput" => NamedKey::AVRInput,
|
|
||||||
"AVRPower" => NamedKey::AVRPower,
|
|
||||||
"ColorF0Red" => NamedKey::ColorF0Red,
|
|
||||||
"ColorF1Green" => NamedKey::ColorF1Green,
|
|
||||||
"ColorF2Yellow" => NamedKey::ColorF2Yellow,
|
|
||||||
"ColorF3Blue" => NamedKey::ColorF3Blue,
|
|
||||||
"ColorF4Grey" => NamedKey::ColorF4Grey,
|
|
||||||
"ColorF5Brown" => NamedKey::ColorF5Brown,
|
|
||||||
"ClosedCaptionToggle" => NamedKey::ClosedCaptionToggle,
|
|
||||||
"Dimmer" => NamedKey::Dimmer,
|
|
||||||
"DisplaySwap" => NamedKey::DisplaySwap,
|
|
||||||
"DVR" => NamedKey::DVR,
|
|
||||||
"Exit" => NamedKey::Exit,
|
|
||||||
"FavoriteClear0" => NamedKey::FavoriteClear0,
|
|
||||||
"FavoriteClear1" => NamedKey::FavoriteClear1,
|
|
||||||
"FavoriteClear2" => NamedKey::FavoriteClear2,
|
|
||||||
"FavoriteClear3" => NamedKey::FavoriteClear3,
|
|
||||||
"FavoriteRecall0" => NamedKey::FavoriteRecall0,
|
|
||||||
"FavoriteRecall1" => NamedKey::FavoriteRecall1,
|
|
||||||
"FavoriteRecall2" => NamedKey::FavoriteRecall2,
|
|
||||||
"FavoriteRecall3" => NamedKey::FavoriteRecall3,
|
|
||||||
"FavoriteStore0" => NamedKey::FavoriteStore0,
|
|
||||||
"FavoriteStore1" => NamedKey::FavoriteStore1,
|
|
||||||
"FavoriteStore2" => NamedKey::FavoriteStore2,
|
|
||||||
"FavoriteStore3" => NamedKey::FavoriteStore3,
|
|
||||||
"Guide" => NamedKey::Guide,
|
|
||||||
"GuideNextDay" => NamedKey::GuideNextDay,
|
|
||||||
"GuidePreviousDay" => NamedKey::GuidePreviousDay,
|
|
||||||
"Info" => NamedKey::Info,
|
|
||||||
"InstantReplay" => NamedKey::InstantReplay,
|
|
||||||
"Link" => NamedKey::Link,
|
|
||||||
"ListProgram" => NamedKey::ListProgram,
|
|
||||||
"LiveContent" => NamedKey::LiveContent,
|
|
||||||
"Lock" => NamedKey::Lock,
|
|
||||||
"MediaApps" => NamedKey::MediaApps,
|
|
||||||
"MediaAudioTrack" => NamedKey::MediaAudioTrack,
|
|
||||||
"MediaLast" => NamedKey::MediaLast,
|
|
||||||
"MediaSkipBackward" => NamedKey::MediaSkipBackward,
|
|
||||||
"MediaSkipForward" => NamedKey::MediaSkipForward,
|
|
||||||
"MediaStepBackward" => NamedKey::MediaStepBackward,
|
|
||||||
"MediaStepForward" => NamedKey::MediaStepForward,
|
|
||||||
"MediaTopMenu" => NamedKey::MediaTopMenu,
|
|
||||||
"NavigateIn" => NamedKey::NavigateIn,
|
|
||||||
"NavigateNext" => NamedKey::NavigateNext,
|
|
||||||
"NavigateOut" => NamedKey::NavigateOut,
|
|
||||||
"NavigatePrevious" => NamedKey::NavigatePrevious,
|
|
||||||
"NextFavoriteChannel" => NamedKey::NextFavoriteChannel,
|
|
||||||
"NextUserProfile" => NamedKey::NextUserProfile,
|
|
||||||
"OnDemand" => NamedKey::OnDemand,
|
|
||||||
"Pairing" => NamedKey::Pairing,
|
|
||||||
"PinPDown" => NamedKey::PinPDown,
|
|
||||||
"PinPMove" => NamedKey::PinPMove,
|
|
||||||
"PinPToggle" => NamedKey::PinPToggle,
|
|
||||||
"PinPUp" => NamedKey::PinPUp,
|
|
||||||
"PlaySpeedDown" => NamedKey::PlaySpeedDown,
|
|
||||||
"PlaySpeedReset" => NamedKey::PlaySpeedReset,
|
|
||||||
"PlaySpeedUp" => NamedKey::PlaySpeedUp,
|
|
||||||
"RandomToggle" => NamedKey::RandomToggle,
|
|
||||||
"RcLowBattery" => NamedKey::RcLowBattery,
|
|
||||||
"RecordSpeedNext" => NamedKey::RecordSpeedNext,
|
|
||||||
"RfBypass" => NamedKey::RfBypass,
|
|
||||||
"ScanChannelsToggle" => NamedKey::ScanChannelsToggle,
|
|
||||||
"ScreenModeNext" => NamedKey::ScreenModeNext,
|
|
||||||
"Settings" => NamedKey::Settings,
|
|
||||||
"SplitScreenToggle" => NamedKey::SplitScreenToggle,
|
|
||||||
"STBInput" => NamedKey::STBInput,
|
|
||||||
"STBPower" => NamedKey::STBPower,
|
|
||||||
"Subtitle" => NamedKey::Subtitle,
|
|
||||||
"Teletext" => NamedKey::Teletext,
|
|
||||||
"VideoModeNext" => NamedKey::VideoModeNext,
|
|
||||||
"Wink" => NamedKey::Wink,
|
|
||||||
"ZoomToggle" => NamedKey::ZoomToggle,
|
|
||||||
"F1" => NamedKey::F1,
|
|
||||||
"F2" => NamedKey::F2,
|
|
||||||
"F3" => NamedKey::F3,
|
|
||||||
"F4" => NamedKey::F4,
|
|
||||||
"F5" => NamedKey::F5,
|
|
||||||
"F6" => NamedKey::F6,
|
|
||||||
"F7" => NamedKey::F7,
|
|
||||||
"F8" => NamedKey::F8,
|
|
||||||
"F9" => NamedKey::F9,
|
|
||||||
"F10" => NamedKey::F10,
|
|
||||||
"F11" => NamedKey::F11,
|
|
||||||
"F12" => NamedKey::F12,
|
|
||||||
"F13" => NamedKey::F13,
|
|
||||||
"F14" => NamedKey::F14,
|
|
||||||
"F15" => NamedKey::F15,
|
|
||||||
"F16" => NamedKey::F16,
|
|
||||||
"F17" => NamedKey::F17,
|
|
||||||
"F18" => NamedKey::F18,
|
|
||||||
"F19" => NamedKey::F19,
|
|
||||||
"F20" => NamedKey::F20,
|
|
||||||
"F21" => NamedKey::F21,
|
|
||||||
"F22" => NamedKey::F22,
|
|
||||||
"F23" => NamedKey::F23,
|
|
||||||
"F24" => NamedKey::F24,
|
|
||||||
"F25" => NamedKey::F25,
|
|
||||||
"F26" => NamedKey::F26,
|
|
||||||
"F27" => NamedKey::F27,
|
|
||||||
"F28" => NamedKey::F28,
|
|
||||||
"F29" => NamedKey::F29,
|
|
||||||
"F30" => NamedKey::F30,
|
|
||||||
"F31" => NamedKey::F31,
|
|
||||||
"F32" => NamedKey::F32,
|
|
||||||
"F33" => NamedKey::F33,
|
|
||||||
"F34" => NamedKey::F34,
|
|
||||||
"F35" => NamedKey::F35,
|
|
||||||
string => return Key::Character(SmolStr::new(string)),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PhysicalKey {
|
|
||||||
pub fn from_key_code_attribute_value(kcav: &str) -> Self {
|
|
||||||
PhysicalKey::Code(match kcav {
|
|
||||||
"Backquote" => KeyCode::Backquote,
|
|
||||||
"Backslash" => KeyCode::Backslash,
|
|
||||||
"BracketLeft" => KeyCode::BracketLeft,
|
|
||||||
"BracketRight" => KeyCode::BracketRight,
|
|
||||||
"Comma" => KeyCode::Comma,
|
|
||||||
"Digit0" => KeyCode::Digit0,
|
|
||||||
"Digit1" => KeyCode::Digit1,
|
|
||||||
"Digit2" => KeyCode::Digit2,
|
|
||||||
"Digit3" => KeyCode::Digit3,
|
|
||||||
"Digit4" => KeyCode::Digit4,
|
|
||||||
"Digit5" => KeyCode::Digit5,
|
|
||||||
"Digit6" => KeyCode::Digit6,
|
|
||||||
"Digit7" => KeyCode::Digit7,
|
|
||||||
"Digit8" => KeyCode::Digit8,
|
|
||||||
"Digit9" => KeyCode::Digit9,
|
|
||||||
"Equal" => KeyCode::Equal,
|
|
||||||
"IntlBackslash" => KeyCode::IntlBackslash,
|
|
||||||
"IntlRo" => KeyCode::IntlRo,
|
|
||||||
"IntlYen" => KeyCode::IntlYen,
|
|
||||||
"KeyA" => KeyCode::KeyA,
|
|
||||||
"KeyB" => KeyCode::KeyB,
|
|
||||||
"KeyC" => KeyCode::KeyC,
|
|
||||||
"KeyD" => KeyCode::KeyD,
|
|
||||||
"KeyE" => KeyCode::KeyE,
|
|
||||||
"KeyF" => KeyCode::KeyF,
|
|
||||||
"KeyG" => KeyCode::KeyG,
|
|
||||||
"KeyH" => KeyCode::KeyH,
|
|
||||||
"KeyI" => KeyCode::KeyI,
|
|
||||||
"KeyJ" => KeyCode::KeyJ,
|
|
||||||
"KeyK" => KeyCode::KeyK,
|
|
||||||
"KeyL" => KeyCode::KeyL,
|
|
||||||
"KeyM" => KeyCode::KeyM,
|
|
||||||
"KeyN" => KeyCode::KeyN,
|
|
||||||
"KeyO" => KeyCode::KeyO,
|
|
||||||
"KeyP" => KeyCode::KeyP,
|
|
||||||
"KeyQ" => KeyCode::KeyQ,
|
|
||||||
"KeyR" => KeyCode::KeyR,
|
|
||||||
"KeyS" => KeyCode::KeyS,
|
|
||||||
"KeyT" => KeyCode::KeyT,
|
|
||||||
"KeyU" => KeyCode::KeyU,
|
|
||||||
"KeyV" => KeyCode::KeyV,
|
|
||||||
"KeyW" => KeyCode::KeyW,
|
|
||||||
"KeyX" => KeyCode::KeyX,
|
|
||||||
"KeyY" => KeyCode::KeyY,
|
|
||||||
"KeyZ" => KeyCode::KeyZ,
|
|
||||||
"Minus" => KeyCode::Minus,
|
|
||||||
"Period" => KeyCode::Period,
|
|
||||||
"Quote" => KeyCode::Quote,
|
|
||||||
"Semicolon" => KeyCode::Semicolon,
|
|
||||||
"Slash" => KeyCode::Slash,
|
|
||||||
"AltLeft" => KeyCode::AltLeft,
|
|
||||||
"AltRight" => KeyCode::AltRight,
|
|
||||||
"Backspace" => KeyCode::Backspace,
|
|
||||||
"CapsLock" => KeyCode::CapsLock,
|
|
||||||
"ContextMenu" => KeyCode::ContextMenu,
|
|
||||||
"ControlLeft" => KeyCode::ControlLeft,
|
|
||||||
"ControlRight" => KeyCode::ControlRight,
|
|
||||||
"Enter" => KeyCode::Enter,
|
|
||||||
"MetaLeft" => KeyCode::SuperLeft,
|
|
||||||
"MetaRight" => KeyCode::SuperRight,
|
|
||||||
"ShiftLeft" => KeyCode::ShiftLeft,
|
|
||||||
"ShiftRight" => KeyCode::ShiftRight,
|
|
||||||
"Space" => KeyCode::Space,
|
|
||||||
"Tab" => KeyCode::Tab,
|
|
||||||
"Convert" => KeyCode::Convert,
|
|
||||||
"KanaMode" => KeyCode::KanaMode,
|
|
||||||
"Lang1" => KeyCode::Lang1,
|
|
||||||
"Lang2" => KeyCode::Lang2,
|
|
||||||
"Lang3" => KeyCode::Lang3,
|
|
||||||
"Lang4" => KeyCode::Lang4,
|
|
||||||
"Lang5" => KeyCode::Lang5,
|
|
||||||
"NonConvert" => KeyCode::NonConvert,
|
|
||||||
"Delete" => KeyCode::Delete,
|
|
||||||
"End" => KeyCode::End,
|
|
||||||
"Help" => KeyCode::Help,
|
|
||||||
"Home" => KeyCode::Home,
|
|
||||||
"Insert" => KeyCode::Insert,
|
|
||||||
"PageDown" => KeyCode::PageDown,
|
|
||||||
"PageUp" => KeyCode::PageUp,
|
|
||||||
"ArrowDown" => KeyCode::ArrowDown,
|
|
||||||
"ArrowLeft" => KeyCode::ArrowLeft,
|
|
||||||
"ArrowRight" => KeyCode::ArrowRight,
|
|
||||||
"ArrowUp" => KeyCode::ArrowUp,
|
|
||||||
"NumLock" => KeyCode::NumLock,
|
|
||||||
"Numpad0" => KeyCode::Numpad0,
|
|
||||||
"Numpad1" => KeyCode::Numpad1,
|
|
||||||
"Numpad2" => KeyCode::Numpad2,
|
|
||||||
"Numpad3" => KeyCode::Numpad3,
|
|
||||||
"Numpad4" => KeyCode::Numpad4,
|
|
||||||
"Numpad5" => KeyCode::Numpad5,
|
|
||||||
"Numpad6" => KeyCode::Numpad6,
|
|
||||||
"Numpad7" => KeyCode::Numpad7,
|
|
||||||
"Numpad8" => KeyCode::Numpad8,
|
|
||||||
"Numpad9" => KeyCode::Numpad9,
|
|
||||||
"NumpadAdd" => KeyCode::NumpadAdd,
|
|
||||||
"NumpadBackspace" => KeyCode::NumpadBackspace,
|
|
||||||
"NumpadClear" => KeyCode::NumpadClear,
|
|
||||||
"NumpadClearEntry" => KeyCode::NumpadClearEntry,
|
|
||||||
"NumpadComma" => KeyCode::NumpadComma,
|
|
||||||
"NumpadDecimal" => KeyCode::NumpadDecimal,
|
|
||||||
"NumpadDivide" => KeyCode::NumpadDivide,
|
|
||||||
"NumpadEnter" => KeyCode::NumpadEnter,
|
|
||||||
"NumpadEqual" => KeyCode::NumpadEqual,
|
|
||||||
"NumpadHash" => KeyCode::NumpadHash,
|
|
||||||
"NumpadMemoryAdd" => KeyCode::NumpadMemoryAdd,
|
|
||||||
"NumpadMemoryClear" => KeyCode::NumpadMemoryClear,
|
|
||||||
"NumpadMemoryRecall" => KeyCode::NumpadMemoryRecall,
|
|
||||||
"NumpadMemoryStore" => KeyCode::NumpadMemoryStore,
|
|
||||||
"NumpadMemorySubtract" => KeyCode::NumpadMemorySubtract,
|
|
||||||
"NumpadMultiply" => KeyCode::NumpadMultiply,
|
|
||||||
"NumpadParenLeft" => KeyCode::NumpadParenLeft,
|
|
||||||
"NumpadParenRight" => KeyCode::NumpadParenRight,
|
|
||||||
"NumpadStar" => KeyCode::NumpadStar,
|
|
||||||
"NumpadSubtract" => KeyCode::NumpadSubtract,
|
|
||||||
"Escape" => KeyCode::Escape,
|
|
||||||
"Fn" => KeyCode::Fn,
|
|
||||||
"FnLock" => KeyCode::FnLock,
|
|
||||||
"PrintScreen" => KeyCode::PrintScreen,
|
|
||||||
"ScrollLock" => KeyCode::ScrollLock,
|
|
||||||
"Pause" => KeyCode::Pause,
|
|
||||||
"BrowserBack" => KeyCode::BrowserBack,
|
|
||||||
"BrowserFavorites" => KeyCode::BrowserFavorites,
|
|
||||||
"BrowserForward" => KeyCode::BrowserForward,
|
|
||||||
"BrowserHome" => KeyCode::BrowserHome,
|
|
||||||
"BrowserRefresh" => KeyCode::BrowserRefresh,
|
|
||||||
"BrowserSearch" => KeyCode::BrowserSearch,
|
|
||||||
"BrowserStop" => KeyCode::BrowserStop,
|
|
||||||
"Eject" => KeyCode::Eject,
|
|
||||||
"LaunchApp1" => KeyCode::LaunchApp1,
|
|
||||||
"LaunchApp2" => KeyCode::LaunchApp2,
|
|
||||||
"LaunchMail" => KeyCode::LaunchMail,
|
|
||||||
"MediaPlayPause" => KeyCode::MediaPlayPause,
|
|
||||||
"MediaSelect" => KeyCode::MediaSelect,
|
|
||||||
"MediaStop" => KeyCode::MediaStop,
|
|
||||||
"MediaTrackNext" => KeyCode::MediaTrackNext,
|
|
||||||
"MediaTrackPrevious" => KeyCode::MediaTrackPrevious,
|
|
||||||
"Power" => KeyCode::Power,
|
|
||||||
"Sleep" => KeyCode::Sleep,
|
|
||||||
"AudioVolumeDown" => KeyCode::AudioVolumeDown,
|
|
||||||
"AudioVolumeMute" => KeyCode::AudioVolumeMute,
|
|
||||||
"AudioVolumeUp" => KeyCode::AudioVolumeUp,
|
|
||||||
"WakeUp" => KeyCode::WakeUp,
|
|
||||||
"Hyper" => KeyCode::Hyper,
|
|
||||||
"Turbo" => KeyCode::Turbo,
|
|
||||||
"Abort" => KeyCode::Abort,
|
|
||||||
"Resume" => KeyCode::Resume,
|
|
||||||
"Suspend" => KeyCode::Suspend,
|
|
||||||
"Again" => KeyCode::Again,
|
|
||||||
"Copy" => KeyCode::Copy,
|
|
||||||
"Cut" => KeyCode::Cut,
|
|
||||||
"Find" => KeyCode::Find,
|
|
||||||
"Open" => KeyCode::Open,
|
|
||||||
"Paste" => KeyCode::Paste,
|
|
||||||
"Props" => KeyCode::Props,
|
|
||||||
"Select" => KeyCode::Select,
|
|
||||||
"Undo" => KeyCode::Undo,
|
|
||||||
"Hiragana" => KeyCode::Hiragana,
|
|
||||||
"Katakana" => KeyCode::Katakana,
|
|
||||||
"F1" => KeyCode::F1,
|
|
||||||
"F2" => KeyCode::F2,
|
|
||||||
"F3" => KeyCode::F3,
|
|
||||||
"F4" => KeyCode::F4,
|
|
||||||
"F5" => KeyCode::F5,
|
|
||||||
"F6" => KeyCode::F6,
|
|
||||||
"F7" => KeyCode::F7,
|
|
||||||
"F8" => KeyCode::F8,
|
|
||||||
"F9" => KeyCode::F9,
|
|
||||||
"F10" => KeyCode::F10,
|
|
||||||
"F11" => KeyCode::F11,
|
|
||||||
"F12" => KeyCode::F12,
|
|
||||||
"F13" => KeyCode::F13,
|
|
||||||
"F14" => KeyCode::F14,
|
|
||||||
"F15" => KeyCode::F15,
|
|
||||||
"F16" => KeyCode::F16,
|
|
||||||
"F17" => KeyCode::F17,
|
|
||||||
"F18" => KeyCode::F18,
|
|
||||||
"F19" => KeyCode::F19,
|
|
||||||
"F20" => KeyCode::F20,
|
|
||||||
"F21" => KeyCode::F21,
|
|
||||||
"F22" => KeyCode::F22,
|
|
||||||
"F23" => KeyCode::F23,
|
|
||||||
"F24" => KeyCode::F24,
|
|
||||||
"F25" => KeyCode::F25,
|
|
||||||
"F26" => KeyCode::F26,
|
|
||||||
"F27" => KeyCode::F27,
|
|
||||||
"F28" => KeyCode::F28,
|
|
||||||
"F29" => KeyCode::F29,
|
|
||||||
"F30" => KeyCode::F30,
|
|
||||||
"F31" => KeyCode::F31,
|
|
||||||
"F32" => KeyCode::F32,
|
|
||||||
"F33" => KeyCode::F33,
|
|
||||||
"F34" => KeyCode::F34,
|
|
||||||
"F35" => KeyCode::F35,
|
|
||||||
_ => return PhysicalKey::Unidentified(NativeKeyCode::Unidentified),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
28
src/utils.rs
28
src/utils.rs
@@ -1,28 +0,0 @@
|
|||||||
// A poly-fill for `lazy_cell`
|
|
||||||
// Replace with std::sync::LazyLock when https://github.com/rust-lang/rust/issues/109736 is stabilized.
|
|
||||||
|
|
||||||
// This isn't used on every platform, which can come up as dead code warnings.
|
|
||||||
#![allow(dead_code)]
|
|
||||||
|
|
||||||
use std::ops::Deref;
|
|
||||||
use std::sync::OnceLock;
|
|
||||||
|
|
||||||
pub(crate) struct Lazy<T> {
|
|
||||||
cell: OnceLock<T>,
|
|
||||||
init: fn() -> T,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> Lazy<T> {
|
|
||||||
pub const fn new(f: fn() -> T) -> Self {
|
|
||||||
Self { cell: OnceLock::new(), init: f }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> Deref for Lazy<T> {
|
|
||||||
type Target = T;
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn deref(&self) -> &'_ T {
|
|
||||||
self.cell.get_or_init(self.init)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -5,7 +5,7 @@ fn needs_send<T: Send>() {}
|
|||||||
fn event_loop_proxy_send() {
|
fn event_loop_proxy_send() {
|
||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
fn is_send<T: 'static + Send>() {
|
fn is_send<T: 'static + Send>() {
|
||||||
// ensures that `winit::EventLoopProxy<T: Send>` implements `Send`
|
// ensures that `winit::EventLoopProxy` implements `Send`
|
||||||
needs_send::<winit::event_loop::EventLoopProxy<T>>();
|
needs_send::<winit::event_loop::EventLoopProxy<T>>();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -18,7 +18,7 @@ fn window_send() {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn window_builder_send() {
|
fn window_builder_send() {
|
||||||
needs_send::<winit::window::WindowAttributes>();
|
needs_send::<winit::window::WindowBuilder>();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -31,6 +31,6 @@ fn ids_send() {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn custom_cursor_send() {
|
fn custom_cursor_send() {
|
||||||
needs_send::<winit::window::CustomCursorSource>();
|
needs_send::<winit::window::CustomCursorBuilder>();
|
||||||
needs_send::<winit::window::CustomCursor>();
|
needs_send::<winit::window::CustomCursor>();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
#![cfg(feature = "serde")]
|
#![cfg(feature = "serde")]
|
||||||
|
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use winit::dpi::{LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize};
|
use winit::{
|
||||||
use winit::event::{ElementState, MouseButton, MouseScrollDelta, TouchPhase};
|
dpi::{LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize},
|
||||||
use winit::keyboard::{Key, KeyCode, KeyLocation, ModifiersState, NamedKey, PhysicalKey};
|
event::{ElementState, MouseButton, MouseScrollDelta, TouchPhase},
|
||||||
use winit::window::CursorIcon;
|
keyboard::{Key, KeyCode, KeyLocation, ModifiersState, NamedKey, PhysicalKey},
|
||||||
|
window::CursorIcon,
|
||||||
|
};
|
||||||
|
|
||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
fn needs_serde<S: Serialize + Deserialize<'static>>() {}
|
fn needs_serde<S: Serialize + Deserialize<'static>>() {}
|
||||||
|
|||||||
@@ -1,15 +1,6 @@
|
|||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
fn needs_sync<T: Sync>() {}
|
fn needs_sync<T: Sync>() {}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn event_loop_proxy_send() {
|
|
||||||
#[allow(dead_code)]
|
|
||||||
fn is_send<T: 'static + Send>() {
|
|
||||||
// ensures that `winit::EventLoopProxy<T: Send>` implements `Sync`
|
|
||||||
needs_sync::<winit::event_loop::EventLoopProxy<T>>();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn window_sync() {
|
fn window_sync() {
|
||||||
// ensures that `winit::Window` implements `Sync`
|
// ensures that `winit::Window` implements `Sync`
|
||||||
@@ -18,11 +9,11 @@ fn window_sync() {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn window_builder_sync() {
|
fn window_builder_sync() {
|
||||||
needs_sync::<winit::window::WindowAttributes>();
|
needs_sync::<winit::window::WindowBuilder>();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn custom_cursor_sync() {
|
fn custom_cursor_sync() {
|
||||||
needs_sync::<winit::window::CustomCursorSource>();
|
needs_sync::<winit::window::CustomCursorBuilder>();
|
||||||
needs_sync::<winit::window::CustomCursor>();
|
needs_sync::<winit::window::CustomCursor>();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
# documentation: https://github.com/crate-ci/typos/blob/master/docs/reference.md
|
|
||||||
|
|
||||||
[default.extend-identifiers]
|
|
||||||
ptd = "ptd" # From windows_sys::Win32::System::Com::FORMATETC { ptd, ..}
|
|
||||||
TME_LEAVE = "TME_LEAVE" # From windows_sys::Win32::UI::Input::KeyboardAndMouse::TME_LEAVE
|
|
||||||
requestor = "requestor" # From x11_dl::xlib::XSelectionEvent { requestor ..}
|
|
||||||
XF86_Calculater = "XF86_Calculater" # From xkbcommon_dl::keysyms::XF86_Calculater
|
|
||||||
32
winit-core/Cargo.toml
Normal file
32
winit-core/Cargo.toml
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
[package]
|
||||||
|
name = "winit-core"
|
||||||
|
version = "0.1.0"
|
||||||
|
authors = ["The winit contributors"]
|
||||||
|
description = "Base types for windowing libraries"
|
||||||
|
edition = "2021"
|
||||||
|
keywords = ["windowing"]
|
||||||
|
license = "Apache-2.0"
|
||||||
|
readme = "README.md"
|
||||||
|
repository = "https://github.com/rust-windowing/winit"
|
||||||
|
documentation = "https://docs.rs/winit"
|
||||||
|
categories = ["gui"]
|
||||||
|
rust-version = "1.70.0"
|
||||||
|
|
||||||
|
[features]
|
||||||
|
default = ["std"]
|
||||||
|
std = ["alloc"]
|
||||||
|
alloc = []
|
||||||
|
serde = ["dep:serde", "cursor-icon/serde", "smol_str/serde"]
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
bitflags.workspace = true
|
||||||
|
cursor-icon.workspace = true
|
||||||
|
mint = { version = "0.5.6", optional = true }
|
||||||
|
serde = { workspace = true, optional = true }
|
||||||
|
smol_str.workspace = true
|
||||||
|
|
||||||
|
[target.'cfg(target_family = "wasm")'.dependencies]
|
||||||
|
web-time.workspace = true
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
cfg_aliases.workspace = true
|
||||||
3
winit-core/README.md
Normal file
3
winit-core/README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# winit-core - Base types for a windowing system
|
||||||
|
|
||||||
|
TODO
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
use cfg_aliases::cfg_aliases;
|
use cfg_aliases::cfg_aliases;
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
// The script doesn't depend on our code.
|
// The script doesn't depend on our code
|
||||||
println!("cargo:rerun-if-changed=build.rs");
|
println!("cargo:rerun-if-changed=build.rs");
|
||||||
|
|
||||||
// Setup cfg aliases.
|
// Setup cfg aliases
|
||||||
cfg_aliases! {
|
cfg_aliases! {
|
||||||
// Systems.
|
// Systems.
|
||||||
android_platform: { target_os = "android" },
|
android_platform: { target_os = "android" },
|
||||||
@@ -21,7 +21,4 @@ fn main() {
|
|||||||
wayland_platform: { all(feature = "wayland", free_unix, not(redox)) },
|
wayland_platform: { all(feature = "wayland", free_unix, not(redox)) },
|
||||||
orbital_platform: { redox },
|
orbital_platform: { redox },
|
||||||
}
|
}
|
||||||
|
|
||||||
// Winit defined cfgs.
|
|
||||||
println!("cargo:rustc-check-cfg=cfg(unreleased_changelogs)");
|
|
||||||
}
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
//! # DPI
|
//! UI scaling is important, so read the docs for this module if you don't want to be confused.
|
||||||
//!
|
//!
|
||||||
//! ## Why should I care about UI scaling?
|
//! ## Why should I care about UI scaling?
|
||||||
//!
|
//!
|
||||||
@@ -35,11 +35,14 @@
|
|||||||
//!
|
//!
|
||||||
//! ### Position and Size types
|
//! ### Position and Size types
|
||||||
//!
|
//!
|
||||||
//! The [`PhysicalPosition`] / [`PhysicalSize`] / [`PhysicalUnit`] types correspond with the actual
|
//! Winit's [`PhysicalPosition`] / [`PhysicalSize`] types correspond with the actual pixels on the
|
||||||
//! pixels on the device, and the [`LogicalPosition`] / [`LogicalSize`] / [`LogicalUnit`] types
|
//! device, and the [`LogicalPosition`] / [`LogicalSize`] types correspond to the physical pixels
|
||||||
//! correspond to the physical pixels divided by the scale factor.
|
//! divided by the scale factor.
|
||||||
|
//! All of Winit's functions return physical types, but can take either logical or physical
|
||||||
|
//! coordinates as input, allowing you to use the most convenient coordinate system for your
|
||||||
|
//! particular application.
|
||||||
//!
|
//!
|
||||||
//! The position and size types are generic over their exact pixel type, `P`, to allow the
|
//! Winit's position and size types are generic over their exact pixel type, `P`, to allow the
|
||||||
//! API to have integer precision where appropriate (e.g. most window manipulation functions) and
|
//! API to have integer precision where appropriate (e.g. most window manipulation functions) and
|
||||||
//! floating precision when necessary (e.g. logical sizes for fractional scale factors and touch
|
//! floating precision when necessary (e.g. logical sizes for fractional scale factors and touch
|
||||||
//! input). If `P` is a floating-point type, please do not cast the values with `as {int}`. Doing so
|
//! input). If `P` is a floating-point type, please do not cast the values with `as {int}`. Doing so
|
||||||
@@ -48,19 +51,58 @@
|
|||||||
//! rounding properly. Note that precision loss will still occur when rounding from a float to an
|
//! rounding properly. Note that precision loss will still occur when rounding from a float to an
|
||||||
//! int, although rounding lessens the problem.
|
//! int, although rounding lessens the problem.
|
||||||
//!
|
//!
|
||||||
//! ## Cargo Features
|
//! ### Events
|
||||||
//!
|
//!
|
||||||
//! This crate provides the following Cargo features:
|
//! Winit will dispatch a [`ScaleFactorChanged`] event whenever a window's scale factor has changed.
|
||||||
|
//! This can happen if the user drags their window from a standard-resolution monitor to a high-DPI
|
||||||
|
//! monitor or if the user changes their DPI settings. This allows you to rescale your application's
|
||||||
|
//! UI elements and adjust how the platform changes the window's size to reflect the new scale
|
||||||
|
//! factor. If a window hasn't received a [`ScaleFactorChanged`] event, its scale factor
|
||||||
|
//! can be found by calling [`window.scale_factor()`].
|
||||||
//!
|
//!
|
||||||
//! * `serde`: Enables serialization/deserialization of certain types with [Serde](https://crates.io/crates/serde).
|
//! ## How is the scale factor calculated?
|
||||||
//! * `mint`: Enables mint (math interoperability standard types) conversions.
|
//!
|
||||||
|
//! The scale factor is calculated differently on different platforms:
|
||||||
|
//!
|
||||||
|
//! - **Windows:** On Windows 8 and 10, per-monitor scaling is readily configured by users from the
|
||||||
|
//! display settings. While users are free to select any option they want, they're only given a
|
||||||
|
//! selection of "nice" scale factors, i.e. 1.0, 1.25, 1.5... on Windows 7. The scale factor is
|
||||||
|
//! global and changing it requires logging out. See [this article][windows_1] for technical
|
||||||
|
//! details.
|
||||||
|
//! - **macOS:** Recent macOS versions allow the user to change the scaling factor for specific
|
||||||
|
//! displays. When available, the user may pick a per-monitor scaling factor from a set of
|
||||||
|
//! pre-defined settings. All "retina displays" have a scaling factor above 1.0 by default,
|
||||||
|
//! but the specific value varies across devices.
|
||||||
|
//! - **X11:** Many man-hours have been spent trying to figure out how to handle DPI in X11. Winit
|
||||||
|
//! currently uses a three-pronged approach:
|
||||||
|
//! + Use the value in the `WINIT_X11_SCALE_FACTOR` environment variable if present.
|
||||||
|
//! + If not present, use the value set in `Xft.dpi` in Xresources.
|
||||||
|
//! + Otherwise, calculate the scale factor based on the millimeter monitor dimensions provided by XRandR.
|
||||||
|
//!
|
||||||
|
//! If `WINIT_X11_SCALE_FACTOR` is set to `randr`, it'll ignore the `Xft.dpi` field and use the
|
||||||
|
//! XRandR scaling method. Generally speaking, you should try to configure the standard system
|
||||||
|
//! variables to do what you want before resorting to `WINIT_X11_SCALE_FACTOR`.
|
||||||
|
//! - **Wayland:** The scale factor is suggested by the compositor for each window individually. The
|
||||||
|
//! monitor scale factor may differ from the window scale factor.
|
||||||
|
//! - **iOS:** Scale factors are set by Apple to the value that best suits the device, and range
|
||||||
|
//! from `1.0` to `3.0`. See [this article][apple_1] and [this article][apple_2] for more
|
||||||
|
//! information.
|
||||||
|
//! - **Android:** Scale factors are set by the manufacturer to the value that best suits the
|
||||||
|
//! device, and range from `1.0` to `4.0`. See [this article][android_1] for more information.
|
||||||
|
//! - **Web:** The scale factor is the ratio between CSS pixels and the physical device pixels.
|
||||||
|
//! In other words, it is the value of [`window.devicePixelRatio`][web_1]. It is affected by
|
||||||
|
//! both the screen scaling and the browser zoom level and can go below `1.0`.
|
||||||
//!
|
//!
|
||||||
//!
|
//!
|
||||||
//! [points]: https://en.wikipedia.org/wiki/Point_(typography)
|
//! [points]: https://en.wikipedia.org/wiki/Point_(typography)
|
||||||
//! [picas]: https://en.wikipedia.org/wiki/Pica_(typography)
|
//! [picas]: https://en.wikipedia.org/wiki/Pica_(typography)
|
||||||
|
//! [`ScaleFactorChanged`]: crate::event::WindowEvent::ScaleFactorChanged
|
||||||
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg_hide), doc(cfg_hide(doc, docsrs)))]
|
//! [`window.scale_factor()`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.scale_factor
|
||||||
#![forbid(unsafe_code)]
|
//! [windows_1]: https://docs.microsoft.com/en-us/windows/win32/hidpi/high-dpi-desktop-application-development-on-windows
|
||||||
|
//! [apple_1]: https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/Displays/Displays.html
|
||||||
|
//! [apple_2]: https://developer.apple.com/design/human-interface-guidelines/macos/icons-and-images/image-size-and-resolution/
|
||||||
|
//! [android_1]: https://developer.android.com/training/multiscreen/screendensities
|
||||||
|
//! [web_1]: https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
@@ -115,252 +157,18 @@ impl Pixel for f64 {
|
|||||||
|
|
||||||
/// Checks that the scale factor is a normal positive `f64`.
|
/// Checks that the scale factor is a normal positive `f64`.
|
||||||
///
|
///
|
||||||
/// All functions that take a scale factor assert that this will return `true`. If you're sourcing
|
/// All functions that take a scale factor assert that this will return `true`. If you're sourcing scale factors from
|
||||||
/// scale factors from anywhere other than winit, it's recommended to validate them using this
|
/// anywhere other than winit, it's recommended to validate them using this function before passing them to winit;
|
||||||
/// function before passing them to winit; otherwise, you risk panics.
|
/// otherwise, you risk panics.
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn validate_scale_factor(scale_factor: f64) -> bool {
|
pub fn validate_scale_factor(scale_factor: f64) -> bool {
|
||||||
scale_factor.is_sign_positive() && scale_factor.is_normal()
|
scale_factor.is_sign_positive() && scale_factor.is_normal()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// A logical pixel unit.
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default, Hash)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
pub struct LogicalUnit<P>(pub P);
|
|
||||||
|
|
||||||
impl<P> LogicalUnit<P> {
|
|
||||||
/// Represents a maximum logical unit that is equal to [`f64::MAX`].
|
|
||||||
pub const MAX: LogicalUnit<f64> = LogicalUnit::new(f64::MAX);
|
|
||||||
/// Represents a minimum logical unit of [`f64::MAX`].
|
|
||||||
pub const MIN: LogicalUnit<f64> = LogicalUnit::new(f64::MIN);
|
|
||||||
/// Represents a logical unit of `0_f64`.
|
|
||||||
pub const ZERO: LogicalUnit<f64> = LogicalUnit::new(0.0);
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub const fn new(v: P) -> Self {
|
|
||||||
LogicalUnit(v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> LogicalUnit<P> {
|
|
||||||
#[inline]
|
|
||||||
pub fn from_physical<T: Into<PhysicalUnit<X>>, X: Pixel>(
|
|
||||||
physical: T,
|
|
||||||
scale_factor: f64,
|
|
||||||
) -> Self {
|
|
||||||
physical.into().to_logical(scale_factor)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn to_physical<X: Pixel>(&self, scale_factor: f64) -> PhysicalUnit<X> {
|
|
||||||
assert!(validate_scale_factor(scale_factor));
|
|
||||||
PhysicalUnit::new(self.0.into() * scale_factor).cast()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn cast<X: Pixel>(&self) -> LogicalUnit<X> {
|
|
||||||
LogicalUnit(self.0.cast())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel, X: Pixel> From<X> for LogicalUnit<P> {
|
|
||||||
fn from(v: X) -> LogicalUnit<P> {
|
|
||||||
LogicalUnit::new(v.cast())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for u8 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> u8 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for u16 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> u16 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for u32 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> u32 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for i8 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> i8 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for i16 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> i16 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for i32 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> i32 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for f32 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> f32 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for f64 {
|
|
||||||
fn from(v: LogicalUnit<P>) -> f64 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A physical pixel unit.
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default, Hash)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
pub struct PhysicalUnit<P>(pub P);
|
|
||||||
|
|
||||||
impl<P> PhysicalUnit<P> {
|
|
||||||
/// Represents a maximum physical unit that is equal to [`f64::MAX`].
|
|
||||||
pub const MAX: LogicalUnit<f64> = LogicalUnit::new(f64::MAX);
|
|
||||||
/// Represents a minimum physical unit of [`f64::MAX`].
|
|
||||||
pub const MIN: LogicalUnit<f64> = LogicalUnit::new(f64::MIN);
|
|
||||||
/// Represents a physical unit of `0_f64`.
|
|
||||||
pub const ZERO: LogicalUnit<f64> = LogicalUnit::new(0.0);
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub const fn new(v: P) -> Self {
|
|
||||||
PhysicalUnit(v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> PhysicalUnit<P> {
|
|
||||||
#[inline]
|
|
||||||
pub fn from_logical<T: Into<LogicalUnit<X>>, X: Pixel>(logical: T, scale_factor: f64) -> Self {
|
|
||||||
logical.into().to_physical(scale_factor)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn to_logical<X: Pixel>(&self, scale_factor: f64) -> LogicalUnit<X> {
|
|
||||||
assert!(validate_scale_factor(scale_factor));
|
|
||||||
LogicalUnit::new(self.0.into() / scale_factor).cast()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn cast<X: Pixel>(&self) -> PhysicalUnit<X> {
|
|
||||||
PhysicalUnit(self.0.cast())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel, X: Pixel> From<X> for PhysicalUnit<P> {
|
|
||||||
fn from(v: X) -> PhysicalUnit<P> {
|
|
||||||
PhysicalUnit::new(v.cast())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for u8 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> u8 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for u16 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> u16 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for u32 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> u32 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for i8 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> i8 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for i16 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> i16 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for i32 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> i32 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for f32 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> f32 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for f64 {
|
|
||||||
fn from(v: PhysicalUnit<P>) -> f64 {
|
|
||||||
v.0.cast()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A pixel unit that's either physical or logical.
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
pub enum PixelUnit {
|
|
||||||
Physical(PhysicalUnit<i32>),
|
|
||||||
Logical(LogicalUnit<f64>),
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PixelUnit {
|
|
||||||
/// Represents a maximum logical unit that is equal to [`f64::MAX`].
|
|
||||||
pub const MAX: PixelUnit = PixelUnit::Logical(LogicalUnit::new(f64::MAX));
|
|
||||||
/// Represents a minimum logical unit of [`f64::MAX`].
|
|
||||||
pub const MIN: PixelUnit = PixelUnit::Logical(LogicalUnit::new(f64::MIN));
|
|
||||||
/// Represents a logical unit of `0_f64`.
|
|
||||||
pub const ZERO: PixelUnit = PixelUnit::Logical(LogicalUnit::new(0.0));
|
|
||||||
|
|
||||||
pub fn new<S: Into<PixelUnit>>(unit: S) -> PixelUnit {
|
|
||||||
unit.into()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn to_logical<P: Pixel>(&self, scale_factor: f64) -> LogicalUnit<P> {
|
|
||||||
match *self {
|
|
||||||
PixelUnit::Physical(unit) => unit.to_logical(scale_factor),
|
|
||||||
PixelUnit::Logical(unit) => unit.cast(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn to_physical<P: Pixel>(&self, scale_factor: f64) -> PhysicalUnit<P> {
|
|
||||||
match *self {
|
|
||||||
PixelUnit::Physical(unit) => unit.cast(),
|
|
||||||
PixelUnit::Logical(unit) => unit.to_physical(scale_factor),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<PhysicalUnit<P>> for PixelUnit {
|
|
||||||
#[inline]
|
|
||||||
fn from(unit: PhysicalUnit<P>) -> PixelUnit {
|
|
||||||
PixelUnit::Physical(unit.cast())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<P: Pixel> From<LogicalUnit<P>> for PixelUnit {
|
|
||||||
#[inline]
|
|
||||||
fn from(unit: LogicalUnit<P>) -> PixelUnit {
|
|
||||||
PixelUnit::Logical(unit.cast())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A position represented in logical pixels.
|
/// A position represented in logical pixels.
|
||||||
///
|
///
|
||||||
/// The position is stored as floats, so please be careful. Casting floats to integers truncates the
|
/// The position is stored as floats, so please be careful. Casting floats to integers truncates the
|
||||||
/// fractional part, which can cause noticeable issues. To help with that, an `Into<(i32, i32)>`
|
/// fractional part, which can cause noticable issues. To help with that, an `Into<(i32, i32)>`
|
||||||
/// implementation is provided which does the rounding for you.
|
/// implementation is provided which does the rounding for you.
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default, Hash)]
|
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Default, Hash)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
@@ -395,7 +203,10 @@ impl<P: Pixel> LogicalPosition<P> {
|
|||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn cast<X: Pixel>(&self) -> LogicalPosition<X> {
|
pub fn cast<X: Pixel>(&self) -> LogicalPosition<X> {
|
||||||
LogicalPosition { x: self.x.cast(), y: self.y.cast() }
|
LogicalPosition {
|
||||||
|
x: self.x.cast(),
|
||||||
|
y: self.y.cast(),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -471,7 +282,10 @@ impl<P: Pixel> PhysicalPosition<P> {
|
|||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn cast<X: Pixel>(&self) -> PhysicalPosition<X> {
|
pub fn cast<X: Pixel>(&self) -> PhysicalPosition<X> {
|
||||||
PhysicalPosition { x: self.x.cast(), y: self.y.cast() }
|
PhysicalPosition {
|
||||||
|
x: self.x.cast(),
|
||||||
|
y: self.y.cast(),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -547,7 +361,10 @@ impl<P: Pixel> LogicalSize<P> {
|
|||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn cast<X: Pixel>(&self) -> LogicalSize<X> {
|
pub fn cast<X: Pixel>(&self) -> LogicalSize<X> {
|
||||||
LogicalSize { width: self.width.cast(), height: self.height.cast() }
|
LogicalSize {
|
||||||
|
width: self.width.cast(),
|
||||||
|
height: self.height.cast(),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -585,7 +402,10 @@ impl<P: Pixel> From<mint::Vector2<P>> for LogicalSize<P> {
|
|||||||
#[cfg(feature = "mint")]
|
#[cfg(feature = "mint")]
|
||||||
impl<P: Pixel> From<LogicalSize<P>> for mint::Vector2<P> {
|
impl<P: Pixel> From<LogicalSize<P>> for mint::Vector2<P> {
|
||||||
fn from(s: LogicalSize<P>) -> Self {
|
fn from(s: LogicalSize<P>) -> Self {
|
||||||
mint::Vector2 { x: s.width, y: s.height }
|
mint::Vector2 {
|
||||||
|
x: s.width,
|
||||||
|
y: s.height,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -620,7 +440,10 @@ impl<P: Pixel> PhysicalSize<P> {
|
|||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn cast<X: Pixel>(&self) -> PhysicalSize<X> {
|
pub fn cast<X: Pixel>(&self) -> PhysicalSize<X> {
|
||||||
PhysicalSize { width: self.width.cast(), height: self.height.cast() }
|
PhysicalSize {
|
||||||
|
width: self.width.cast(),
|
||||||
|
height: self.height.cast(),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -658,7 +481,10 @@ impl<P: Pixel> From<mint::Vector2<P>> for PhysicalSize<P> {
|
|||||||
#[cfg(feature = "mint")]
|
#[cfg(feature = "mint")]
|
||||||
impl<P: Pixel> From<PhysicalSize<P>> for mint::Vector2<P> {
|
impl<P: Pixel> From<PhysicalSize<P>> for mint::Vector2<P> {
|
||||||
fn from(s: PhysicalSize<P>) -> Self {
|
fn from(s: PhysicalSize<P>) -> Self {
|
||||||
mint::Vector2 { x: s.width, y: s.height }
|
mint::Vector2 {
|
||||||
|
x: s.width,
|
||||||
|
y: s.height,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -761,13 +587,15 @@ impl<P: Pixel> From<LogicalPosition<P>> for Position {
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use crate::dpi;
|
||||||
use std::collections::HashSet;
|
use std::collections::HashSet;
|
||||||
|
|
||||||
macro_rules! test_pixel_int_impl {
|
macro_rules! test_pixel_int_impl {
|
||||||
($($name:ident => $ty:ty),*) => {$(
|
($($name:ident => $ty:ty),*) => {$(
|
||||||
#[test]
|
#[test]
|
||||||
fn $name() {
|
fn $name() {
|
||||||
|
use dpi::Pixel;
|
||||||
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
<$ty as Pixel>::from_f64(37.0),
|
<$ty as Pixel>::from_f64(37.0),
|
||||||
37,
|
37,
|
||||||
@@ -823,7 +651,12 @@ mod tests {
|
|||||||
|
|
||||||
macro_rules! assert_approx_eq {
|
macro_rules! assert_approx_eq {
|
||||||
($a:expr, $b:expr $(,)?) => {
|
($a:expr, $b:expr $(,)?) => {
|
||||||
assert!(($a - $b).abs() < 0.001, "{} is not approximately equal to {}", $a, $b);
|
assert!(
|
||||||
|
($a - $b).abs() < 0.001,
|
||||||
|
"{} is not approximately equal to {}",
|
||||||
|
$a,
|
||||||
|
$b
|
||||||
|
);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -831,6 +664,8 @@ mod tests {
|
|||||||
($($name:ident => $ty:ty),*) => {$(
|
($($name:ident => $ty:ty),*) => {$(
|
||||||
#[test]
|
#[test]
|
||||||
fn $name() {
|
fn $name() {
|
||||||
|
use dpi::Pixel;
|
||||||
|
|
||||||
assert_approx_eq!(
|
assert_approx_eq!(
|
||||||
<$ty as Pixel>::from_f64(37.0),
|
<$ty as Pixel>::from_f64(37.0),
|
||||||
37.0,
|
37.0,
|
||||||
@@ -923,54 +758,47 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_validate_scale_factor() {
|
fn test_validate_scale_factor() {
|
||||||
assert!(validate_scale_factor(1.0));
|
assert!(dpi::validate_scale_factor(1.0));
|
||||||
assert!(validate_scale_factor(2.0));
|
assert!(dpi::validate_scale_factor(2.0));
|
||||||
assert!(validate_scale_factor(3.0));
|
assert!(dpi::validate_scale_factor(3.0));
|
||||||
assert!(validate_scale_factor(1.5));
|
assert!(dpi::validate_scale_factor(1.5));
|
||||||
assert!(validate_scale_factor(0.5));
|
assert!(dpi::validate_scale_factor(0.5));
|
||||||
|
|
||||||
assert!(!validate_scale_factor(0.0));
|
assert!(!dpi::validate_scale_factor(0.0));
|
||||||
assert!(!validate_scale_factor(-1.0));
|
assert!(!dpi::validate_scale_factor(-1.0));
|
||||||
assert!(!validate_scale_factor(f64::INFINITY));
|
assert!(!dpi::validate_scale_factor(f64::INFINITY));
|
||||||
assert!(!validate_scale_factor(f64::NAN));
|
assert!(!dpi::validate_scale_factor(f64::NAN));
|
||||||
assert!(!validate_scale_factor(f64::NEG_INFINITY));
|
assert!(!dpi::validate_scale_factor(f64::NEG_INFINITY));
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_logical_unity() {
|
|
||||||
let log_unit = LogicalUnit::new(1.0);
|
|
||||||
assert_eq!(log_unit.to_physical::<u32>(1.0), PhysicalUnit::new(1));
|
|
||||||
assert_eq!(log_unit.to_physical::<u32>(2.0), PhysicalUnit::new(2));
|
|
||||||
assert_eq!(log_unit.cast::<u32>(), LogicalUnit::new(1));
|
|
||||||
assert_eq!(log_unit, LogicalUnit::from_physical(PhysicalUnit::new(1.0), 1.0));
|
|
||||||
assert_eq!(log_unit, LogicalUnit::from_physical(PhysicalUnit::new(2.0), 2.0));
|
|
||||||
assert_eq!(LogicalUnit::from(2.0), LogicalUnit::new(2.0));
|
|
||||||
|
|
||||||
let x: f64 = log_unit.into();
|
|
||||||
assert_eq!(x, 1.0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_physical_unit() {
|
|
||||||
assert_eq!(PhysicalUnit::from_logical(LogicalUnit::new(1.0), 1.0), PhysicalUnit::new(1));
|
|
||||||
assert_eq!(PhysicalUnit::from_logical(LogicalUnit::new(2.0), 0.5), PhysicalUnit::new(1));
|
|
||||||
assert_eq!(PhysicalUnit::from(2.0), PhysicalUnit::new(2.0,));
|
|
||||||
assert_eq!(PhysicalUnit::from(2.0), PhysicalUnit::new(2.0));
|
|
||||||
|
|
||||||
let x: f64 = PhysicalUnit::new(1).into();
|
|
||||||
assert_eq!(x, 1.0);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_logical_position() {
|
fn test_logical_position() {
|
||||||
let log_pos = LogicalPosition::new(1.0, 2.0);
|
let log_pos = dpi::LogicalPosition::new(1.0, 2.0);
|
||||||
assert_eq!(log_pos.to_physical::<u32>(1.0), PhysicalPosition::new(1, 2));
|
assert_eq!(
|
||||||
assert_eq!(log_pos.to_physical::<u32>(2.0), PhysicalPosition::new(2, 4));
|
log_pos.to_physical::<u32>(1.0),
|
||||||
assert_eq!(log_pos.cast::<u32>(), LogicalPosition::new(1, 2));
|
dpi::PhysicalPosition::new(1, 2)
|
||||||
assert_eq!(log_pos, LogicalPosition::from_physical(PhysicalPosition::new(1.0, 2.0), 1.0));
|
);
|
||||||
assert_eq!(log_pos, LogicalPosition::from_physical(PhysicalPosition::new(2.0, 4.0), 2.0));
|
assert_eq!(
|
||||||
assert_eq!(LogicalPosition::from((2.0, 2.0)), LogicalPosition::new(2.0, 2.0));
|
log_pos.to_physical::<u32>(2.0),
|
||||||
assert_eq!(LogicalPosition::from([2.0, 3.0]), LogicalPosition::new(2.0, 3.0));
|
dpi::PhysicalPosition::new(2, 4)
|
||||||
|
);
|
||||||
|
assert_eq!(log_pos.cast::<u32>(), dpi::LogicalPosition::new(1, 2));
|
||||||
|
assert_eq!(
|
||||||
|
log_pos,
|
||||||
|
dpi::LogicalPosition::from_physical(dpi::PhysicalPosition::new(1.0, 2.0), 1.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
log_pos,
|
||||||
|
dpi::LogicalPosition::from_physical(dpi::PhysicalPosition::new(2.0, 4.0), 2.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::LogicalPosition::from((2.0, 2.0)),
|
||||||
|
dpi::LogicalPosition::new(2.0, 2.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::LogicalPosition::from([2.0, 3.0]),
|
||||||
|
dpi::LogicalPosition::new(2.0, 3.0)
|
||||||
|
);
|
||||||
|
|
||||||
let x: (f64, f64) = log_pos.into();
|
let x: (f64, f64) = log_pos.into();
|
||||||
assert_eq!(x, (1.0, 2.0));
|
assert_eq!(x, (1.0, 2.0));
|
||||||
@@ -981,32 +809,56 @@ mod tests {
|
|||||||
#[test]
|
#[test]
|
||||||
fn test_physical_position() {
|
fn test_physical_position() {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
PhysicalPosition::from_logical(LogicalPosition::new(1.0, 2.0), 1.0),
|
dpi::PhysicalPosition::from_logical(dpi::LogicalPosition::new(1.0, 2.0), 1.0),
|
||||||
PhysicalPosition::new(1, 2)
|
dpi::PhysicalPosition::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
PhysicalPosition::from_logical(LogicalPosition::new(2.0, 4.0), 0.5),
|
dpi::PhysicalPosition::from_logical(dpi::LogicalPosition::new(2.0, 4.0), 0.5),
|
||||||
PhysicalPosition::new(1, 2)
|
dpi::PhysicalPosition::new(1, 2)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::PhysicalPosition::from((2.0, 2.0)),
|
||||||
|
dpi::PhysicalPosition::new(2.0, 2.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::PhysicalPosition::from([2.0, 3.0]),
|
||||||
|
dpi::PhysicalPosition::new(2.0, 3.0)
|
||||||
);
|
);
|
||||||
assert_eq!(PhysicalPosition::from((2.0, 2.0)), PhysicalPosition::new(2.0, 2.0));
|
|
||||||
assert_eq!(PhysicalPosition::from([2.0, 3.0]), PhysicalPosition::new(2.0, 3.0));
|
|
||||||
|
|
||||||
let x: (f64, f64) = PhysicalPosition::new(1, 2).into();
|
let x: (f64, f64) = dpi::PhysicalPosition::new(1, 2).into();
|
||||||
assert_eq!(x, (1.0, 2.0));
|
assert_eq!(x, (1.0, 2.0));
|
||||||
let x: [f64; 2] = PhysicalPosition::new(1, 2).into();
|
let x: [f64; 2] = dpi::PhysicalPosition::new(1, 2).into();
|
||||||
assert_eq!(x, [1.0, 2.0]);
|
assert_eq!(x, [1.0, 2.0]);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_logical_size() {
|
fn test_logical_size() {
|
||||||
let log_size = LogicalSize::new(1.0, 2.0);
|
let log_size = dpi::LogicalSize::new(1.0, 2.0);
|
||||||
assert_eq!(log_size.to_physical::<u32>(1.0), PhysicalSize::new(1, 2));
|
assert_eq!(
|
||||||
assert_eq!(log_size.to_physical::<u32>(2.0), PhysicalSize::new(2, 4));
|
log_size.to_physical::<u32>(1.0),
|
||||||
assert_eq!(log_size.cast::<u32>(), LogicalSize::new(1, 2));
|
dpi::PhysicalSize::new(1, 2)
|
||||||
assert_eq!(log_size, LogicalSize::from_physical(PhysicalSize::new(1.0, 2.0), 1.0));
|
);
|
||||||
assert_eq!(log_size, LogicalSize::from_physical(PhysicalSize::new(2.0, 4.0), 2.0));
|
assert_eq!(
|
||||||
assert_eq!(LogicalSize::from((2.0, 2.0)), LogicalSize::new(2.0, 2.0));
|
log_size.to_physical::<u32>(2.0),
|
||||||
assert_eq!(LogicalSize::from([2.0, 3.0]), LogicalSize::new(2.0, 3.0));
|
dpi::PhysicalSize::new(2, 4)
|
||||||
|
);
|
||||||
|
assert_eq!(log_size.cast::<u32>(), dpi::LogicalSize::new(1, 2));
|
||||||
|
assert_eq!(
|
||||||
|
log_size,
|
||||||
|
dpi::LogicalSize::from_physical(dpi::PhysicalSize::new(1.0, 2.0), 1.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
log_size,
|
||||||
|
dpi::LogicalSize::from_physical(dpi::PhysicalSize::new(2.0, 4.0), 2.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::LogicalSize::from((2.0, 2.0)),
|
||||||
|
dpi::LogicalSize::new(2.0, 2.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::LogicalSize::from([2.0, 3.0]),
|
||||||
|
dpi::LogicalSize::new(2.0, 3.0)
|
||||||
|
);
|
||||||
|
|
||||||
let x: (f64, f64) = log_size.into();
|
let x: (f64, f64) = log_size.into();
|
||||||
assert_eq!(x, (1.0, 2.0));
|
assert_eq!(x, (1.0, 2.0));
|
||||||
@@ -1017,161 +869,136 @@ mod tests {
|
|||||||
#[test]
|
#[test]
|
||||||
fn test_physical_size() {
|
fn test_physical_size() {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
PhysicalSize::from_logical(LogicalSize::new(1.0, 2.0), 1.0),
|
dpi::PhysicalSize::from_logical(dpi::LogicalSize::new(1.0, 2.0), 1.0),
|
||||||
PhysicalSize::new(1, 2)
|
dpi::PhysicalSize::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
PhysicalSize::from_logical(LogicalSize::new(2.0, 4.0), 0.5),
|
dpi::PhysicalSize::from_logical(dpi::LogicalSize::new(2.0, 4.0), 0.5),
|
||||||
PhysicalSize::new(1, 2)
|
dpi::PhysicalSize::new(1, 2)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::PhysicalSize::from((2.0, 2.0)),
|
||||||
|
dpi::PhysicalSize::new(2.0, 2.0)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::PhysicalSize::from([2.0, 3.0]),
|
||||||
|
dpi::PhysicalSize::new(2.0, 3.0)
|
||||||
);
|
);
|
||||||
assert_eq!(PhysicalSize::from((2.0, 2.0)), PhysicalSize::new(2.0, 2.0));
|
|
||||||
assert_eq!(PhysicalSize::from([2.0, 3.0]), PhysicalSize::new(2.0, 3.0));
|
|
||||||
|
|
||||||
let x: (f64, f64) = PhysicalSize::new(1, 2).into();
|
let x: (f64, f64) = dpi::PhysicalSize::new(1, 2).into();
|
||||||
assert_eq!(x, (1.0, 2.0));
|
assert_eq!(x, (1.0, 2.0));
|
||||||
let x: [f64; 2] = PhysicalSize::new(1, 2).into();
|
let x: [f64; 2] = dpi::PhysicalSize::new(1, 2).into();
|
||||||
assert_eq!(x, [1.0, 2.0]);
|
assert_eq!(x, [1.0, 2.0]);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_size() {
|
fn test_size() {
|
||||||
assert_eq!(Size::new(PhysicalSize::new(1, 2)), Size::Physical(PhysicalSize::new(1, 2)));
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(LogicalSize::new(1.0, 2.0)),
|
dpi::Size::new(dpi::PhysicalSize::new(1, 2)),
|
||||||
Size::Logical(LogicalSize::new(1.0, 2.0))
|
dpi::Size::Physical(dpi::PhysicalSize::new(1, 2))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dpi::Size::new(dpi::LogicalSize::new(1.0, 2.0)),
|
||||||
|
dpi::Size::Logical(dpi::LogicalSize::new(1.0, 2.0))
|
||||||
);
|
);
|
||||||
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(PhysicalSize::new(1, 2)).to_logical::<f64>(1.0),
|
dpi::Size::new(dpi::PhysicalSize::new(1, 2)).to_logical::<f64>(1.0),
|
||||||
LogicalSize::new(1.0, 2.0)
|
dpi::LogicalSize::new(1.0, 2.0)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(PhysicalSize::new(1, 2)).to_logical::<f64>(2.0),
|
dpi::Size::new(dpi::PhysicalSize::new(1, 2)).to_logical::<f64>(2.0),
|
||||||
LogicalSize::new(0.5, 1.0)
|
dpi::LogicalSize::new(0.5, 1.0)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(LogicalSize::new(1.0, 2.0)).to_logical::<f64>(1.0),
|
dpi::Size::new(dpi::LogicalSize::new(1.0, 2.0)).to_logical::<f64>(1.0),
|
||||||
LogicalSize::new(1.0, 2.0)
|
dpi::LogicalSize::new(1.0, 2.0)
|
||||||
);
|
);
|
||||||
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(PhysicalSize::new(1, 2)).to_physical::<u32>(1.0),
|
dpi::Size::new(dpi::PhysicalSize::new(1, 2)).to_physical::<u32>(1.0),
|
||||||
PhysicalSize::new(1, 2)
|
dpi::PhysicalSize::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(PhysicalSize::new(1, 2)).to_physical::<u32>(2.0),
|
dpi::Size::new(dpi::PhysicalSize::new(1, 2)).to_physical::<u32>(2.0),
|
||||||
PhysicalSize::new(1, 2)
|
dpi::PhysicalSize::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(LogicalSize::new(1.0, 2.0)).to_physical::<u32>(1.0),
|
dpi::Size::new(dpi::LogicalSize::new(1.0, 2.0)).to_physical::<u32>(1.0),
|
||||||
PhysicalSize::new(1, 2)
|
dpi::PhysicalSize::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Size::new(LogicalSize::new(1.0, 2.0)).to_physical::<u32>(2.0),
|
dpi::Size::new(dpi::LogicalSize::new(1.0, 2.0)).to_physical::<u32>(2.0),
|
||||||
PhysicalSize::new(2, 4)
|
dpi::PhysicalSize::new(2, 4)
|
||||||
);
|
);
|
||||||
|
|
||||||
let small = Size::Physical((1, 2).into());
|
let small = dpi::Size::Physical((1, 2).into());
|
||||||
let medium = Size::Logical((3, 4).into());
|
let medium = dpi::Size::Logical((3, 4).into());
|
||||||
let medium_physical = Size::new(medium.to_physical::<u32>(1.0));
|
let medium_physical = dpi::Size::new(medium.to_physical::<u32>(1.0));
|
||||||
let large = Size::Physical((5, 6).into());
|
let large = dpi::Size::Physical((5, 6).into());
|
||||||
assert_eq!(Size::clamp(medium, small, large, 1.0), medium_physical);
|
assert_eq!(dpi::Size::clamp(medium, small, large, 1.0), medium_physical);
|
||||||
assert_eq!(Size::clamp(small, medium, large, 1.0), medium_physical);
|
assert_eq!(dpi::Size::clamp(small, medium, large, 1.0), medium_physical);
|
||||||
assert_eq!(Size::clamp(large, small, medium, 1.0), medium_physical);
|
assert_eq!(dpi::Size::clamp(large, small, medium, 1.0), medium_physical);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_position() {
|
fn test_position() {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(PhysicalPosition::new(1, 2)),
|
dpi::Position::new(dpi::PhysicalPosition::new(1, 2)),
|
||||||
Position::Physical(PhysicalPosition::new(1, 2))
|
dpi::Position::Physical(dpi::PhysicalPosition::new(1, 2))
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(LogicalPosition::new(1.0, 2.0)),
|
dpi::Position::new(dpi::LogicalPosition::new(1.0, 2.0)),
|
||||||
Position::Logical(LogicalPosition::new(1.0, 2.0))
|
dpi::Position::Logical(dpi::LogicalPosition::new(1.0, 2.0))
|
||||||
);
|
);
|
||||||
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(PhysicalPosition::new(1, 2)).to_logical::<f64>(1.0),
|
dpi::Position::new(dpi::PhysicalPosition::new(1, 2)).to_logical::<f64>(1.0),
|
||||||
LogicalPosition::new(1.0, 2.0)
|
dpi::LogicalPosition::new(1.0, 2.0)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(PhysicalPosition::new(1, 2)).to_logical::<f64>(2.0),
|
dpi::Position::new(dpi::PhysicalPosition::new(1, 2)).to_logical::<f64>(2.0),
|
||||||
LogicalPosition::new(0.5, 1.0)
|
dpi::LogicalPosition::new(0.5, 1.0)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(LogicalPosition::new(1.0, 2.0)).to_logical::<f64>(1.0),
|
dpi::Position::new(dpi::LogicalPosition::new(1.0, 2.0)).to_logical::<f64>(1.0),
|
||||||
LogicalPosition::new(1.0, 2.0)
|
dpi::LogicalPosition::new(1.0, 2.0)
|
||||||
);
|
);
|
||||||
|
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(PhysicalPosition::new(1, 2)).to_physical::<u32>(1.0),
|
dpi::Position::new(dpi::PhysicalPosition::new(1, 2)).to_physical::<u32>(1.0),
|
||||||
PhysicalPosition::new(1, 2)
|
dpi::PhysicalPosition::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(PhysicalPosition::new(1, 2)).to_physical::<u32>(2.0),
|
dpi::Position::new(dpi::PhysicalPosition::new(1, 2)).to_physical::<u32>(2.0),
|
||||||
PhysicalPosition::new(1, 2)
|
dpi::PhysicalPosition::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(LogicalPosition::new(1.0, 2.0)).to_physical::<u32>(1.0),
|
dpi::Position::new(dpi::LogicalPosition::new(1.0, 2.0)).to_physical::<u32>(1.0),
|
||||||
PhysicalPosition::new(1, 2)
|
dpi::PhysicalPosition::new(1, 2)
|
||||||
);
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
Position::new(LogicalPosition::new(1.0, 2.0)).to_physical::<u32>(2.0),
|
dpi::Position::new(dpi::LogicalPosition::new(1.0, 2.0)).to_physical::<u32>(2.0),
|
||||||
PhysicalPosition::new(2, 4)
|
dpi::PhysicalPosition::new(2, 4)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Eat coverage for the Debug impls et al
|
// Eat coverage for the Debug impls et al
|
||||||
#[test]
|
#[test]
|
||||||
fn ensure_attrs_do_not_panic() {
|
fn ensure_attrs_do_not_panic() {
|
||||||
let _ = format!("{:?}", LogicalPosition::<u32>::default().clone());
|
let _ = format!("{:?}", dpi::LogicalPosition::<u32>::default().clone());
|
||||||
HashSet::new().insert(LogicalPosition::<u32>::default());
|
HashSet::new().insert(dpi::LogicalPosition::<u32>::default());
|
||||||
|
|
||||||
let _ = format!("{:?}", PhysicalPosition::<u32>::default().clone());
|
let _ = format!("{:?}", dpi::PhysicalPosition::<u32>::default().clone());
|
||||||
HashSet::new().insert(PhysicalPosition::<u32>::default());
|
HashSet::new().insert(dpi::PhysicalPosition::<u32>::default());
|
||||||
|
|
||||||
let _ = format!("{:?}", LogicalSize::<u32>::default().clone());
|
let _ = format!("{:?}", dpi::LogicalSize::<u32>::default().clone());
|
||||||
HashSet::new().insert(LogicalSize::<u32>::default());
|
HashSet::new().insert(dpi::LogicalSize::<u32>::default());
|
||||||
|
|
||||||
let _ = format!("{:?}", PhysicalSize::<u32>::default().clone());
|
let _ = format!("{:?}", dpi::PhysicalSize::<u32>::default().clone());
|
||||||
HashSet::new().insert(PhysicalSize::<u32>::default());
|
HashSet::new().insert(dpi::PhysicalSize::<u32>::default());
|
||||||
|
|
||||||
let _ = format!("{:?}", Size::Physical((1, 2).into()).clone());
|
let _ = format!("{:?}", dpi::Size::Physical((1, 2).into()).clone());
|
||||||
let _ = format!("{:?}", Position::Physical((1, 2).into()).clone());
|
let _ = format!("{:?}", dpi::Position::Physical((1, 2).into()).clone());
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn ensure_copy_trait() {
|
|
||||||
fn is_copy<T: Copy>() {}
|
|
||||||
|
|
||||||
is_copy::<LogicalUnit<i32>>();
|
|
||||||
is_copy::<PhysicalUnit<f64>>();
|
|
||||||
is_copy::<PixelUnit>();
|
|
||||||
|
|
||||||
is_copy::<LogicalSize<i32>>();
|
|
||||||
is_copy::<PhysicalSize<f64>>();
|
|
||||||
is_copy::<Size>();
|
|
||||||
|
|
||||||
is_copy::<LogicalPosition<i32>>();
|
|
||||||
is_copy::<PhysicalPosition<f64>>();
|
|
||||||
is_copy::<Position>();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn ensure_partial_eq_trait() {
|
|
||||||
fn is_partial_eq<T: PartialEq>() {}
|
|
||||||
|
|
||||||
is_partial_eq::<LogicalUnit<i32>>();
|
|
||||||
is_partial_eq::<PhysicalUnit<f64>>();
|
|
||||||
is_partial_eq::<PixelUnit>();
|
|
||||||
|
|
||||||
is_partial_eq::<LogicalSize<i32>>();
|
|
||||||
is_partial_eq::<PhysicalSize<f64>>();
|
|
||||||
is_partial_eq::<Size>();
|
|
||||||
|
|
||||||
is_partial_eq::<LogicalPosition<i32>>();
|
|
||||||
is_partial_eq::<PhysicalPosition<f64>>();
|
|
||||||
is_partial_eq::<Position>();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
54
winit-core/src/error.rs
Normal file
54
winit-core/src/error.rs
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
//! Common error types.
|
||||||
|
|
||||||
|
use std::{error, fmt};
|
||||||
|
|
||||||
|
/// The error type for when the requested operation is not supported by the backend.
|
||||||
|
#[derive(Clone)]
|
||||||
|
pub struct NotSupportedError {
|
||||||
|
_marker: (),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for NotSupportedError {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::new()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl NotSupportedError {
|
||||||
|
/// Create a new [`NotSupportedError`].
|
||||||
|
#[inline]
|
||||||
|
pub fn new() -> NotSupportedError {
|
||||||
|
NotSupportedError { _marker: () }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Debug for NotSupportedError {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
|
||||||
|
f.debug_struct("NotSupportedError").finish()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Display for NotSupportedError {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
|
||||||
|
f.pad("the requested operation is not supported by Winit")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl error::Error for NotSupportedError {}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
#![allow(clippy::redundant_clone)]
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
// Eat attributes for testing
|
||||||
|
#[test]
|
||||||
|
fn ensure_fmt_does_not_panic() {
|
||||||
|
let _ = format!(
|
||||||
|
"{:?}, {}",
|
||||||
|
NotSupportedError::new(),
|
||||||
|
NotSupportedError::new().clone()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,113 +1,263 @@
|
|||||||
//! The [`Event`] enum and assorted supporting types.
|
//! Incoming notifications from the GUI system.
|
||||||
//!
|
|
||||||
//! These are sent to the closure given to [`EventLoop::run_app(...)`], where they get
|
use crate::dpi::{PhysicalPosition, PhysicalSize};
|
||||||
//! processed and used to modify the program state. For more details, see the root-level
|
use crate::event_loop::AsyncRequestSerial;
|
||||||
//! documentation.
|
use crate::keyboard::{self, ModifiersKeyState, ModifiersKeys, ModifiersState};
|
||||||
//!
|
use crate::window::{ActivationToken, Theme, WindowId};
|
||||||
//! Some of these events represent different "parts" of a traditional event-handling loop. You could
|
|
||||||
//! approximate the basic ordering loop of [`EventLoop::run_app(...)`] like this:
|
use std::fmt;
|
||||||
//!
|
|
||||||
//! ```rust,ignore
|
|
||||||
//! let mut start_cause = StartCause::Init;
|
|
||||||
//!
|
|
||||||
//! while !elwt.exiting() {
|
|
||||||
//! app.new_events(event_loop, start_cause);
|
|
||||||
//!
|
|
||||||
//! for event in (window events, user events, device events) {
|
|
||||||
//! // This will pick the right method on the application based on the event.
|
|
||||||
//! app.handle_event(event_loop, event);
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! for window_id in (redraw windows) {
|
|
||||||
//! app.window_event(event_loop, window_id, RedrawRequested);
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! app.about_to_wait(event_loop);
|
|
||||||
//! start_cause = wait_if_necessary();
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! app.exiting(event_loop);
|
|
||||||
//! ```
|
|
||||||
//!
|
|
||||||
//! This leaves out timing details like [`ControlFlow::WaitUntil`] but hopefully
|
|
||||||
//! describes what happens in what order.
|
|
||||||
//!
|
|
||||||
//! [`EventLoop::run_app(...)`]: crate::event_loop::EventLoop::run_app
|
|
||||||
//! [`ControlFlow::WaitUntil`]: crate::event_loop::ControlFlow::WaitUntil
|
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::sync::{Mutex, Weak};
|
use std::sync::{Mutex, Weak};
|
||||||
|
|
||||||
#[cfg(not(web_platform))]
|
#[cfg(not(web_platform))]
|
||||||
use std::time::Instant;
|
use std::time::Instant;
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
use smol_str::SmolStr;
|
|
||||||
#[cfg(web_platform)]
|
#[cfg(web_platform)]
|
||||||
use web_time::Instant;
|
use web_time::Instant;
|
||||||
|
|
||||||
use crate::dpi::{PhysicalPosition, PhysicalSize};
|
#[cfg(feature = "serde")]
|
||||||
use crate::error::ExternalError;
|
pub use serde::{Deserialize, Serialize};
|
||||||
use crate::event_loop::AsyncRequestSerial;
|
|
||||||
use crate::keyboard::{self, ModifiersKeyState, ModifiersKeys, ModifiersState};
|
use smol_str::SmolStr;
|
||||||
use crate::platform_impl;
|
|
||||||
#[cfg(doc)]
|
/// Identifier of an input device.
|
||||||
use crate::window::Window;
|
///
|
||||||
use crate::window::{ActivationToken, Theme, WindowId};
|
/// Whenever you receive an event arising from a particular input device, this event contains a `DeviceId` which
|
||||||
|
/// identifies its origin. Note that devices may be virtual (representing an on-screen cursor and keyboard focus) or
|
||||||
|
/// physical. Virtual devices typically aggregate inputs from multiple physical devices.
|
||||||
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
pub struct DeviceId(u64);
|
||||||
|
|
||||||
|
impl DeviceId {
|
||||||
|
/// Returns a dummy id, useful for unit testing.
|
||||||
|
///
|
||||||
|
/// # Safety
|
||||||
|
///
|
||||||
|
/// The only guarantee made about the return value of this function is that
|
||||||
|
/// it will always be equal to itself and to future values returned by this function.
|
||||||
|
/// No other guarantees are made. This may be equal to a real `DeviceId`.
|
||||||
|
///
|
||||||
|
/// **Passing this into a winit function will result in undefined behavior.**
|
||||||
|
pub const unsafe fn dummy() -> Self {
|
||||||
|
DeviceId(0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<u64> for DeviceId {
|
||||||
|
fn from(value: u64) -> Self {
|
||||||
|
Self(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<DeviceId> for u64 {
|
||||||
|
fn from(value: DeviceId) -> Self {
|
||||||
|
value.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Describes a generic event.
|
/// Describes a generic event.
|
||||||
///
|
///
|
||||||
/// See the module-level docs for more information on the event loop manages each event.
|
/// See the module-level docs for more information on the event loop manages each event.
|
||||||
#[derive(Debug, Clone, PartialEq)]
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
pub enum Event<T: 'static> {
|
pub enum Event<T: 'static, KeyExtra> {
|
||||||
/// See [`ApplicationHandler::new_events`] for details.
|
/// Emitted when new events arrive from the OS to be processed.
|
||||||
///
|
///
|
||||||
/// [`ApplicationHandler::new_events`]: crate::application::ApplicationHandler::new_events
|
/// This event type is useful as a place to put code that should be done before you start
|
||||||
|
/// processing events, such as updating frame timing information for benchmarking or checking
|
||||||
|
/// the [`StartCause`] to see if a timer set by
|
||||||
|
/// [`ControlFlow::WaitUntil`](crate::event_loop::ControlFlow::WaitUntil) has elapsed.
|
||||||
NewEvents(StartCause),
|
NewEvents(StartCause),
|
||||||
|
|
||||||
/// See [`ApplicationHandler::window_event`] for details.
|
/// Emitted when the OS sends an event to a winit window.
|
||||||
///
|
WindowEvent {
|
||||||
/// [`ApplicationHandler::window_event`]: crate::application::ApplicationHandler::window_event
|
window_id: WindowId,
|
||||||
WindowEvent { window_id: WindowId, event: WindowEvent },
|
event: WindowEvent<KeyExtra>,
|
||||||
|
},
|
||||||
|
|
||||||
/// See [`ApplicationHandler::device_event`] for details.
|
/// Emitted when the OS sends an event to a device.
|
||||||
///
|
DeviceEvent {
|
||||||
/// [`ApplicationHandler::device_event`]: crate::application::ApplicationHandler::device_event
|
device_id: DeviceId,
|
||||||
DeviceEvent { device_id: DeviceId, event: DeviceEvent },
|
event: DeviceEvent,
|
||||||
|
},
|
||||||
|
|
||||||
/// See [`ApplicationHandler::user_event`] for details.
|
/// Emitted when an event is sent from [`EventLoopProxy::send_event`](https://docs.rs/winit/latest/winit/event_loop/struct.EventLoopProxy.html#method.send_event)
|
||||||
///
|
|
||||||
/// [`ApplicationHandler::user_event`]: crate::application::ApplicationHandler::user_event
|
|
||||||
UserEvent(T),
|
UserEvent(T),
|
||||||
|
|
||||||
/// See [`ApplicationHandler::suspended`] for details.
|
/// Emitted when the application has been suspended.
|
||||||
///
|
///
|
||||||
/// [`ApplicationHandler::suspended`]: crate::application::ApplicationHandler::suspended
|
/// # Portability
|
||||||
|
///
|
||||||
|
/// Not all platforms support the notion of suspending applications, and there may be no
|
||||||
|
/// technical way to guarantee being able to emit a `Suspended` event if the OS has
|
||||||
|
/// no formal application lifecycle (currently only Android, iOS, and Web do). For this reason,
|
||||||
|
/// Winit does not currently try to emit pseudo `Suspended` events before the application
|
||||||
|
/// quits on platforms without an application lifecycle.
|
||||||
|
///
|
||||||
|
/// Considering that the implementation of `Suspended` and [`Resumed`] events may be internally
|
||||||
|
/// driven by multiple platform-specific events, and that there may be subtle differences across
|
||||||
|
/// platforms with how these internal events are delivered, it's recommended that applications
|
||||||
|
/// be able to gracefully handle redundant (i.e. back-to-back) `Suspended` or [`Resumed`] events.
|
||||||
|
///
|
||||||
|
/// Also see [`Resumed`] notes.
|
||||||
|
///
|
||||||
|
/// ## Android
|
||||||
|
///
|
||||||
|
/// On Android, the `Suspended` event is only sent when the application's associated
|
||||||
|
/// [`SurfaceView`] is destroyed. This is expected to closely correlate with the [`onPause`]
|
||||||
|
/// lifecycle event but there may technically be a discrepancy.
|
||||||
|
///
|
||||||
|
/// [`onPause`]: https://developer.android.com/reference/android/app/Activity#onPause()
|
||||||
|
///
|
||||||
|
/// Applications that need to run on Android should assume their [`SurfaceView`] has been
|
||||||
|
/// destroyed, which indirectly invalidates any existing render surfaces that may have been
|
||||||
|
/// created outside of Winit (such as an `EGLSurface`, [`VkSurfaceKHR`] or [`wgpu::Surface`]).
|
||||||
|
///
|
||||||
|
/// After being `Suspended` on Android applications must drop all render surfaces before
|
||||||
|
/// the event callback completes, which may be re-created when the application is next [`Resumed`].
|
||||||
|
///
|
||||||
|
/// [`SurfaceView`]: https://developer.android.com/reference/android/view/SurfaceView
|
||||||
|
/// [Activity lifecycle]: https://developer.android.com/guide/components/activities/activity-lifecycle
|
||||||
|
/// [`VkSurfaceKHR`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkSurfaceKHR.html
|
||||||
|
/// [`wgpu::Surface`]: https://docs.rs/wgpu/latest/wgpu/struct.Surface.html
|
||||||
|
///
|
||||||
|
/// ## iOS
|
||||||
|
///
|
||||||
|
/// On iOS, the `Suspended` event is currently emitted in response to an
|
||||||
|
/// [`applicationWillResignActive`] callback which means that the application is
|
||||||
|
/// about to transition from the active to inactive state (according to the
|
||||||
|
/// [iOS application lifecycle]).
|
||||||
|
///
|
||||||
|
/// [`applicationWillResignActive`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622950-applicationwillresignactive
|
||||||
|
/// [iOS application lifecycle]: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle
|
||||||
|
///
|
||||||
|
/// ## Web
|
||||||
|
///
|
||||||
|
/// On Web, the `Suspended` event is emitted in response to a [`pagehide`] event
|
||||||
|
/// with the property [`persisted`] being true, which means that the page is being
|
||||||
|
/// put in the [`bfcache`] (back/forward cache) - an in-memory cache that stores a
|
||||||
|
/// complete snapshot of a page (including the JavaScript heap) as the user is
|
||||||
|
/// navigating away.
|
||||||
|
///
|
||||||
|
/// [`pagehide`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/pagehide_event
|
||||||
|
/// [`persisted`]: https://developer.mozilla.org/en-US/docs/Web/API/PageTransitionEvent/persisted
|
||||||
|
/// [`bfcache`]: https://web.dev/bfcache/
|
||||||
|
///
|
||||||
|
/// [`Resumed`]: Self::Resumed
|
||||||
Suspended,
|
Suspended,
|
||||||
|
|
||||||
/// See [`ApplicationHandler::resumed`] for details.
|
/// Emitted when the application has been resumed.
|
||||||
///
|
///
|
||||||
/// [`ApplicationHandler::resumed`]: crate::application::ApplicationHandler::resumed
|
/// For consistency, all platforms emit a `Resumed` event even if they don't themselves have a
|
||||||
|
/// formal suspend/resume lifecycle. For systems without a standard suspend/resume lifecycle
|
||||||
|
/// the `Resumed` event is always emitted after the [`NewEvents(StartCause::Init)`][StartCause::Init]
|
||||||
|
/// event.
|
||||||
|
///
|
||||||
|
/// # Portability
|
||||||
|
///
|
||||||
|
/// It's recommended that applications should only initialize their graphics context and create
|
||||||
|
/// a window after they have received their first `Resumed` event. Some systems
|
||||||
|
/// (specifically Android) won't allow applications to create a render surface until they are
|
||||||
|
/// resumed.
|
||||||
|
///
|
||||||
|
/// Considering that the implementation of [`Suspended`] and `Resumed` events may be internally
|
||||||
|
/// driven by multiple platform-specific events, and that there may be subtle differences across
|
||||||
|
/// platforms with how these internal events are delivered, it's recommended that applications
|
||||||
|
/// be able to gracefully handle redundant (i.e. back-to-back) [`Suspended`] or `Resumed` events.
|
||||||
|
///
|
||||||
|
/// Also see [`Suspended`] notes.
|
||||||
|
///
|
||||||
|
/// ## Android
|
||||||
|
///
|
||||||
|
/// On Android, the `Resumed` event is sent when a new [`SurfaceView`] has been created. This is
|
||||||
|
/// expected to closely correlate with the [`onResume`] lifecycle event but there may technically
|
||||||
|
/// be a discrepancy.
|
||||||
|
///
|
||||||
|
/// [`onResume`]: https://developer.android.com/reference/android/app/Activity#onResume()
|
||||||
|
///
|
||||||
|
/// Applications that need to run on Android must wait until they have been `Resumed`
|
||||||
|
/// before they will be able to create a render surface (such as an `EGLSurface`,
|
||||||
|
/// [`VkSurfaceKHR`] or [`wgpu::Surface`]) which depend on having a
|
||||||
|
/// [`SurfaceView`]. Applications must also assume that if they are [`Suspended`], then their
|
||||||
|
/// render surfaces are invalid and should be dropped.
|
||||||
|
///
|
||||||
|
/// Also see [`Suspended`] notes.
|
||||||
|
///
|
||||||
|
/// [`SurfaceView`]: https://developer.android.com/reference/android/view/SurfaceView
|
||||||
|
/// [Activity lifecycle]: https://developer.android.com/guide/components/activities/activity-lifecycle
|
||||||
|
/// [`VkSurfaceKHR`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkSurfaceKHR.html
|
||||||
|
/// [`wgpu::Surface`]: https://docs.rs/wgpu/latest/wgpu/struct.Surface.html
|
||||||
|
///
|
||||||
|
/// ## iOS
|
||||||
|
///
|
||||||
|
/// On iOS, the `Resumed` event is emitted in response to an [`applicationDidBecomeActive`]
|
||||||
|
/// callback which means the application is "active" (according to the
|
||||||
|
/// [iOS application lifecycle]).
|
||||||
|
///
|
||||||
|
/// [`applicationDidBecomeActive`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622956-applicationdidbecomeactive
|
||||||
|
/// [iOS application lifecycle]: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle
|
||||||
|
///
|
||||||
|
/// ## Web
|
||||||
|
///
|
||||||
|
/// On Web, the `Resumed` event is emitted in response to a [`pageshow`] event
|
||||||
|
/// with the property [`persisted`] being true, which means that the page is being
|
||||||
|
/// restored from the [`bfcache`] (back/forward cache) - an in-memory cache that
|
||||||
|
/// stores a complete snapshot of a page (including the JavaScript heap) as the
|
||||||
|
/// user is navigating away.
|
||||||
|
///
|
||||||
|
/// [`pageshow`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event
|
||||||
|
/// [`persisted`]: https://developer.mozilla.org/en-US/docs/Web/API/PageTransitionEvent/persisted
|
||||||
|
/// [`bfcache`]: https://web.dev/bfcache/
|
||||||
|
///
|
||||||
|
/// [`Suspended`]: Self::Suspended
|
||||||
Resumed,
|
Resumed,
|
||||||
|
|
||||||
/// See [`ApplicationHandler::about_to_wait`] for details.
|
/// Emitted when the event loop is about to block and wait for new events.
|
||||||
///
|
///
|
||||||
/// [`ApplicationHandler::about_to_wait`]: crate::application::ApplicationHandler::about_to_wait
|
/// Most applications shouldn't need to hook into this event since there is no real relationship
|
||||||
|
/// between how often the event loop needs to wake up and the dispatching of any specific events.
|
||||||
|
///
|
||||||
|
/// High frequency event sources, such as input devices could potentially lead to lots of wake
|
||||||
|
/// ups and also lots of corresponding `AboutToWait` events.
|
||||||
|
///
|
||||||
|
/// This is not an ideal event to drive application rendering from and instead applications
|
||||||
|
/// should render in response to [`WindowEvent::RedrawRequested`] events.
|
||||||
AboutToWait,
|
AboutToWait,
|
||||||
|
|
||||||
/// See [`ApplicationHandler::exiting`] for details.
|
/// Emitted when the event loop is being shut down.
|
||||||
///
|
///
|
||||||
/// [`ApplicationHandler::exiting`]: crate::application::ApplicationHandler::exiting
|
/// This is irreversible - if this event is emitted, it is guaranteed to be the last event that
|
||||||
|
/// gets emitted. You generally want to treat this as a "do on quit" event.
|
||||||
LoopExiting,
|
LoopExiting,
|
||||||
|
|
||||||
/// See [`ApplicationHandler::memory_warning`] for details.
|
/// Emitted when the application has received a memory warning.
|
||||||
///
|
///
|
||||||
/// [`ApplicationHandler::memory_warning`]: crate::application::ApplicationHandler::memory_warning
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// ### Android
|
||||||
|
///
|
||||||
|
/// On Android, the `MemoryWarning` event is sent when [`onLowMemory`] was called. The application
|
||||||
|
/// must [release memory] or risk being killed.
|
||||||
|
///
|
||||||
|
/// [`onLowMemory`]: https://developer.android.com/reference/android/app/Application.html#onLowMemory()
|
||||||
|
/// [release memory]: https://developer.android.com/topic/performance/memory#release
|
||||||
|
///
|
||||||
|
/// ### iOS
|
||||||
|
///
|
||||||
|
/// On iOS, the `MemoryWarning` event is emitted in response to an [`applicationDidReceiveMemoryWarning`]
|
||||||
|
/// callback. The application must free as much memory as possible or risk being terminated, see
|
||||||
|
/// [how to respond to memory warnings].
|
||||||
|
///
|
||||||
|
/// [`applicationDidReceiveMemoryWarning`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623063-applicationdidreceivememorywarni
|
||||||
|
/// [how to respond to memory warnings]: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle/responding_to_memory_warnings
|
||||||
|
///
|
||||||
|
/// ### Others
|
||||||
|
///
|
||||||
|
/// - **macOS / Wayland / Windows / Orbital:** Unsupported.
|
||||||
MemoryWarning,
|
MemoryWarning,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> Event<T> {
|
impl<T, Extra> Event<T, Extra> {
|
||||||
#[allow(clippy::result_large_err)]
|
#[allow(clippy::result_large_err)]
|
||||||
pub fn map_nonuser_event<U>(self) -> Result<Event<U>, Event<T>> {
|
pub fn map_nonuser_event<U>(self) -> Result<Event<U, Extra>, Event<T, Extra>> {
|
||||||
use self::Event::*;
|
use self::Event::*;
|
||||||
match self {
|
match self {
|
||||||
UserEvent(_) => Err(self),
|
UserEvent(_) => Err(self),
|
||||||
@@ -131,11 +281,17 @@ pub enum StartCause {
|
|||||||
/// guaranteed to be equal to or after the requested resume time.
|
/// guaranteed to be equal to or after the requested resume time.
|
||||||
///
|
///
|
||||||
/// [`ControlFlow::WaitUntil`]: crate::event_loop::ControlFlow::WaitUntil
|
/// [`ControlFlow::WaitUntil`]: crate::event_loop::ControlFlow::WaitUntil
|
||||||
ResumeTimeReached { start: Instant, requested_resume: Instant },
|
ResumeTimeReached {
|
||||||
|
start: Instant,
|
||||||
|
requested_resume: Instant,
|
||||||
|
},
|
||||||
|
|
||||||
/// Sent if the OS has new events to send to the window, after a wait was requested. Contains
|
/// Sent if the OS has new events to send to the window, after a wait was requested. Contains
|
||||||
/// the moment the wait was requested and the resume time, if requested.
|
/// the moment the wait was requested and the resume time, if requested.
|
||||||
WaitCancelled { start: Instant, requested_resume: Option<Instant> },
|
WaitCancelled {
|
||||||
|
start: Instant,
|
||||||
|
requested_resume: Option<Instant>,
|
||||||
|
},
|
||||||
|
|
||||||
/// Sent if the event loop is being resumed after the loop's control flow was set to
|
/// Sent if the event loop is being resumed after the loop's control flow was set to
|
||||||
/// [`ControlFlow::Poll`].
|
/// [`ControlFlow::Poll`].
|
||||||
@@ -148,14 +304,23 @@ pub enum StartCause {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Describes an event from a [`Window`].
|
/// Describes an event from a [`Window`].
|
||||||
|
///
|
||||||
|
/// [`Window`]: https://docs.rs/winit/latest/winit/window/struct.Window.html
|
||||||
#[derive(Debug, Clone, PartialEq)]
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
pub enum WindowEvent {
|
pub enum WindowEvent<KeyExtra> {
|
||||||
/// The activation token was delivered back and now could be used.
|
/// The activation token was delivered back and now could be used.
|
||||||
#[cfg_attr(not(any(x11_platform, wayland_platform)), allow(rustdoc::broken_intra_doc_links))]
|
///
|
||||||
|
#[cfg_attr(
|
||||||
|
not(any(x11_platform, wayland_platfrom)),
|
||||||
|
allow(rustdoc::broken_intra_doc_links)
|
||||||
|
)]
|
||||||
/// Delivered in response to [`request_activation_token`].
|
/// Delivered in response to [`request_activation_token`].
|
||||||
///
|
///
|
||||||
/// [`request_activation_token`]: crate::platform::startup_notify::WindowExtStartupNotify::request_activation_token
|
/// [`request_activation_token`]: crate::platform::startup_notify::WindowExtStartupNotify::request_activation_token
|
||||||
ActivationTokenDone { serial: AsyncRequestSerial, token: ActivationToken },
|
ActivationTokenDone {
|
||||||
|
serial: AsyncRequestSerial,
|
||||||
|
token: ActivationToken,
|
||||||
|
},
|
||||||
|
|
||||||
/// The size of the window has changed. Contains the client area's new dimensions.
|
/// The size of the window has changed. Contains the client area's new dimensions.
|
||||||
Resized(PhysicalSize<u32>),
|
Resized(PhysicalSize<u32>),
|
||||||
@@ -204,15 +369,15 @@ pub enum WindowEvent {
|
|||||||
/// events which are not marked as `is_synthetic`.
|
/// events which are not marked as `is_synthetic`.
|
||||||
KeyboardInput {
|
KeyboardInput {
|
||||||
device_id: DeviceId,
|
device_id: DeviceId,
|
||||||
event: KeyEvent,
|
event: KeyEvent<KeyExtra>,
|
||||||
|
|
||||||
/// If `true`, the event was generated synthetically by winit
|
/// If `true`, the event was generated synthetically by winit
|
||||||
/// in one of the following circumstances:
|
/// in one of the following circumstances:
|
||||||
///
|
///
|
||||||
/// * Synthetic key press events are generated for all keys pressed when a window gains
|
/// * Synthetic key press events are generated for all keys pressed
|
||||||
/// focus. Likewise, synthetic key release events are generated for all keys pressed when
|
/// when a window gains focus. Likewise, synthetic key release events
|
||||||
/// a window goes out of focus. ***Currently, this is only functional on X11 and
|
/// are generated for all keys pressed when a window goes out of focus.
|
||||||
/// Windows***
|
/// ***Currently, this is only functional on X11 and Windows***
|
||||||
///
|
///
|
||||||
/// Otherwise, this value is always `false`.
|
/// Otherwise, this value is always `false`.
|
||||||
is_synthetic: bool,
|
is_synthetic: bool,
|
||||||
@@ -228,6 +393,8 @@ pub enum WindowEvent {
|
|||||||
/// ## Platform-specific
|
/// ## Platform-specific
|
||||||
///
|
///
|
||||||
/// - **iOS / Android / Web / Orbital:** Unsupported.
|
/// - **iOS / Android / Web / Orbital:** Unsupported.
|
||||||
|
///
|
||||||
|
/// [`Window::set_ime_allowed`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.set_ime_allowed
|
||||||
Ime(Ime),
|
Ime(Ime),
|
||||||
|
|
||||||
/// The cursor has moved on the window.
|
/// The cursor has moved on the window.
|
||||||
@@ -242,10 +409,9 @@ pub enum WindowEvent {
|
|||||||
CursorMoved {
|
CursorMoved {
|
||||||
device_id: DeviceId,
|
device_id: DeviceId,
|
||||||
|
|
||||||
/// (x,y) coords in pixels relative to the top-left corner of the window. Because the range
|
/// (x,y) coords in pixels relative to the top-left corner of the window. Because the range of this data is
|
||||||
/// of this data is limited by the display area and it may have been transformed by
|
/// limited by the display area and it may have been transformed by the OS to implement effects such as cursor
|
||||||
/// the OS to implement effects such as cursor acceleration, it should not be used
|
/// acceleration, it should not be used to implement non-cursor-like interactions such as 3D camera control.
|
||||||
/// to implement non-cursor-like interactions such as 3D camera control.
|
|
||||||
position: PhysicalPosition<f64>,
|
position: PhysicalPosition<f64>,
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -272,10 +438,18 @@ pub enum WindowEvent {
|
|||||||
CursorLeft { device_id: DeviceId },
|
CursorLeft { device_id: DeviceId },
|
||||||
|
|
||||||
/// A mouse wheel movement or touchpad scroll occurred.
|
/// A mouse wheel movement or touchpad scroll occurred.
|
||||||
MouseWheel { device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase },
|
MouseWheel {
|
||||||
|
device_id: DeviceId,
|
||||||
|
delta: MouseScrollDelta,
|
||||||
|
phase: TouchPhase,
|
||||||
|
},
|
||||||
|
|
||||||
/// An mouse button press has been received.
|
/// An mouse button press has been received.
|
||||||
MouseInput { device_id: DeviceId, state: ElementState, button: MouseButton },
|
MouseInput {
|
||||||
|
device_id: DeviceId,
|
||||||
|
state: ElementState,
|
||||||
|
button: MouseButton,
|
||||||
|
},
|
||||||
|
|
||||||
/// Two-finger pinch gesture, often used for magnification.
|
/// Two-finger pinch gesture, often used for magnification.
|
||||||
///
|
///
|
||||||
@@ -293,19 +467,6 @@ pub enum WindowEvent {
|
|||||||
phase: TouchPhase,
|
phase: TouchPhase,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// N-finger pan gesture
|
|
||||||
///
|
|
||||||
/// ## Platform-specific
|
|
||||||
///
|
|
||||||
/// - Only available on **iOS**.
|
|
||||||
/// - On iOS, not recognized by default. It must be enabled when needed.
|
|
||||||
PanGesture {
|
|
||||||
device_id: DeviceId,
|
|
||||||
/// Change in pixels of pan gesture from last update.
|
|
||||||
delta: PhysicalPosition<f32>,
|
|
||||||
phase: TouchPhase,
|
|
||||||
},
|
|
||||||
|
|
||||||
/// Double tap gesture.
|
/// Double tap gesture.
|
||||||
///
|
///
|
||||||
/// On a Mac, smart magnification is triggered by a double tap with two fingers
|
/// On a Mac, smart magnification is triggered by a double tap with two fingers
|
||||||
@@ -316,7 +477,7 @@ pub enum WindowEvent {
|
|||||||
/// The event is general enough that its generating gesture is allowed to vary
|
/// The event is general enough that its generating gesture is allowed to vary
|
||||||
/// across platforms. It could also be generated by another device.
|
/// across platforms. It could also be generated by another device.
|
||||||
///
|
///
|
||||||
/// Unfortunately, neither [Windows](https://support.microsoft.com/en-us/windows/touch-gestures-for-windows-a9d28305-4818-a5df-4e2b-e5590f850741)
|
/// Unfortunatly, neither [Windows](https://support.microsoft.com/en-us/windows/touch-gestures-for-windows-a9d28305-4818-a5df-4e2b-e5590f850741)
|
||||||
/// nor [Wayland](https://wayland.freedesktop.org/libinput/doc/latest/gestures.html)
|
/// nor [Wayland](https://wayland.freedesktop.org/libinput/doc/latest/gestures.html)
|
||||||
/// support this gesture or any other gesture with the same effect.
|
/// support this gesture or any other gesture with the same effect.
|
||||||
///
|
///
|
||||||
@@ -337,7 +498,6 @@ pub enum WindowEvent {
|
|||||||
/// - On iOS, not recognized by default. It must be enabled when needed.
|
/// - On iOS, not recognized by default. It must be enabled when needed.
|
||||||
RotationGesture {
|
RotationGesture {
|
||||||
device_id: DeviceId,
|
device_id: DeviceId,
|
||||||
/// change in rotation in degrees
|
|
||||||
delta: f32,
|
delta: f32,
|
||||||
phase: TouchPhase,
|
phase: TouchPhase,
|
||||||
},
|
},
|
||||||
@@ -345,12 +505,20 @@ pub enum WindowEvent {
|
|||||||
/// Touchpad pressure event.
|
/// Touchpad pressure event.
|
||||||
///
|
///
|
||||||
/// At the moment, only supported on Apple forcetouch-capable macbooks.
|
/// At the moment, only supported on Apple forcetouch-capable macbooks.
|
||||||
/// The parameters are: pressure level (value between 0 and 1 representing how hard the
|
/// The parameters are: pressure level (value between 0 and 1 representing how hard the touchpad
|
||||||
/// touchpad is being pressed) and stage (integer representing the click level).
|
/// is being pressed) and stage (integer representing the click level).
|
||||||
TouchpadPressure { device_id: DeviceId, pressure: f32, stage: i64 },
|
TouchpadPressure {
|
||||||
|
device_id: DeviceId,
|
||||||
|
pressure: f32,
|
||||||
|
stage: i64,
|
||||||
|
},
|
||||||
|
|
||||||
/// Motion on some analog axis. May report data redundant to other, more specific events.
|
/// Motion on some analog axis. May report data redundant to other, more specific events.
|
||||||
AxisMotion { device_id: DeviceId, axis: AxisId, value: f64 },
|
AxisMotion {
|
||||||
|
device_id: DeviceId,
|
||||||
|
axis: AxisId,
|
||||||
|
value: f64,
|
||||||
|
},
|
||||||
|
|
||||||
/// Touch event has been received
|
/// Touch event has been received
|
||||||
///
|
///
|
||||||
@@ -372,10 +540,11 @@ pub enum WindowEvent {
|
|||||||
/// * Changing the display's scale factor (e.g. in Control Panel on Windows).
|
/// * Changing the display's scale factor (e.g. in Control Panel on Windows).
|
||||||
/// * Moving the window to a display with a different scale factor.
|
/// * Moving the window to a display with a different scale factor.
|
||||||
///
|
///
|
||||||
/// To update the window size, use the provided [`InnerSizeWriter`] handle. By default, the
|
/// After this event callback has been processed, the window will be resized to whatever value
|
||||||
/// window is resized to the value suggested by the OS, but it can be changed to any value.
|
/// is pointed to by the `new_inner_size` reference. By default, this will contain the size suggested
|
||||||
|
/// by the OS, but it can be changed to any value.
|
||||||
///
|
///
|
||||||
/// For more information about DPI in general, see the [`dpi`] crate.
|
/// For more information about DPI in general, see the [`dpi`](crate::dpi) module.
|
||||||
ScaleFactorChanged {
|
ScaleFactorChanged {
|
||||||
scale_factor: f64,
|
scale_factor: f64,
|
||||||
/// Handle to update inner size during scale changes.
|
/// Handle to update inner size during scale changes.
|
||||||
@@ -403,11 +572,10 @@ pub enum WindowEvent {
|
|||||||
///
|
///
|
||||||
/// ### iOS
|
/// ### iOS
|
||||||
///
|
///
|
||||||
/// On iOS, the `Occluded(false)` event is emitted in response to an
|
/// On iOS, the `Occluded(false)` event is emitted in response to an [`applicationWillEnterForeground`]
|
||||||
/// [`applicationWillEnterForeground`] callback which means the application should start
|
/// callback which means the application should start preparing its data. The `Occluded(true)` event is
|
||||||
/// preparing its data. The `Occluded(true)` event is emitted in response to an
|
/// emitted in response to an [`applicationDidEnterBackground`] callback which means the application
|
||||||
/// [`applicationDidEnterBackground`] callback which means the application should free
|
/// should free resources (according to the [iOS application lifecycle]).
|
||||||
/// resources (according to the [iOS application lifecycle]).
|
|
||||||
///
|
///
|
||||||
/// [`applicationWillEnterForeground`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623076-applicationwillenterforeground
|
/// [`applicationWillEnterForeground`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623076-applicationwillenterforeground
|
||||||
/// [`applicationDidEnterBackground`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622997-applicationdidenterbackground
|
/// [`applicationDidEnterBackground`]: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622997-applicationdidenterbackground
|
||||||
@@ -432,40 +600,17 @@ pub enum WindowEvent {
|
|||||||
///
|
///
|
||||||
/// Winit will aggregate duplicate redraw requests into a single event, to
|
/// Winit will aggregate duplicate redraw requests into a single event, to
|
||||||
/// help avoid duplicating rendering work.
|
/// help avoid duplicating rendering work.
|
||||||
|
///
|
||||||
|
/// [`Window::request_redraw`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.request_redraw
|
||||||
RedrawRequested,
|
RedrawRequested,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Identifier of an input device.
|
|
||||||
///
|
|
||||||
/// Whenever you receive an event arising from a particular input device, this event contains a
|
|
||||||
/// `DeviceId` which identifies its origin. Note that devices may be virtual (representing an
|
|
||||||
/// on-screen cursor and keyboard focus) or physical. Virtual devices typically aggregate inputs
|
|
||||||
/// from multiple physical devices.
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
||||||
pub struct DeviceId(pub(crate) platform_impl::DeviceId);
|
|
||||||
|
|
||||||
impl DeviceId {
|
|
||||||
/// Returns a dummy id, useful for unit testing.
|
|
||||||
///
|
|
||||||
/// # Safety
|
|
||||||
///
|
|
||||||
/// The only guarantee made about the return value of this function is that
|
|
||||||
/// it will always be equal to itself and to future values returned by this function.
|
|
||||||
/// No other guarantees are made. This may be equal to a real `DeviceId`.
|
|
||||||
///
|
|
||||||
/// **Passing this into a winit function will result in undefined behavior.**
|
|
||||||
pub const unsafe fn dummy() -> Self {
|
|
||||||
#[allow(unused_unsafe)]
|
|
||||||
DeviceId(unsafe { platform_impl::DeviceId::dummy() })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents raw hardware events that are not associated with any particular window.
|
/// Represents raw hardware events that are not associated with any particular window.
|
||||||
///
|
///
|
||||||
/// Useful for interactions that diverge significantly from a conventional 2D GUI, such as 3D camera
|
/// Useful for interactions that diverge significantly from a conventional 2D GUI, such as 3D camera or first-person
|
||||||
/// or first-person game controls. Many physical actions, such as mouse movement, can produce both
|
/// game controls. Many physical actions, such as mouse movement, can produce both device and window events. Because
|
||||||
/// device and window events. Because window events typically arise from virtual devices
|
/// window events typically arise from virtual devices (corresponding to GUI cursors and keyboard focus) the device IDs
|
||||||
/// (corresponding to GUI cursors and keyboard focus) the device IDs may not match.
|
/// may not match.
|
||||||
///
|
///
|
||||||
/// Note that these events are delivered regardless of input focus.
|
/// Note that these events are delivered regardless of input focus.
|
||||||
#[derive(Clone, Debug, PartialEq)]
|
#[derive(Clone, Debug, PartialEq)]
|
||||||
@@ -475,8 +620,7 @@ pub enum DeviceEvent {
|
|||||||
|
|
||||||
/// Change in physical position of a pointing device.
|
/// Change in physical position of a pointing device.
|
||||||
///
|
///
|
||||||
/// This represents raw, unfiltered physical motion. Not to be confused with
|
/// This represents raw, unfiltered physical motion. Not to be confused with [`WindowEvent::CursorMoved`].
|
||||||
/// [`WindowEvent::CursorMoved`].
|
|
||||||
MouseMotion {
|
MouseMotion {
|
||||||
/// (x, y) change in position in unspecified units.
|
/// (x, y) change in position in unspecified units.
|
||||||
///
|
///
|
||||||
@@ -521,7 +665,7 @@ pub struct RawKeyEvent {
|
|||||||
|
|
||||||
/// Describes a keyboard input targeting a window.
|
/// Describes a keyboard input targeting a window.
|
||||||
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
|
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
|
||||||
pub struct KeyEvent {
|
pub struct KeyEvent<Extra> {
|
||||||
/// Represents the position of a key independent of the currently active layout.
|
/// Represents the position of a key independent of the currently active layout.
|
||||||
///
|
///
|
||||||
/// It also uniquely identifies the physical key (i.e. it's mostly synonymous with a scancode).
|
/// It also uniquely identifies the physical key (i.e. it's mostly synonymous with a scancode).
|
||||||
@@ -571,7 +715,7 @@ pub struct KeyEvent {
|
|||||||
/// - **Web:** Dead keys might be reported as the real key instead
|
/// - **Web:** Dead keys might be reported as the real key instead
|
||||||
/// of `Dead` depending on the browser/OS.
|
/// of `Dead` depending on the browser/OS.
|
||||||
///
|
///
|
||||||
/// [`key_without_modifiers`]: crate::platform::modifier_supplement::KeyEventExtModifierSupplement::key_without_modifiers
|
/// [`key_without_modifiers`]: https://docs.rs/winit/latest/winit/platform/modifier_supplement/trait.KeyEventExtModifierSupplement.html#tymethod.key_without_modifiers
|
||||||
pub logical_key: keyboard::Key,
|
pub logical_key: keyboard::Key,
|
||||||
|
|
||||||
/// Contains the text produced by this keypress.
|
/// Contains the text produced by this keypress.
|
||||||
@@ -597,13 +741,13 @@ pub struct KeyEvent {
|
|||||||
|
|
||||||
/// Contains the location of this key on the keyboard.
|
/// Contains the location of this key on the keyboard.
|
||||||
///
|
///
|
||||||
/// Certain keys on the keyboard may appear in more than once place. For example, the "Shift"
|
/// Certain keys on the keyboard may appear in more than once place. For example, the "Shift" key
|
||||||
/// key appears on the left side of the QWERTY keyboard as well as the right side. However,
|
/// appears on the left side of the QWERTY keyboard as well as the right side. However, both keys
|
||||||
/// both keys have the same symbolic value. Another example of this phenomenon is the "1"
|
/// have the same symbolic value. Another example of this phenomenon is the "1" key, which appears
|
||||||
/// key, which appears both above the "Q" key and as the "Keypad 1" key.
|
/// both above the "Q" key and as the "Keypad 1" key.
|
||||||
///
|
///
|
||||||
/// This field allows the user to differentiate between keys like this that have the same
|
/// This field allows the user to differentiate between keys like this that have the same symbolic
|
||||||
/// symbolic value but different locations on the keyboard.
|
/// value but different locations on the keyboard.
|
||||||
///
|
///
|
||||||
/// See the [`KeyLocation`] type for more details.
|
/// See the [`KeyLocation`] type for more details.
|
||||||
///
|
///
|
||||||
@@ -618,43 +762,17 @@ pub struct KeyEvent {
|
|||||||
/// Whether or not this key is a key repeat event.
|
/// Whether or not this key is a key repeat event.
|
||||||
///
|
///
|
||||||
/// On some systems, holding down a key for some period of time causes that key to be repeated
|
/// On some systems, holding down a key for some period of time causes that key to be repeated
|
||||||
/// as though it were being pressed and released repeatedly. This field is `true` if and only
|
/// as though it were being pressed and released repeatedly. This field is `true` if and only if
|
||||||
/// if this event is the result of one of those repeats.
|
/// this event is the result of one of those repeats.
|
||||||
///
|
|
||||||
/// # Example
|
|
||||||
///
|
|
||||||
/// In games, you often want to ignore repated key events - this can be
|
|
||||||
/// done by ignoring events where this property is set.
|
|
||||||
///
|
|
||||||
/// ```
|
|
||||||
/// use winit::event::{ElementState, KeyEvent, WindowEvent};
|
|
||||||
/// use winit::keyboard::{KeyCode, PhysicalKey};
|
|
||||||
/// # let window_event = WindowEvent::RedrawRequested; // To make the example compile
|
|
||||||
/// match window_event {
|
|
||||||
/// WindowEvent::KeyboardInput {
|
|
||||||
/// event:
|
|
||||||
/// KeyEvent {
|
|
||||||
/// physical_key: PhysicalKey::Code(KeyCode::KeyW),
|
|
||||||
/// state: ElementState::Pressed,
|
|
||||||
/// repeat: false,
|
|
||||||
/// ..
|
|
||||||
/// },
|
|
||||||
/// ..
|
|
||||||
/// } => {
|
|
||||||
/// // The physical key `W` was pressed, and it was not a repeat
|
|
||||||
/// },
|
|
||||||
/// _ => {}, // Handle other events
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
pub repeat: bool,
|
pub repeat: bool,
|
||||||
|
|
||||||
/// Platform-specific key event information.
|
/// Platform-specific key event information.
|
||||||
///
|
///
|
||||||
/// On Windows, Linux and macOS, this type contains the key without modifiers and the text with
|
/// On Windows, Linux and macOS, this type contains the key without modifiers and the text with all
|
||||||
/// all modifiers applied.
|
/// modifiers applied.
|
||||||
///
|
///
|
||||||
/// On Android, iOS, Redox and Web, this type is a no-op.
|
/// On Android, iOS, Redox and Web, this type is a no-op.
|
||||||
pub(crate) platform_specific: platform_impl::KeyEventExtra,
|
pub extra: Extra,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Describes keyboard modifiers event.
|
/// Describes keyboard modifiers event.
|
||||||
@@ -669,6 +787,15 @@ pub struct Modifiers {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Modifiers {
|
impl Modifiers {
|
||||||
|
/// Only `winit` should instantiate this!
|
||||||
|
#[doc(hidden)]
|
||||||
|
pub fn new(state: ModifiersState, pressed_mods: ModifiersKeys) -> Self {
|
||||||
|
Self {
|
||||||
|
state,
|
||||||
|
pressed_mods,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// The state of the modifiers.
|
/// The state of the modifiers.
|
||||||
pub fn state(&self) -> ModifiersState {
|
pub fn state(&self) -> ModifiersState {
|
||||||
self.state
|
self.state
|
||||||
@@ -725,7 +852,10 @@ impl Modifiers {
|
|||||||
|
|
||||||
impl From<ModifiersState> for Modifiers {
|
impl From<ModifiersState> for Modifiers {
|
||||||
fn from(value: ModifiersState) -> Self {
|
fn from(value: ModifiersState) -> Self {
|
||||||
Self { state: value, pressed_mods: Default::default() }
|
Self {
|
||||||
|
state: value,
|
||||||
|
pressed_mods: Default::default(),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -733,16 +863,12 @@ impl From<ModifiersState> for Modifiers {
|
|||||||
///
|
///
|
||||||
/// This is also called a "composition event".
|
/// This is also called a "composition event".
|
||||||
///
|
///
|
||||||
/// Most keypresses using a latin-like keyboard layout simply generate a
|
/// Most keypresses using a latin-like keyboard layout simply generate a [`WindowEvent::KeyboardInput`].
|
||||||
/// [`WindowEvent::KeyboardInput`]. However, one couldn't possibly have a key for every single
|
/// However, one couldn't possibly have a key for every single unicode character that the user might want to type
|
||||||
/// unicode character that the user might want to type
|
/// - so the solution operating systems employ is to allow the user to type these using _a sequence of keypresses_ instead.
|
||||||
/// - so the solution operating systems employ is to allow the user to type these using _a sequence
|
|
||||||
/// of keypresses_ instead.
|
|
||||||
///
|
|
||||||
/// A prominent example of this is accents - many keyboard layouts allow you to first click the
|
|
||||||
/// "accent key", and then the character you want to apply the accent to. In this case, some
|
|
||||||
/// platforms will generate the following event sequence:
|
|
||||||
///
|
///
|
||||||
|
/// A prominent example of this is accents - many keyboard layouts allow you to first click the "accent key", and then
|
||||||
|
/// the character you want to apply the accent to. In this case, some platforms will generate the following event sequence:
|
||||||
/// ```ignore
|
/// ```ignore
|
||||||
/// // Press "`" key
|
/// // Press "`" key
|
||||||
/// Ime::Preedit("`", Some((0, 0)))
|
/// Ime::Preedit("`", Some((0, 0)))
|
||||||
@@ -751,13 +877,11 @@ impl From<ModifiersState> for Modifiers {
|
|||||||
/// Ime::Commit("é")
|
/// Ime::Commit("é")
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// Additionally, certain input devices are configured to display a candidate box that allow the
|
/// Additionally, certain input devices are configured to display a candidate box that allow the user to select the
|
||||||
/// user to select the desired character interactively. (To properly position this box, you must use
|
/// desired character interactively. (To properly position this box, you must use [`Window::set_ime_cursor_area`].)
|
||||||
/// [`Window::set_ime_cursor_area`].)
|
|
||||||
///
|
|
||||||
/// An example of a keyboard layout which uses candidate boxes is pinyin. On a latin keyboard the
|
|
||||||
/// following event sequence could be obtained:
|
|
||||||
///
|
///
|
||||||
|
/// An example of a keyboard layout which uses candidate boxes is pinyin. On a latin keyboard the following event
|
||||||
|
/// sequence could be obtained:
|
||||||
/// ```ignore
|
/// ```ignore
|
||||||
/// // Press "A" key
|
/// // Press "A" key
|
||||||
/// Ime::Preedit("a", Some((1, 1)))
|
/// Ime::Preedit("a", Some((1, 1)))
|
||||||
@@ -771,14 +895,18 @@ impl From<ModifiersState> for Modifiers {
|
|||||||
/// Ime::Preedit("", None) // Synthetic event generated by winit to clear preedit.
|
/// Ime::Preedit("", None) // Synthetic event generated by winit to clear preedit.
|
||||||
/// Ime::Commit("啊不")
|
/// Ime::Commit("啊不")
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// [`Window::set_ime_cursor_area`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.set_ime_cursor_area
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub enum Ime {
|
pub enum Ime {
|
||||||
/// Notifies when the IME was enabled.
|
/// Notifies when the IME was enabled.
|
||||||
///
|
///
|
||||||
/// After getting this event you could receive [`Preedit`][Self::Preedit] and
|
/// After getting this event you could receive [`Preedit`](Self::Preedit) and
|
||||||
/// [`Commit`][Self::Commit] events. You should also start performing IME related requests
|
/// [`Commit`](Self::Commit) events. You should also start performing IME related requests
|
||||||
/// like [`Window::set_ime_cursor_area`].
|
/// like [`Window::set_ime_cursor_area`].
|
||||||
|
///
|
||||||
|
/// [`Window::set_ime_cursor_area`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.set_ime_cursor_area
|
||||||
Enabled,
|
Enabled,
|
||||||
|
|
||||||
/// Notifies when a new composing text should be set at the cursor position.
|
/// Notifies when a new composing text should be set at the cursor position.
|
||||||
@@ -797,10 +925,12 @@ pub enum Ime {
|
|||||||
|
|
||||||
/// Notifies when the IME was disabled.
|
/// Notifies when the IME was disabled.
|
||||||
///
|
///
|
||||||
/// After receiving this event you won't get any more [`Preedit`][Self::Preedit] or
|
/// After receiving this event you won't get any more [`Preedit`](Self::Preedit) or
|
||||||
/// [`Commit`][Self::Commit] events until the next [`Enabled`][Self::Enabled] event. You should
|
/// [`Commit`](Self::Commit) events until the next [`Enabled`](Self::Enabled) event. You should
|
||||||
/// also stop issuing IME related requests like [`Window::set_ime_cursor_area`] and clear
|
/// also stop issuing IME related requests like [`Window::set_ime_cursor_area`] and clear pending
|
||||||
/// pending preedit text.
|
/// preedit text.
|
||||||
|
///
|
||||||
|
/// [`Window::set_ime_cursor_area`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.set_ime_cursor_area
|
||||||
Disabled,
|
Disabled,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -899,13 +1029,17 @@ impl Force {
|
|||||||
/// consistent across devices.
|
/// consistent across devices.
|
||||||
pub fn normalized(&self) -> f64 {
|
pub fn normalized(&self) -> f64 {
|
||||||
match self {
|
match self {
|
||||||
Force::Calibrated { force, max_possible_force, altitude_angle } => {
|
Force::Calibrated {
|
||||||
|
force,
|
||||||
|
max_possible_force,
|
||||||
|
altitude_angle,
|
||||||
|
} => {
|
||||||
let force = match altitude_angle {
|
let force = match altitude_angle {
|
||||||
Some(altitude_angle) => force / altitude_angle.sin(),
|
Some(altitude_angle) => force / altitude_angle.sin(),
|
||||||
None => *force,
|
None => *force,
|
||||||
};
|
};
|
||||||
force / max_possible_force
|
force / max_possible_force
|
||||||
},
|
}
|
||||||
Force::Normalized(force) => *force,
|
Force::Normalized(force) => *force,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -976,7 +1110,7 @@ pub enum MouseScrollDelta {
|
|||||||
PixelDelta(PhysicalPosition<f64>),
|
PixelDelta(PhysicalPosition<f64>),
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Handle to synchronously change the size of the window from the
|
/// Handle to synchroniously change the size of the window from the
|
||||||
/// [`WindowEvent`].
|
/// [`WindowEvent`].
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct InnerSizeWriter {
|
pub struct InnerSizeWriter {
|
||||||
@@ -985,22 +1119,27 @@ pub struct InnerSizeWriter {
|
|||||||
|
|
||||||
impl InnerSizeWriter {
|
impl InnerSizeWriter {
|
||||||
#[cfg(not(orbital_platform))]
|
#[cfg(not(orbital_platform))]
|
||||||
pub(crate) fn new(new_inner_size: Weak<Mutex<PhysicalSize<u32>>>) -> Self {
|
pub fn new(new_inner_size: Weak<Mutex<PhysicalSize<u32>>>) -> Self {
|
||||||
Self { new_inner_size }
|
Self { new_inner_size }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Try to request inner size which will be set synchronously on the window.
|
/// Try to request inner size which will be set synchroniously on the window.
|
||||||
pub fn request_inner_size(
|
pub fn request_inner_size(
|
||||||
&mut self,
|
&mut self,
|
||||||
new_inner_size: PhysicalSize<u32>,
|
new_inner_size: PhysicalSize<u32>,
|
||||||
) -> Result<(), ExternalError> {
|
) -> Result<(), InnerSizeIgnored> {
|
||||||
if let Some(inner) = self.new_inner_size.upgrade() {
|
if let Some(inner) = self.new_inner_size.upgrade() {
|
||||||
*inner.lock().unwrap() = new_inner_size;
|
*inner.lock().unwrap() = new_inner_size;
|
||||||
Ok(())
|
Ok(())
|
||||||
} else {
|
} else {
|
||||||
Err(ExternalError::Ignored)
|
Err(InnerSizeIgnored { _private: () })
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Get the underlying size.
|
||||||
|
pub fn get(&self) -> PhysicalSize<u32> {
|
||||||
|
*self.new_inner_size.upgrade().unwrap().lock().unwrap()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for InnerSizeWriter {
|
impl PartialEq for InnerSizeWriter {
|
||||||
@@ -1009,9 +1148,27 @@ impl PartialEq for InnerSizeWriter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Could not write the inner size.
|
||||||
|
pub struct InnerSizeIgnored {
|
||||||
|
_private: (),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Debug for InnerSizeIgnored {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
f.debug_struct("InnerSizeIgnored").finish_non_exhaustive()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Display for InnerSizeIgnored {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
f.write_str("tried to write inner size after")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::error::Error for InnerSizeIgnored {}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use crate::dpi::PhysicalPosition;
|
|
||||||
use crate::event;
|
use crate::event;
|
||||||
use std::collections::{BTreeSet, HashSet};
|
use std::collections::{BTreeSet, HashSet};
|
||||||
|
|
||||||
@@ -1023,9 +1180,7 @@ mod tests {
|
|||||||
|
|
||||||
#[allow(deprecated)]
|
#[allow(deprecated)]
|
||||||
{
|
{
|
||||||
use crate::event::Event::*;
|
use crate::event::{Event::*, Ime::Enabled, WindowEvent::*};
|
||||||
use crate::event::Ime::Enabled;
|
|
||||||
use crate::event::WindowEvent::*;
|
|
||||||
use crate::window::WindowId;
|
use crate::window::WindowId;
|
||||||
|
|
||||||
// Mainline events.
|
// Mainline events.
|
||||||
@@ -1038,7 +1193,12 @@ mod tests {
|
|||||||
x(Resumed);
|
x(Resumed);
|
||||||
|
|
||||||
// Window events.
|
// Window events.
|
||||||
let with_window_event = |wev| x(WindowEvent { window_id: wid, event: wev });
|
let with_window_event = |wev| {
|
||||||
|
x(WindowEvent {
|
||||||
|
window_id: wid,
|
||||||
|
event: wev,
|
||||||
|
})
|
||||||
|
};
|
||||||
|
|
||||||
with_window_event(CloseRequested);
|
with_window_event(CloseRequested);
|
||||||
with_window_event(Destroyed);
|
with_window_event(Destroyed);
|
||||||
@@ -1049,7 +1209,10 @@ mod tests {
|
|||||||
with_window_event(HoveredFile("x.txt".into()));
|
with_window_event(HoveredFile("x.txt".into()));
|
||||||
with_window_event(HoveredFileCancelled);
|
with_window_event(HoveredFileCancelled);
|
||||||
with_window_event(Ime(Enabled));
|
with_window_event(Ime(Enabled));
|
||||||
with_window_event(CursorMoved { device_id: did, position: (0, 0).into() });
|
with_window_event(CursorMoved {
|
||||||
|
device_id: did,
|
||||||
|
position: (0, 0).into(),
|
||||||
|
});
|
||||||
with_window_event(ModifiersChanged(event::Modifiers::default()));
|
with_window_event(ModifiersChanged(event::Modifiers::default()));
|
||||||
with_window_event(CursorEntered { device_id: did });
|
with_window_event(CursorEntered { device_id: did });
|
||||||
with_window_event(CursorLeft { device_id: did });
|
with_window_event(CursorLeft { device_id: did });
|
||||||
@@ -1074,13 +1237,16 @@ mod tests {
|
|||||||
delta: 0.0,
|
delta: 0.0,
|
||||||
phase: event::TouchPhase::Started,
|
phase: event::TouchPhase::Started,
|
||||||
});
|
});
|
||||||
with_window_event(PanGesture {
|
with_window_event(TouchpadPressure {
|
||||||
device_id: did,
|
device_id: did,
|
||||||
delta: PhysicalPosition::<f32>::new(0.0, 0.0),
|
pressure: 0.0,
|
||||||
phase: event::TouchPhase::Started,
|
stage: 0,
|
||||||
|
});
|
||||||
|
with_window_event(AxisMotion {
|
||||||
|
device_id: did,
|
||||||
|
axis: 0,
|
||||||
|
value: 0.0,
|
||||||
});
|
});
|
||||||
with_window_event(TouchpadPressure { device_id: did, pressure: 0.0, stage: 0 });
|
|
||||||
with_window_event(AxisMotion { device_id: did, axis: 0, value: 0.0 });
|
|
||||||
with_window_event(Touch(event::Touch {
|
with_window_event(Touch(event::Touch {
|
||||||
device_id: did,
|
device_id: did,
|
||||||
phase: event::TouchPhase::Started,
|
phase: event::TouchPhase::Started,
|
||||||
@@ -1096,17 +1262,29 @@ mod tests {
|
|||||||
{
|
{
|
||||||
use event::DeviceEvent::*;
|
use event::DeviceEvent::*;
|
||||||
|
|
||||||
let with_device_event =
|
let with_device_event = |dev_ev| {
|
||||||
|dev_ev| x(event::Event::DeviceEvent { device_id: did, event: dev_ev });
|
x(event::Event::DeviceEvent {
|
||||||
|
device_id: did,
|
||||||
|
event: dev_ev,
|
||||||
|
})
|
||||||
|
};
|
||||||
|
|
||||||
with_device_event(Added);
|
with_device_event(Added);
|
||||||
with_device_event(Removed);
|
with_device_event(Removed);
|
||||||
with_device_event(MouseMotion { delta: (0.0, 0.0).into() });
|
with_device_event(MouseMotion {
|
||||||
|
delta: (0.0, 0.0).into(),
|
||||||
|
});
|
||||||
with_device_event(MouseWheel {
|
with_device_event(MouseWheel {
|
||||||
delta: event::MouseScrollDelta::LineDelta(0.0, 0.0),
|
delta: event::MouseScrollDelta::LineDelta(0.0, 0.0),
|
||||||
});
|
});
|
||||||
with_device_event(Motion { axis: 0, value: 0.0 });
|
with_device_event(Motion {
|
||||||
with_device_event(Button { button: 0, state: event::ElementState::Pressed });
|
axis: 0,
|
||||||
|
value: 0.0,
|
||||||
|
});
|
||||||
|
with_device_event(Button {
|
||||||
|
button: 0,
|
||||||
|
state: event::ElementState::Pressed,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}};
|
}};
|
||||||
}
|
}
|
||||||
@@ -1114,7 +1292,7 @@ mod tests {
|
|||||||
#[allow(clippy::redundant_clone)]
|
#[allow(clippy::redundant_clone)]
|
||||||
#[test]
|
#[test]
|
||||||
fn test_event_clone() {
|
fn test_event_clone() {
|
||||||
foreach_event!(|event: event::Event<()>| {
|
foreach_event!(|event: event::Event<(), ()>| {
|
||||||
let event2 = event.clone();
|
let event2 = event.clone();
|
||||||
assert_eq!(event, event2);
|
assert_eq!(event, event2);
|
||||||
})
|
})
|
||||||
@@ -1122,7 +1300,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_map_nonuser_event() {
|
fn test_map_nonuser_event() {
|
||||||
foreach_event!(|event: event::Event<()>| {
|
foreach_event!(|event: event::Event<(), ()>| {
|
||||||
let is_user = matches!(event, event::Event::UserEvent(()));
|
let is_user = matches!(event, event::Event::UserEvent(()));
|
||||||
let event2 = event.map_nonuser_event::<()>();
|
let event2 = event.map_nonuser_event::<()>();
|
||||||
if is_user {
|
if is_user {
|
||||||
@@ -1138,8 +1316,11 @@ mod tests {
|
|||||||
let force = event::Force::Normalized(0.0);
|
let force = event::Force::Normalized(0.0);
|
||||||
assert_eq!(force.normalized(), 0.0);
|
assert_eq!(force.normalized(), 0.0);
|
||||||
|
|
||||||
let force2 =
|
let force2 = event::Force::Calibrated {
|
||||||
event::Force::Calibrated { force: 5.0, max_possible_force: 2.5, altitude_angle: None };
|
force: 5.0,
|
||||||
|
max_possible_force: 2.5,
|
||||||
|
altitude_angle: None,
|
||||||
|
};
|
||||||
assert_eq!(force2.normalized(), 2.0);
|
assert_eq!(force2.normalized(), 2.0);
|
||||||
|
|
||||||
let force3 = event::Force::Calibrated {
|
let force3 = event::Force::Calibrated {
|
||||||
@@ -1153,7 +1334,7 @@ mod tests {
|
|||||||
#[allow(clippy::clone_on_copy)]
|
#[allow(clippy::clone_on_copy)]
|
||||||
#[test]
|
#[test]
|
||||||
fn ensure_attrs_do_not_panic() {
|
fn ensure_attrs_do_not_panic() {
|
||||||
foreach_event!(|event: event::Event<()>| {
|
foreach_event!(|event: event::Event<(), ()>| {
|
||||||
let _ = format!("{:?}", event);
|
let _ = format!("{:?}", event);
|
||||||
});
|
});
|
||||||
let _ = event::StartCause::Init.clone();
|
let _ = event::StartCause::Init.clone();
|
||||||
@@ -1178,8 +1359,11 @@ mod tests {
|
|||||||
force: Some(event::Force::Normalized(0.0)),
|
force: Some(event::Force::Normalized(0.0)),
|
||||||
}
|
}
|
||||||
.clone();
|
.clone();
|
||||||
let _ =
|
let _ = event::Force::Calibrated {
|
||||||
event::Force::Calibrated { force: 0.0, max_possible_force: 0.0, altitude_angle: None }
|
force: 0.0,
|
||||||
.clone();
|
max_possible_force: 0.0,
|
||||||
|
altitude_angle: None,
|
||||||
|
}
|
||||||
|
.clone();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
80
winit-core/src/event_loop.rs
Normal file
80
winit-core/src/event_loop.rs
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
//! Types needed to define the event loop.
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicU64, Ordering};
|
||||||
|
|
||||||
|
#[cfg(not(web_platform))]
|
||||||
|
use std::time::{Duration, Instant};
|
||||||
|
#[cfg(web_platform)]
|
||||||
|
use web_time::{Duration, Instant};
|
||||||
|
|
||||||
|
/// A unique identifier of the winit's async request.
|
||||||
|
///
|
||||||
|
/// This could be used to identify the async request once it's done
|
||||||
|
/// and a specific action must be taken.
|
||||||
|
///
|
||||||
|
/// One of the handling scenarious could be to maintain a working list
|
||||||
|
/// containing [`AsyncRequestSerial`] and some closure associated with it.
|
||||||
|
/// Then once event is arriving the working list is being traversed and a job
|
||||||
|
/// executed and removed from the list.
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub struct AsyncRequestSerial {
|
||||||
|
serial: u64,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AsyncRequestSerial {
|
||||||
|
/// Get the next serial in the sequence.
|
||||||
|
pub fn get() -> Self {
|
||||||
|
static CURRENT_SERIAL: AtomicU64 = AtomicU64::new(0);
|
||||||
|
// NOTE: we rely on wrap around here, while the user may just request
|
||||||
|
// in the loop u64::MAX times that's issue is considered on them.
|
||||||
|
let serial = CURRENT_SERIAL.fetch_add(1, Ordering::Relaxed);
|
||||||
|
Self { serial }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Set through [`EventLoopWindowTarget::set_control_flow()`].
|
||||||
|
///
|
||||||
|
/// Indicates the desired behavior of the event loop after [`Event::AboutToWait`] is emitted.
|
||||||
|
///
|
||||||
|
/// Defaults to [`Wait`].
|
||||||
|
///
|
||||||
|
/// [`Wait`]: Self::Wait
|
||||||
|
///
|
||||||
|
/// [`EventLoopWindowTarget::set_control_flow()`]: https://docs.rs/winit/latest/winit/event_loop/struct.EventLoopWindowTarget.html#method.set_control_flow
|
||||||
|
/// [`Event::AboutToWait`]: crate::event::Event::AboutToWait
|
||||||
|
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
|
||||||
|
pub enum ControlFlow {
|
||||||
|
/// When the current loop iteration finishes, immediately begin a new iteration regardless of
|
||||||
|
/// whether or not new events are available to process.
|
||||||
|
Poll,
|
||||||
|
|
||||||
|
/// When the current loop iteration finishes, suspend the thread until another event arrives.
|
||||||
|
#[default]
|
||||||
|
Wait,
|
||||||
|
|
||||||
|
/// When the current loop iteration finishes, suspend the thread until either another event
|
||||||
|
/// arrives or the given time is reached.
|
||||||
|
///
|
||||||
|
/// Useful for implementing efficient timers. Applications which want to render at the display's
|
||||||
|
/// native refresh rate should instead use [`Poll`] and the VSync functionality of a graphics API
|
||||||
|
/// to reduce odds of missed frames.
|
||||||
|
///
|
||||||
|
/// [`Poll`]: Self::Poll
|
||||||
|
WaitUntil(Instant),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ControlFlow {
|
||||||
|
/// Creates a [`ControlFlow`] that waits until a timeout has expired.
|
||||||
|
///
|
||||||
|
/// In most cases, this is set to [`WaitUntil`]. However, if the timeout overflows, it is
|
||||||
|
/// instead set to [`Wait`].
|
||||||
|
///
|
||||||
|
/// [`WaitUntil`]: Self::WaitUntil
|
||||||
|
/// [`Wait`]: Self::Wait
|
||||||
|
pub fn wait_duration(timeout: Duration) -> Self {
|
||||||
|
match Instant::now().checked_add(timeout) {
|
||||||
|
Some(instant) => Self::WaitUntil(instant),
|
||||||
|
None => Self::Wait,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -20,7 +20,7 @@
|
|||||||
// the W3C short notice apply to the `Key` and `KeyCode` enums and their variants and the
|
// the W3C short notice apply to the `Key` and `KeyCode` enums and their variants and the
|
||||||
// documentation attached to their variants.
|
// documentation attached to their variants.
|
||||||
|
|
||||||
// --------- BEGINNING OF W3C LICENSE --------------------------------------------------------------
|
// --------- BEGGINING OF W3C LICENSE --------------------------------------------------------------
|
||||||
//
|
//
|
||||||
// License
|
// License
|
||||||
//
|
//
|
||||||
@@ -55,7 +55,7 @@
|
|||||||
//
|
//
|
||||||
// --------- END OF W3C LICENSE --------------------------------------------------------------------
|
// --------- END OF W3C LICENSE --------------------------------------------------------------------
|
||||||
|
|
||||||
// --------- BEGINNING OF W3C SHORT NOTICE ---------------------------------------------------------
|
// --------- BEGGINING OF W3C SHORT NOTICE ---------------------------------------------------------
|
||||||
//
|
//
|
||||||
// winit: https://github.com/rust-windowing/winit
|
// winit: https://github.com/rust-windowing/winit
|
||||||
//
|
//
|
||||||
@@ -106,23 +106,23 @@ impl std::fmt::Debug for NativeKeyCode {
|
|||||||
match self {
|
match self {
|
||||||
Unidentified => {
|
Unidentified => {
|
||||||
debug_tuple = f.debug_tuple("Unidentified");
|
debug_tuple = f.debug_tuple("Unidentified");
|
||||||
},
|
}
|
||||||
Android(code) => {
|
Android(code) => {
|
||||||
debug_tuple = f.debug_tuple("Android");
|
debug_tuple = f.debug_tuple("Android");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
MacOS(code) => {
|
MacOS(code) => {
|
||||||
debug_tuple = f.debug_tuple("MacOS");
|
debug_tuple = f.debug_tuple("MacOS");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
Windows(code) => {
|
Windows(code) => {
|
||||||
debug_tuple = f.debug_tuple("Windows");
|
debug_tuple = f.debug_tuple("Windows");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
Xkb(code) => {
|
Xkb(code) => {
|
||||||
debug_tuple = f.debug_tuple("Xkb");
|
debug_tuple = f.debug_tuple("Xkb");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
}
|
}
|
||||||
debug_tuple.finish()
|
debug_tuple.finish()
|
||||||
}
|
}
|
||||||
@@ -162,27 +162,27 @@ impl std::fmt::Debug for NativeKey {
|
|||||||
match self {
|
match self {
|
||||||
Unidentified => {
|
Unidentified => {
|
||||||
debug_tuple = f.debug_tuple("Unidentified");
|
debug_tuple = f.debug_tuple("Unidentified");
|
||||||
},
|
}
|
||||||
Android(code) => {
|
Android(code) => {
|
||||||
debug_tuple = f.debug_tuple("Android");
|
debug_tuple = f.debug_tuple("Android");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
MacOS(code) => {
|
MacOS(code) => {
|
||||||
debug_tuple = f.debug_tuple("MacOS");
|
debug_tuple = f.debug_tuple("MacOS");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
Windows(code) => {
|
Windows(code) => {
|
||||||
debug_tuple = f.debug_tuple("Windows");
|
debug_tuple = f.debug_tuple("Windows");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
Xkb(code) => {
|
Xkb(code) => {
|
||||||
debug_tuple = f.debug_tuple("Xkb");
|
debug_tuple = f.debug_tuple("Xkb");
|
||||||
debug_tuple.field(&format_args!("0x{code:04X}"));
|
debug_tuple.field(&format_args!("0x{code:04X}"));
|
||||||
},
|
}
|
||||||
Web(code) => {
|
Web(code) => {
|
||||||
debug_tuple = f.debug_tuple("Web");
|
debug_tuple = f.debug_tuple("Web");
|
||||||
debug_tuple.field(code);
|
debug_tuple.field(code);
|
||||||
},
|
}
|
||||||
}
|
}
|
||||||
debug_tuple.finish()
|
debug_tuple.finish()
|
||||||
}
|
}
|
||||||
@@ -218,7 +218,7 @@ impl PartialEq<NativeKeyCode> for NativeKey {
|
|||||||
|
|
||||||
/// Represents the location of a physical key.
|
/// Represents the location of a physical key.
|
||||||
///
|
///
|
||||||
/// This type is a superset of [`KeyCode`], including an [`Unidentified`][Self::Unidentified]
|
/// This type is a superset of [`KeyCode`], including an [`Unidentified`](Self::Unidentified)
|
||||||
/// variant.
|
/// variant.
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
@@ -442,8 +442,7 @@ pub enum KeyCode {
|
|||||||
Tab,
|
Tab,
|
||||||
/// Japanese: <kbd>変</kbd> (henkan)
|
/// Japanese: <kbd>変</kbd> (henkan)
|
||||||
Convert,
|
Convert,
|
||||||
/// Japanese: <kbd>カタカナ</kbd>/<kbd>ひらがな</kbd>/<kbd>ローマ字</kbd>
|
/// Japanese: <kbd>カタカナ</kbd>/<kbd>ひらがな</kbd>/<kbd>ローマ字</kbd> (katakana/hiragana/romaji)
|
||||||
/// (katakana/hiragana/romaji)
|
|
||||||
KanaMode,
|
KanaMode,
|
||||||
/// Korean: HangulMode <kbd>한/영</kbd> (han/yeong)
|
/// Korean: HangulMode <kbd>한/영</kbd> (han/yeong)
|
||||||
///
|
///
|
||||||
@@ -491,8 +490,7 @@ pub enum KeyCode {
|
|||||||
NumLock,
|
NumLock,
|
||||||
/// <kbd>0 Ins</kbd> on a keyboard. <kbd>0</kbd> on a phone or remote control
|
/// <kbd>0 Ins</kbd> on a keyboard. <kbd>0</kbd> on a phone or remote control
|
||||||
Numpad0,
|
Numpad0,
|
||||||
/// <kbd>1 End</kbd> on a keyboard. <kbd>1</kbd> or <kbd>1 QZ</kbd> on a phone or remote
|
/// <kbd>1 End</kbd> on a keyboard. <kbd>1</kbd> or <kbd>1 QZ</kbd> on a phone or remote control
|
||||||
/// control
|
|
||||||
Numpad1,
|
Numpad1,
|
||||||
/// <kbd>2 ↓</kbd> on a keyboard. <kbd>2 ABC</kbd> on a phone or remote control
|
/// <kbd>2 ↓</kbd> on a keyboard. <kbd>2 ABC</kbd> on a phone or remote control
|
||||||
Numpad2,
|
Numpad2,
|
||||||
@@ -746,7 +744,7 @@ pub enum KeyCode {
|
|||||||
/// - The `Super` variant here, is named `Meta` in the aforementioned specification. (There's
|
/// - The `Super` variant here, is named `Meta` in the aforementioned specification. (There's
|
||||||
/// another key which the specification calls `Super`. That does not exist here.)
|
/// another key which the specification calls `Super`. That does not exist here.)
|
||||||
/// - The `Space` variant here, can be identified by the character it generates in the
|
/// - The `Space` variant here, can be identified by the character it generates in the
|
||||||
/// specification.
|
/// specificaiton.
|
||||||
///
|
///
|
||||||
/// [`KeyboardEvent.key`]: https://w3c.github.io/uievents-key/
|
/// [`KeyboardEvent.key`]: https://w3c.github.io/uievents-key/
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
@@ -796,14 +794,13 @@ pub enum NamedKey {
|
|||||||
// Legacy modifier key.
|
// Legacy modifier key.
|
||||||
Hyper,
|
Hyper,
|
||||||
/// Used to enable "super" modifier function for interpreting concurrent or subsequent keyboard
|
/// Used to enable "super" modifier function for interpreting concurrent or subsequent keyboard
|
||||||
/// input. This key value is used for the "Windows Logo" key and the Apple `Command` or `⌘`
|
/// input. This key value is used for the "Windows Logo" key and the Apple `Command` or `⌘` key.
|
||||||
/// key.
|
|
||||||
///
|
///
|
||||||
/// Note: In some contexts (e.g. the Web) this is referred to as the "Meta" key.
|
/// Note: In some contexts (e.g. the Web) this is referred to as the "Meta" key.
|
||||||
Super,
|
Super,
|
||||||
/// The `Enter` or `↵` key. Used to activate current selection or accept current input. This
|
/// The `Enter` or `↵` key. Used to activate current selection or accept current input. This key
|
||||||
/// key value is also used for the `Return` (Macintosh numpad) key. This key value is also
|
/// value is also used for the `Return` (Macintosh numpad) key. This key value is also used for
|
||||||
/// used for the Android `KEYCODE_DPAD_CENTER`.
|
/// the Android `KEYCODE_DPAD_CENTER`.
|
||||||
Enter,
|
Enter,
|
||||||
/// The Horizontal Tabulation `Tab` key.
|
/// The Horizontal Tabulation `Tab` key.
|
||||||
Tab,
|
Tab,
|
||||||
@@ -839,8 +836,8 @@ pub enum NamedKey {
|
|||||||
CrSel,
|
CrSel,
|
||||||
/// Cut the current selection. (`APPCOMMAND_CUT`)
|
/// Cut the current selection. (`APPCOMMAND_CUT`)
|
||||||
Cut,
|
Cut,
|
||||||
/// Used to delete the character to the right of the cursor. This key value is also used for
|
/// Used to delete the character to the right of the cursor. This key value is also used for the
|
||||||
/// the key labeled `Delete` on MacOS keyboards when `Fn` is active.
|
/// key labeled `Delete` on MacOS keyboards when `Fn` is active.
|
||||||
Delete,
|
Delete,
|
||||||
/// The Erase to End of Field key. This key deletes all characters from the current cursor
|
/// The Erase to End of Field key. This key deletes all characters from the current cursor
|
||||||
/// position to the end of the current field.
|
/// position to the end of the current field.
|
||||||
@@ -917,15 +914,15 @@ pub enum NamedKey {
|
|||||||
Standby,
|
Standby,
|
||||||
/// The WakeUp key. (`KEYCODE_WAKEUP`)
|
/// The WakeUp key. (`KEYCODE_WAKEUP`)
|
||||||
WakeUp,
|
WakeUp,
|
||||||
/// Initiate the multi-candidate mode.
|
/// Initate the multi-candidate mode.
|
||||||
AllCandidates,
|
AllCandidates,
|
||||||
Alphanumeric,
|
Alphanumeric,
|
||||||
/// Initiate the Code Input mode to allow characters to be entered by
|
/// Initiate the Code Input mode to allow characters to be entered by
|
||||||
/// their code points.
|
/// their code points.
|
||||||
CodeInput,
|
CodeInput,
|
||||||
/// The Compose key, also known as "Multi_key" on the X Window System. This key acts in a
|
/// The Compose key, also known as "Multi_key" on the X Window System. This key acts in a
|
||||||
/// manner similar to a dead key, triggering a mode where subsequent key presses are combined
|
/// manner similar to a dead key, triggering a mode where subsequent key presses are combined to
|
||||||
/// to produce a different character.
|
/// produce a different character.
|
||||||
Compose,
|
Compose,
|
||||||
/// Convert the current input method sequence.
|
/// Convert the current input method sequence.
|
||||||
Convert,
|
Convert,
|
||||||
@@ -964,9 +961,9 @@ pub enum NamedKey {
|
|||||||
/// The Kana Mode (Kana Lock) key. This key is used to enter hiragana mode (typically from
|
/// The Kana Mode (Kana Lock) key. This key is used to enter hiragana mode (typically from
|
||||||
/// romaji mode).
|
/// romaji mode).
|
||||||
KanaMode,
|
KanaMode,
|
||||||
/// The Kanji (Japanese name for ideographic characters of Chinese origin) Mode key. This key
|
/// The Kanji (Japanese name for ideographic characters of Chinese origin) Mode key. This key is
|
||||||
/// is typically used to switch to a hiragana keyboard for the purpose of converting input
|
/// typically used to switch to a hiragana keyboard for the purpose of converting input into
|
||||||
/// into kanji. (`KEYCODE_KANA`)
|
/// kanji. (`KEYCODE_KANA`)
|
||||||
KanjiMode,
|
KanjiMode,
|
||||||
/// The Katakana (Japanese Kana characters) key.
|
/// The Katakana (Japanese Kana characters) key.
|
||||||
Katakana,
|
Katakana,
|
||||||
@@ -1457,12 +1454,35 @@ pub enum NamedKey {
|
|||||||
F35,
|
F35,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NOTE: the exact modifier key is not used to represent modifiers state in the
|
||||||
|
// first place due to a fact that modifiers state could be changed without any
|
||||||
|
// key being pressed and on some platforms like Wayland/X11 which key resulted
|
||||||
|
// in modifiers change is hidden, also, not that it really matters.
|
||||||
|
//
|
||||||
|
// The reason this API is even exposed is mostly to provide a way for users
|
||||||
|
// to treat modifiers differently based on their position, which is required
|
||||||
|
// on macOS due to their AltGr/Option situation.
|
||||||
|
bitflags! {
|
||||||
|
#[doc(hidden)]
|
||||||
|
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
||||||
|
pub struct ModifiersKeys: u8 {
|
||||||
|
const LSHIFT = 0b0000_0001;
|
||||||
|
const RSHIFT = 0b0000_0010;
|
||||||
|
const LCONTROL = 0b0000_0100;
|
||||||
|
const RCONTROL = 0b0000_1000;
|
||||||
|
const LALT = 0b0001_0000;
|
||||||
|
const RALT = 0b0010_0000;
|
||||||
|
const LSUPER = 0b0100_0000;
|
||||||
|
const RSUPER = 0b1000_0000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Key represents the meaning of a keypress.
|
/// Key represents the meaning of a keypress.
|
||||||
///
|
///
|
||||||
/// This is a superset of the UI Events Specification's [`KeyboardEvent.key`] with
|
/// This is a superset of the UI Events Specification's [`KeyboardEvent.key`] with
|
||||||
/// additions:
|
/// additions:
|
||||||
/// - All simple variants are wrapped under the `Named` variant
|
/// - All simple variants are wrapped under the `Named` variant
|
||||||
/// - The `Unidentified` variant here, can still identify a key through it's `NativeKeyCode`.
|
/// - The `Unidentified` variant here, can still identifiy a key through it's `NativeKeyCode`.
|
||||||
/// - The `Dead` variant here, can specify the character which is inserted when pressing the
|
/// - The `Dead` variant here, can specify the character which is inserted when pressing the
|
||||||
/// dead-key twice.
|
/// dead-key twice.
|
||||||
///
|
///
|
||||||
@@ -1568,7 +1588,7 @@ impl NamedKey {
|
|||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use winit::keyboard::NamedKey;
|
/// use winit_core::keyboard::NamedKey;
|
||||||
///
|
///
|
||||||
/// assert_eq!(NamedKey::Enter.to_text(), Some("\r"));
|
/// assert_eq!(NamedKey::Enter.to_text(), Some("\r"));
|
||||||
/// assert_eq!(NamedKey::F20.to_text(), None);
|
/// assert_eq!(NamedKey::F20.to_text(), None);
|
||||||
@@ -1591,7 +1611,7 @@ impl Key {
|
|||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use winit::keyboard::{Key, NamedKey};
|
/// use winit_core::keyboard::{NamedKey, Key};
|
||||||
///
|
///
|
||||||
/// assert_eq!(Key::Character("a".into()).to_text(), Some("a"));
|
/// assert_eq!(Key::Character("a".into()).to_text(), Some("a"));
|
||||||
/// assert_eq!(Key::Named(NamedKey::Enter).to_text(), Some("\r"));
|
/// assert_eq!(Key::Named(NamedKey::Enter).to_text(), Some("\r"));
|
||||||
@@ -1613,8 +1633,7 @@ impl Key {
|
|||||||
/// keys can be above the letters or on the numpad. This enum allows the user to differentiate
|
/// keys can be above the letters or on the numpad. This enum allows the user to differentiate
|
||||||
/// them.
|
/// them.
|
||||||
///
|
///
|
||||||
/// See the documentation for the [`location`] field on the [`KeyEvent`] struct for more
|
/// See the documentation for the [`location`] field on the [`KeyEvent`] struct for more information.
|
||||||
/// information.
|
|
||||||
///
|
///
|
||||||
/// [`location`]: ../event/struct.KeyEvent.html#structfield.location
|
/// [`location`]: ../event/struct.KeyEvent.html#structfield.location
|
||||||
/// [`KeyEvent`]: crate::event::KeyEvent
|
/// [`KeyEvent`]: crate::event::KeyEvent
|
||||||
@@ -1623,8 +1642,8 @@ impl Key {
|
|||||||
pub enum KeyLocation {
|
pub enum KeyLocation {
|
||||||
/// The key is in its "normal" location on the keyboard.
|
/// The key is in its "normal" location on the keyboard.
|
||||||
///
|
///
|
||||||
/// For instance, the "1" key above the "Q" key on a QWERTY keyboard will use this location.
|
/// For instance, the "1" key above the "Q" key on a QWERTY keyboard will use this location. This
|
||||||
/// This invariant is also returned when the location of the key cannot be identified.
|
/// invariant is also returned when the location of the key cannot be identified.
|
||||||
///
|
///
|
||||||
/// 
|
/// 
|
||||||
///
|
///
|
||||||
@@ -1707,17 +1726,14 @@ impl ModifiersState {
|
|||||||
pub fn shift_key(&self) -> bool {
|
pub fn shift_key(&self) -> bool {
|
||||||
self.intersects(Self::SHIFT)
|
self.intersects(Self::SHIFT)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns `true` if the control key is pressed.
|
/// Returns `true` if the control key is pressed.
|
||||||
pub fn control_key(&self) -> bool {
|
pub fn control_key(&self) -> bool {
|
||||||
self.intersects(Self::CONTROL)
|
self.intersects(Self::CONTROL)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns `true` if the alt key is pressed.
|
/// Returns `true` if the alt key is pressed.
|
||||||
pub fn alt_key(&self) -> bool {
|
pub fn alt_key(&self) -> bool {
|
||||||
self.intersects(Self::ALT)
|
self.intersects(Self::ALT)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns `true` if the super key is pressed.
|
/// Returns `true` if the super key is pressed.
|
||||||
pub fn super_key(&self) -> bool {
|
pub fn super_key(&self) -> bool {
|
||||||
self.intersects(Self::SUPER)
|
self.intersects(Self::SUPER)
|
||||||
@@ -1734,28 +1750,6 @@ pub enum ModifiersKeyState {
|
|||||||
Unknown,
|
Unknown,
|
||||||
}
|
}
|
||||||
|
|
||||||
// NOTE: the exact modifier key is not used to represent modifiers state in the
|
|
||||||
// first place due to a fact that modifiers state could be changed without any
|
|
||||||
// key being pressed and on some platforms like Wayland/X11 which key resulted
|
|
||||||
// in modifiers change is hidden, also, not that it really matters.
|
|
||||||
//
|
|
||||||
// The reason this API is even exposed is mostly to provide a way for users
|
|
||||||
// to treat modifiers differently based on their position, which is required
|
|
||||||
// on macOS due to their AltGr/Option situation.
|
|
||||||
bitflags! {
|
|
||||||
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
|
||||||
pub(crate) struct ModifiersKeys: u8 {
|
|
||||||
const LSHIFT = 0b0000_0001;
|
|
||||||
const RSHIFT = 0b0000_0010;
|
|
||||||
const LCONTROL = 0b0000_0100;
|
|
||||||
const RCONTROL = 0b0000_1000;
|
|
||||||
const LALT = 0b0001_0000;
|
|
||||||
const RALT = 0b0010_0000;
|
|
||||||
const LSUPER = 0b0100_0000;
|
|
||||||
const RSUPER = 0b1000_0000;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
mod modifiers_serde {
|
mod modifiers_serde {
|
||||||
use super::ModifiersState;
|
use super::ModifiersState;
|
||||||
@@ -1791,8 +1785,12 @@ mod modifiers_serde {
|
|||||||
where
|
where
|
||||||
D: Deserializer<'de>,
|
D: Deserializer<'de>,
|
||||||
{
|
{
|
||||||
let ModifiersStateSerialize { shift_key, control_key, alt_key, super_key } =
|
let ModifiersStateSerialize {
|
||||||
ModifiersStateSerialize::deserialize(deserializer)?;
|
shift_key,
|
||||||
|
control_key,
|
||||||
|
alt_key,
|
||||||
|
super_key,
|
||||||
|
} = ModifiersStateSerialize::deserialize(deserializer)?;
|
||||||
let mut m = ModifiersState::empty();
|
let mut m = ModifiersState::empty();
|
||||||
m.set(ModifiersState::SHIFT, shift_key);
|
m.set(ModifiersState::SHIFT, shift_key);
|
||||||
m.set(ModifiersState::CONTROL, control_key);
|
m.set(ModifiersState::CONTROL, control_key);
|
||||||
18
winit-core/src/lib.rs
Normal file
18
winit-core/src/lib.rs
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
//! Base types for a windowing library.
|
||||||
|
//!
|
||||||
|
//! This crate contains types, traits and basic functions from [`winit`] that are platform
|
||||||
|
//! independent. It is intended to allow for other crates to build abstractions around [`winit`]
|
||||||
|
//! without needing to pull in all of [`winit`]'s dependencies, as well as to provide an
|
||||||
|
//! interface for alternative backends for [`winit`] to be constructed.
|
||||||
|
//!
|
||||||
|
//! [`winit`]: https://docs.rs/winit
|
||||||
|
|
||||||
|
#[cfg(any(not(feature = "std"), not(feature = "alloc")))]
|
||||||
|
compile_error! { "no-std and no-alloc usage are not yet supported" }
|
||||||
|
|
||||||
|
pub mod dpi;
|
||||||
|
pub mod error;
|
||||||
|
pub mod event;
|
||||||
|
pub mod event_loop;
|
||||||
|
pub mod keyboard;
|
||||||
|
pub mod window;
|
||||||
229
winit-core/src/window.rs
Normal file
229
winit-core/src/window.rs
Normal file
@@ -0,0 +1,229 @@
|
|||||||
|
//! Types used in window construction.
|
||||||
|
|
||||||
|
#[doc(inline)]
|
||||||
|
pub use cursor_icon::{CursorIcon, ParseError as CursorIconParseError};
|
||||||
|
|
||||||
|
#[cfg(feature = "serde")]
|
||||||
|
pub use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
/// Identifier of a window. Unique for each window.
|
||||||
|
///
|
||||||
|
/// Can be obtained with [`window.id()`](https://docs.rs/winit/latest/winit/window/struct.Window.html#method.id).
|
||||||
|
///
|
||||||
|
/// Whenever you receive an event specific to a window, this event contains a `WindowId` which you
|
||||||
|
/// can then compare to the ids of your windows.
|
||||||
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
pub struct WindowId(u64);
|
||||||
|
|
||||||
|
impl WindowId {
|
||||||
|
/// Returns a dummy id, useful for unit testing.
|
||||||
|
///
|
||||||
|
/// # Safety
|
||||||
|
///
|
||||||
|
/// The only guarantee made about the return value of this function is that
|
||||||
|
/// it will always be equal to itself and to future values returned by this function.
|
||||||
|
/// No other guarantees are made. This may be equal to a real [`WindowId`].
|
||||||
|
///
|
||||||
|
/// **Passing this into a winit function will result in undefined behavior.**
|
||||||
|
pub const unsafe fn dummy() -> Self {
|
||||||
|
WindowId(0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<WindowId> for u64 {
|
||||||
|
fn from(window_id: WindowId) -> Self {
|
||||||
|
window_id.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<u64> for WindowId {
|
||||||
|
fn from(raw_id: u64) -> Self {
|
||||||
|
Self(raw_id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The behavior of cursor grabbing.
|
||||||
|
///
|
||||||
|
/// Use this enum with [`Window::set_cursor_grab`] to grab the cursor.
|
||||||
|
///
|
||||||
|
/// [`Window::set_cursor_grab`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.set_cursor_grab
|
||||||
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
|
||||||
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
pub enum CursorGrabMode {
|
||||||
|
/// No grabbing of the cursor is performed.
|
||||||
|
None,
|
||||||
|
|
||||||
|
/// The cursor is confined to the window area.
|
||||||
|
///
|
||||||
|
/// There's no guarantee that the cursor will be hidden. You should hide it by yourself if you
|
||||||
|
/// want to do so.
|
||||||
|
///
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **macOS:** Not implemented. Always returns [`ExternalError::NotSupported`] for now.
|
||||||
|
/// - **iOS / Android / Web / Orbital:** Always returns an [`ExternalError::NotSupported`].
|
||||||
|
///
|
||||||
|
/// [`ExternalError::NotSupported`]: https://docs.rs/winit/latest/winit/error/enum.ExternalError.html#variant.NotSupported
|
||||||
|
Confined,
|
||||||
|
|
||||||
|
/// The cursor is locked inside the window area to the certain position.
|
||||||
|
///
|
||||||
|
/// There's no guarantee that the cursor will be hidden. You should hide it by yourself if you
|
||||||
|
/// want to do so.
|
||||||
|
///
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **X11 / Windows:** Not implemented. Always returns [`ExternalError::NotSupported`] for now.
|
||||||
|
/// - **iOS / Android / Orbital:** Always returns an [`ExternalError::NotSupported`].
|
||||||
|
///
|
||||||
|
/// [`ExternalError::NotSupported`]: https://docs.rs/winit/latest/winit/error/enum.ExternalError.html#variant.NotSupported
|
||||||
|
Locked,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Defines the orientation that a window resize will be performed.
|
||||||
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
|
||||||
|
pub enum ResizeDirection {
|
||||||
|
East,
|
||||||
|
North,
|
||||||
|
NorthEast,
|
||||||
|
NorthWest,
|
||||||
|
South,
|
||||||
|
SouthEast,
|
||||||
|
SouthWest,
|
||||||
|
West,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<ResizeDirection> for CursorIcon {
|
||||||
|
fn from(direction: ResizeDirection) -> Self {
|
||||||
|
use ResizeDirection::*;
|
||||||
|
match direction {
|
||||||
|
East => CursorIcon::EResize,
|
||||||
|
North => CursorIcon::NResize,
|
||||||
|
NorthEast => CursorIcon::NeResize,
|
||||||
|
NorthWest => CursorIcon::NwResize,
|
||||||
|
South => CursorIcon::SResize,
|
||||||
|
SouthEast => CursorIcon::SeResize,
|
||||||
|
SouthWest => CursorIcon::SwResize,
|
||||||
|
West => CursorIcon::WResize,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The theme variant to use.
|
||||||
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||||
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
pub enum Theme {
|
||||||
|
/// Use the light variant.
|
||||||
|
Light,
|
||||||
|
|
||||||
|
/// Use the dark variant.
|
||||||
|
Dark,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **X11:** Sets the WM's `XUrgencyHint`. No distinction between [`Critical`] and [`Informational`].
|
||||||
|
///
|
||||||
|
/// [`Critical`]: Self::Critical
|
||||||
|
/// [`Informational`]: Self::Informational
|
||||||
|
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
|
||||||
|
pub enum UserAttentionType {
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **macOS:** Bounces the dock icon until the application is in focus.
|
||||||
|
/// - **Windows:** Flashes both the window and the taskbar button until the application is in focus.
|
||||||
|
Critical,
|
||||||
|
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **macOS:** Bounces the dock icon once.
|
||||||
|
/// - **Windows:** Flashes the taskbar button until the application is in focus.
|
||||||
|
#[default]
|
||||||
|
Informational,
|
||||||
|
}
|
||||||
|
|
||||||
|
bitflags::bitflags! {
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
||||||
|
pub struct WindowButtons: u32 {
|
||||||
|
const CLOSE = 1 << 0;
|
||||||
|
const MINIMIZE = 1 << 1;
|
||||||
|
const MAXIMIZE = 1 << 2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A window level groups windows with respect to their z-position.
|
||||||
|
///
|
||||||
|
/// The relative ordering between windows in different window levels is fixed.
|
||||||
|
/// The z-order of a window within the same window level may change dynamically on user interaction.
|
||||||
|
///
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **iOS / Android / Web / Wayland:** Unsupported.
|
||||||
|
#[derive(Debug, Default, PartialEq, Eq, Clone, Copy)]
|
||||||
|
pub enum WindowLevel {
|
||||||
|
/// The window will always be below normal windows.
|
||||||
|
///
|
||||||
|
/// This is useful for a widget-based app.
|
||||||
|
AlwaysOnBottom,
|
||||||
|
|
||||||
|
/// The default.
|
||||||
|
#[default]
|
||||||
|
Normal,
|
||||||
|
|
||||||
|
/// The window will always be on top of normal windows.
|
||||||
|
AlwaysOnTop,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generic IME purposes for use in [`Window::set_ime_purpose`].
|
||||||
|
///
|
||||||
|
/// The purpose may improve UX by optimizing the IME for the specific use case,
|
||||||
|
/// if winit can express the purpose to the platform and the platform reacts accordingly.
|
||||||
|
///
|
||||||
|
/// ## Platform-specific
|
||||||
|
///
|
||||||
|
/// - **iOS / Android / Web / Windows / X11 / macOS / Orbital:** Unsupported.
|
||||||
|
///
|
||||||
|
/// [`Window::set_ime_purpose`]: https://docs.rs/winit/latest/winit/window/struct.Window.html#method.set_ime_purpose
|
||||||
|
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
|
||||||
|
#[non_exhaustive]
|
||||||
|
pub enum ImePurpose {
|
||||||
|
/// No special hints for the IME (default).
|
||||||
|
Normal,
|
||||||
|
/// The IME is used for password input.
|
||||||
|
Password,
|
||||||
|
/// The IME is used to input into a terminal.
|
||||||
|
///
|
||||||
|
/// For example, that could alter OSK on Wayland to show extra buttons.
|
||||||
|
Terminal,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for ImePurpose {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::Normal
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An stringly-typed token used to activate the [`Window`].
|
||||||
|
///
|
||||||
|
/// [`Window`]: https://docs.rs/winit/latest/winit/window/struct.Window.html
|
||||||
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
||||||
|
pub struct ActivationToken {
|
||||||
|
pub(crate) token: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ActivationToken {
|
||||||
|
/// Create a new [`ActivationToken`].
|
||||||
|
pub fn new(token: String) -> Self {
|
||||||
|
Self { token }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the underlying token.
|
||||||
|
pub fn token(&self) -> &str {
|
||||||
|
&self.token
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Convert into the underlying token.
|
||||||
|
pub fn into_token(self) -> String {
|
||||||
|
self.token
|
||||||
|
}
|
||||||
|
}
|
||||||
261
winit/Cargo.toml
Normal file
261
winit/Cargo.toml
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
[package]
|
||||||
|
name = "winit"
|
||||||
|
version = "0.29.10"
|
||||||
|
authors = ["The winit contributors", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
|
||||||
|
description = "Cross-platform window creation library."
|
||||||
|
edition = "2021"
|
||||||
|
keywords = ["windowing"]
|
||||||
|
license = "Apache-2.0"
|
||||||
|
readme = "README.md"
|
||||||
|
repository = "https://github.com/rust-windowing/winit"
|
||||||
|
documentation = "https://docs.rs/winit"
|
||||||
|
categories = ["gui"]
|
||||||
|
rust-version = "1.70.0"
|
||||||
|
|
||||||
|
[package.metadata.docs.rs]
|
||||||
|
features = [
|
||||||
|
"rwh_04",
|
||||||
|
"rwh_05",
|
||||||
|
"rwh_06",
|
||||||
|
"serde",
|
||||||
|
"mint",
|
||||||
|
# Enabled to get docs to compile
|
||||||
|
"android-native-activity",
|
||||||
|
]
|
||||||
|
default-target = "x86_64-unknown-linux-gnu"
|
||||||
|
# These are all tested in CI
|
||||||
|
targets = [
|
||||||
|
# Windows
|
||||||
|
"i686-pc-windows-msvc",
|
||||||
|
"x86_64-pc-windows-msvc",
|
||||||
|
# macOS
|
||||||
|
"x86_64-apple-darwin",
|
||||||
|
# Unix (X11 & Wayland)
|
||||||
|
"i686-unknown-linux-gnu",
|
||||||
|
"x86_64-unknown-linux-gnu",
|
||||||
|
# iOS
|
||||||
|
"x86_64-apple-ios",
|
||||||
|
# Android
|
||||||
|
"aarch64-linux-android",
|
||||||
|
# Web
|
||||||
|
"wasm32-unknown-unknown",
|
||||||
|
]
|
||||||
|
rustdoc-args = ["--cfg", "docsrs"]
|
||||||
|
|
||||||
|
[features]
|
||||||
|
default = ["rwh_06", "x11", "wayland", "wayland-dlopen", "wayland-csd-adwaita"]
|
||||||
|
x11 = ["x11-dl", "bytemuck", "percent-encoding", "xkbcommon-dl/x11", "x11rb"]
|
||||||
|
wayland = ["wayland-client", "wayland-backend", "wayland-protocols", "wayland-protocols-plasma", "sctk", "ahash", "memmap2"]
|
||||||
|
wayland-dlopen = ["wayland-backend/dlopen"]
|
||||||
|
wayland-csd-adwaita = ["sctk-adwaita", "sctk-adwaita/ab_glyph"]
|
||||||
|
wayland-csd-adwaita-crossfont = ["sctk-adwaita", "sctk-adwaita/crossfont"]
|
||||||
|
wayland-csd-adwaita-notitle = ["sctk-adwaita"]
|
||||||
|
android-native-activity = ["android-activity/native-activity"]
|
||||||
|
android-game-activity = ["android-activity/game-activity"]
|
||||||
|
mint = ["winit-core/mint"]
|
||||||
|
serde = ["dep:serde", "winit-core/serde", "cursor-icon/serde", "smol_str/serde"]
|
||||||
|
rwh_04 = ["dep:rwh_04", "ndk/rwh_04"]
|
||||||
|
rwh_05 = ["dep:rwh_05", "ndk/rwh_05"]
|
||||||
|
rwh_06 = ["dep:rwh_06", "ndk/rwh_06"]
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
cfg_aliases.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
bitflags.workspace = true
|
||||||
|
cursor-icon.workspace = true
|
||||||
|
log = "0.4"
|
||||||
|
once_cell = "1.12"
|
||||||
|
rwh_04 = { package = "raw-window-handle", version = "0.4", optional = true }
|
||||||
|
rwh_05 = { package = "raw-window-handle", version = "0.5.2", features = ["std"], optional = true }
|
||||||
|
rwh_06 = { package = "raw-window-handle", version = "0.6", features = ["std"], optional = true }
|
||||||
|
serde = { workspace = true, optional = true }
|
||||||
|
smol_str.workspace = true
|
||||||
|
winit-core.workspace = true
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
image = { version = "0.24.0", default-features = false, features = ["png"] }
|
||||||
|
simple_logger = { version = "4.2.0", default_features = false }
|
||||||
|
winit = { path = ".", features = ["rwh_05"] }
|
||||||
|
|
||||||
|
[target.'cfg(not(any(target_os = "android", target_os = "ios")))'.dev-dependencies]
|
||||||
|
softbuffer = { version = "0.3.0", default-features = false, features = ["x11", "x11-dlopen", "wayland", "wayland-dlopen"] }
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "android")'.dependencies]
|
||||||
|
android-activity = "0.5.0"
|
||||||
|
ndk = { version = "0.8.0", default-features = false }
|
||||||
|
ndk-sys = "0.5.0"
|
||||||
|
|
||||||
|
[target.'cfg(any(target_os = "ios", target_os = "macos"))'.dependencies]
|
||||||
|
core-foundation = "0.9.3"
|
||||||
|
objc2 = "0.5.0"
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "macos")'.dependencies]
|
||||||
|
core-graphics = "0.23.1"
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "macos")'.dependencies.icrate]
|
||||||
|
version = "0.1.0"
|
||||||
|
features = [
|
||||||
|
"dispatch",
|
||||||
|
"Foundation",
|
||||||
|
"Foundation_NSArray",
|
||||||
|
"Foundation_NSAttributedString",
|
||||||
|
"Foundation_NSMutableAttributedString",
|
||||||
|
"Foundation_NSData",
|
||||||
|
"Foundation_NSDictionary",
|
||||||
|
"Foundation_NSString",
|
||||||
|
"Foundation_NSProcessInfo",
|
||||||
|
"Foundation_NSThread",
|
||||||
|
"Foundation_NSNumber",
|
||||||
|
"AppKit",
|
||||||
|
"AppKit_NSAppearance",
|
||||||
|
"AppKit_NSApplication",
|
||||||
|
"AppKit_NSBitmapImageRep",
|
||||||
|
"AppKit_NSButton",
|
||||||
|
"AppKit_NSColor",
|
||||||
|
"AppKit_NSControl",
|
||||||
|
"AppKit_NSCursor",
|
||||||
|
"AppKit_NSEvent",
|
||||||
|
"AppKit_NSGraphicsContext",
|
||||||
|
"AppKit_NSImage",
|
||||||
|
"AppKit_NSImageRep",
|
||||||
|
"AppKit_NSMenu",
|
||||||
|
"AppKit_NSMenuItem",
|
||||||
|
"AppKit_NSPasteboard",
|
||||||
|
"AppKit_NSResponder",
|
||||||
|
"AppKit_NSScreen",
|
||||||
|
"AppKit_NSTextInputContext",
|
||||||
|
"AppKit_NSView",
|
||||||
|
"AppKit_NSWindow",
|
||||||
|
"AppKit_NSWindowTabGroup",
|
||||||
|
]
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "ios")'.dependencies.icrate]
|
||||||
|
version = "0.1.0"
|
||||||
|
features = [
|
||||||
|
"dispatch",
|
||||||
|
"Foundation",
|
||||||
|
"Foundation_NSArray",
|
||||||
|
"Foundation_NSString",
|
||||||
|
"Foundation_NSProcessInfo",
|
||||||
|
"Foundation_NSThread",
|
||||||
|
"Foundation_NSSet",
|
||||||
|
]
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "windows")'.dependencies]
|
||||||
|
unicode-segmentation = "1.7.1"
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "windows")'.dependencies.windows-sys]
|
||||||
|
version = "0.48"
|
||||||
|
features = [
|
||||||
|
"Win32_Devices_HumanInterfaceDevice",
|
||||||
|
"Win32_Foundation",
|
||||||
|
"Win32_Globalization",
|
||||||
|
"Win32_Graphics_Dwm",
|
||||||
|
"Win32_Graphics_Gdi",
|
||||||
|
"Win32_Media",
|
||||||
|
"Win32_System_Com_StructuredStorage",
|
||||||
|
"Win32_System_Com",
|
||||||
|
"Win32_System_LibraryLoader",
|
||||||
|
"Win32_System_Ole",
|
||||||
|
"Win32_System_SystemInformation",
|
||||||
|
"Win32_System_SystemServices",
|
||||||
|
"Win32_System_Threading",
|
||||||
|
"Win32_System_WindowsProgramming",
|
||||||
|
"Win32_UI_Accessibility",
|
||||||
|
"Win32_UI_Controls",
|
||||||
|
"Win32_UI_HiDpi",
|
||||||
|
"Win32_UI_Input_Ime",
|
||||||
|
"Win32_UI_Input_KeyboardAndMouse",
|
||||||
|
"Win32_UI_Input_Pointer",
|
||||||
|
"Win32_UI_Input_Touch",
|
||||||
|
"Win32_UI_Shell",
|
||||||
|
"Win32_UI_TextServices",
|
||||||
|
"Win32_UI_WindowsAndMessaging",
|
||||||
|
]
|
||||||
|
|
||||||
|
[target.'cfg(all(unix, not(any(target_os = "redox", target_family = "wasm", target_os = "android", target_os = "ios", target_os = "macos"))))'.dependencies]
|
||||||
|
ahash = { version = "0.8.3", features = ["no-rng"], optional = true }
|
||||||
|
bytemuck = { version = "1.13.1", default-features = false, optional = true }
|
||||||
|
calloop = "0.12.3"
|
||||||
|
libc = "0.2.64"
|
||||||
|
memmap2 = { version = "0.9.0", optional = true }
|
||||||
|
percent-encoding = { version = "2.0", optional = true }
|
||||||
|
rustix = { version = "0.38.4", default-features = false, features = ["std", "system", "thread", "process"] }
|
||||||
|
sctk = { package = "smithay-client-toolkit", version = "0.18.0", default-features = false, features = ["calloop"], optional = true }
|
||||||
|
sctk-adwaita = { version = "0.8.0", default_features = false, optional = true }
|
||||||
|
wayland-backend = { version = "0.3.0", default_features = false, features = ["client_system"], optional = true }
|
||||||
|
wayland-client = { version = "0.31.1", optional = true }
|
||||||
|
wayland-protocols = { version = "0.31.0", features = [ "staging"], optional = true }
|
||||||
|
wayland-protocols-plasma = { version = "0.2.0", features = [ "client" ], optional = true }
|
||||||
|
x11-dl = { version = "2.18.5", optional = true }
|
||||||
|
x11rb = { version = "0.13.0", default-features = false, features = ["allow-unsafe-code", "dl-libxcb", "randr", "resource_manager", "xinput", "xkb"], optional = true }
|
||||||
|
xkbcommon-dl = "0.4.0"
|
||||||
|
|
||||||
|
[target.'cfg(target_os = "redox")'.dependencies]
|
||||||
|
orbclient = { version = "0.3.47", default-features = false }
|
||||||
|
redox_syscall = "0.4.1"
|
||||||
|
|
||||||
|
[target.'cfg(target_family = "wasm")'.dependencies.web_sys]
|
||||||
|
package = "web-sys"
|
||||||
|
version = "0.3.64"
|
||||||
|
features = [
|
||||||
|
'AbortController',
|
||||||
|
'AbortSignal',
|
||||||
|
'Blob',
|
||||||
|
'console',
|
||||||
|
'CssStyleDeclaration',
|
||||||
|
'Document',
|
||||||
|
'DomException',
|
||||||
|
'DomRect',
|
||||||
|
'DomRectReadOnly',
|
||||||
|
'Element',
|
||||||
|
'Event',
|
||||||
|
'EventTarget',
|
||||||
|
'FocusEvent',
|
||||||
|
'HtmlCanvasElement',
|
||||||
|
'HtmlElement',
|
||||||
|
'HtmlImageElement',
|
||||||
|
'ImageBitmap',
|
||||||
|
'ImageBitmapOptions',
|
||||||
|
'ImageBitmapRenderingContext',
|
||||||
|
'ImageData',
|
||||||
|
'IntersectionObserver',
|
||||||
|
'IntersectionObserverEntry',
|
||||||
|
'KeyboardEvent',
|
||||||
|
'MediaQueryList',
|
||||||
|
'MessageChannel',
|
||||||
|
'MessagePort',
|
||||||
|
'Node',
|
||||||
|
'PageTransitionEvent',
|
||||||
|
'PointerEvent',
|
||||||
|
'PremultiplyAlpha',
|
||||||
|
'ResizeObserver',
|
||||||
|
'ResizeObserverBoxOptions',
|
||||||
|
'ResizeObserverEntry',
|
||||||
|
'ResizeObserverOptions',
|
||||||
|
'ResizeObserverSize',
|
||||||
|
'VisibilityState',
|
||||||
|
'Window',
|
||||||
|
'WheelEvent',
|
||||||
|
'Url',
|
||||||
|
]
|
||||||
|
|
||||||
|
[target.'cfg(target_family = "wasm")'.dependencies]
|
||||||
|
js-sys = "0.3.64"
|
||||||
|
pin-project = "1"
|
||||||
|
wasm-bindgen = "0.2"
|
||||||
|
wasm-bindgen-futures = "0.4"
|
||||||
|
web-time.workspace = true
|
||||||
|
|
||||||
|
[target.'cfg(all(target_family = "wasm", target_feature = "atomics"))'.dependencies]
|
||||||
|
atomic-waker = "1"
|
||||||
|
concurrent-queue = { version = "2", default-features = false }
|
||||||
|
|
||||||
|
[target.'cfg(target_family = "wasm")'.dev-dependencies]
|
||||||
|
console_log = "1"
|
||||||
|
web-sys = { version = "0.3.22", features = ['CanvasRenderingContext2d'] }
|
||||||
|
|
||||||
|
[[example]]
|
||||||
|
doc-scrape-examples = true
|
||||||
|
name = "window"
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user