Skip to content

Commit caafa03

Browse files
cartcart
authored
Untangle Cursor Dependencies (bevyengine#20427)
# Objective Fixes bevyengine#20182 Fixes bevyengine#20381 Alternative to bevyengine#20384 ## Solution The root cause of the problems above is that `bevy_window` includes `bevy_window::ANDROID_APP`, which prevents it from behaving as a backend-agnostic window API. This forces `bevy_asset` to take a dependency on `bevy_window` just to provide android support, which is unnecessary. This in turn prevents `bevy_window` from owning the relevant CursorIcon / CustomCursor types, because it would need to depend on `bevy_asset`, which creates a circular dependency. The solution is to move `ANDROID_APP` to a new `bevy_android` crate, which `bevy_asset` can then depend on. This allows the "backend-agnostic" cursor types to live in `bevy_window`, which then allows `bevy_feathers` to remove its dependency on `bevy_winit`. While I was touching this code I also chose to make `CustomCursor::Url` available on all platforms. This is up to the backends to implement (or not implement). It also means that users no longer need to know the magic `#[cfg]` block to make their code compile on all platforms. `bevy_winit` currently logs a `error_once` if it is ever used on a platform where it is not supported.
1 parent 3d6a5b7 commit caafa03

File tree

27 files changed

+649
-440
lines changed

27 files changed

+649
-440
lines changed

‎crates/bevy_android/Cargo.toml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[package]
2+
name = "bevy_android"
3+
version = "0.17.0-dev"
4+
edition = "2024"
5+
description = "Provides android functionality for Bevy Engine."
6+
homepage = "https://bevy.org"
7+
repository = "https://github.com/bevyengine/bevy"
8+
license = "MIT OR Apache-2.0"
9+
keywords = ["bevy"]
10+
11+
[target.'cfg(target_os = "android")'.dependencies]
12+
android-activity = "0.6"
13+
14+
[features]
15+
default = []
16+
17+
[lints]
18+
workspace = true
19+
20+
[package.metadata.docs.rs]
21+
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
22+
all-features = true

‎crates/bevy_android/LICENSE-APACHE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎crates/bevy_android/LICENSE-MIT‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
MIT License
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎crates/bevy_android/src/lib.rs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
//! Provides Android functionality for Bevy Engine.
2+
3+
#[cfg(target_os = "android")]
4+
pub use android_activity;
5+
6+
/// [`AndroidApp`] provides an interface to query the application state as well as monitor events
7+
/// (for example lifecycle and input events).
8+
#[cfg(target_os = "android")]
9+
pub static ANDROID_APP: std::sync::OnceLock<android_activity::AndroidApp> =
10+
std::sync::OnceLock::new();

‎crates/bevy_asset/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ uuid = { version = "1.13.1", default-features = false, features = [
6565
tracing = { version = "0.1", default-features = false }
6666

6767
[target.'cfg(target_os = "android")'.dependencies]
68-
bevy_window = { path = "../bevy_window", version = "0.17.0-dev" }
68+
bevy_android = { path = "../bevy_android", version = "0.17.0-dev", default-features = false }
6969

7070
[target.'cfg(target_arch = "wasm32")'.dependencies]
7171
# TODO: Assuming all wasm builds are for the browser. Require `no_std` support to break assumption.

‎crates/bevy_asset/src/io/android.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ pub struct AndroidAssetReader;
1717

1818
impl AssetReader for AndroidAssetReader {
1919
async fn read<'a>(&'a self, path: &'a Path) -> Result<impl Reader + 'a, AssetReaderError> {
20-
let asset_manager = bevy_window::ANDROID_APP
20+
let asset_manager = bevy_android::ANDROID_APP
2121
.get()
2222
.expect("Bevy must be setup with the #[bevy_main] macro on Android")
2323
.asset_manager();
@@ -31,7 +31,7 @@ impl AssetReader for AndroidAssetReader {
3131

3232
async fn read_meta<'a>(&'a self, path: &'a Path) -> Result<impl Reader + 'a, AssetReaderError> {
3333
let meta_path = get_meta_path(path);
34-
let asset_manager = bevy_window::ANDROID_APP
34+
let asset_manager = bevy_android::ANDROID_APP
3535
.get()
3636
.expect("Bevy must be setup with the #[bevy_main] macro on Android")
3737
.asset_manager();
@@ -47,7 +47,7 @@ impl AssetReader for AndroidAssetReader {
4747
&'a self,
4848
path: &'a Path,
4949
) -> Result<Box<PathStream>, AssetReaderError> {
50-
let asset_manager = bevy_window::ANDROID_APP
50+
let asset_manager = bevy_android::ANDROID_APP
5151
.get()
5252
.expect("Bevy must be setup with the #[bevy_main] macro on Android")
5353
.asset_manager();
@@ -73,7 +73,7 @@ impl AssetReader for AndroidAssetReader {
7373
}
7474

7575
async fn is_directory<'a>(&'a self, path: &'a Path) -> Result<bool, AssetReaderError> {
76-
let asset_manager = bevy_window::ANDROID_APP
76+
let asset_manager = bevy_android::ANDROID_APP
7777
.get()
7878
.expect("Bevy must be setup with the #[bevy_main] macro on Android")
7979
.asset_manager();

‎crates/bevy_derive/src/bevy_main.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ pub fn bevy_main(_attr: TokenStream, item: TokenStream) -> TokenStream {
1515
// guarantee required from the caller.
1616
#[unsafe(no_mangle)]
1717
#[cfg(target_os = "android")]
18-
fn android_main(android_app: bevy::window::android_activity::AndroidApp) {
19-
let _ = bevy::window::ANDROID_APP.set(android_app);
18+
fn android_main(android_app: bevy::android::android_activity::AndroidApp) {
19+
let _ = bevy::android::ANDROID_APP.set(android_app);
2020
main();
2121
}
2222

‎crates/bevy_feathers/Cargo.toml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,13 @@ bevy_ui = { path = "../bevy_ui", version = "0.17.0-dev", features = [
2929
] }
3030
bevy_ui_render = { path = "../bevy_ui_render", version = "0.17.0-dev" }
3131
bevy_window = { path = "../bevy_window", version = "0.17.0-dev" }
32-
bevy_winit = { path = "../bevy_winit", version = "0.17.0-dev" }
3332

3433
# other
3534
accesskit = "0.21"
3635

3736
[features]
3837
default = []
39-
custom_cursor = ["bevy_winit/custom_cursor"]
38+
custom_cursor = ["bevy_window/custom_cursor"]
4039

4140
[lints]
4241
workspace = true

‎crates/bevy_feathers/src/cursor.rs‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ use bevy_ecs::{
1212
};
1313
use bevy_picking::{hover::HoverMap, pointer::PointerId, PickingSystems};
1414
use bevy_reflect::{std_traits::ReflectDefault, Reflect};
15-
use bevy_window::{SystemCursorIcon, Window};
16-
use bevy_winit::cursor::CursorIcon;
1715
#[cfg(feature = "custom_cursor")]
18-
use bevy_winit::cursor::CustomCursor;
16+
use bevy_window::CustomCursor;
17+
use bevy_window::{CursorIcon, SystemCursorIcon, Window};
1918

2019
/// A resource that specifies the cursor icon to be used when the mouse is not hovering over
2120
/// any other entity. This is used to set the default cursor icon for the window.

‎crates/bevy_internal/Cargo.toml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,8 @@ reflect_functions = [
303303
# Enable documentation reflection
304304
reflect_documentation = ["bevy_reflect/documentation"]
305305

306-
# Enable winit custom cursor support
307-
custom_cursor = ["bevy_winit/custom_cursor"]
306+
# Enable custom cursor support
307+
custom_cursor = ["bevy_window/custom_cursor", "bevy_winit/custom_cursor"]
308308

309309
# Experimental support for nodes that are ignored for UI layouting
310310
ghost_nodes = ["bevy_ui/ghost_nodes"]
@@ -458,6 +458,9 @@ bevy_window = { path = "../bevy_window", optional = true, version = "0.17.0-dev"
458458
] }
459459
bevy_winit = { path = "../bevy_winit", optional = true, version = "0.17.0-dev", default-features = false }
460460

461+
[target.'cfg(target_os = "android")'.dependencies]
462+
bevy_android = { path = "../bevy_android", version = "0.17.0-dev", default-features = false }
463+
461464
[lints]
462465
workspace = true
463466

0 commit comments

Comments
 (0)