Browse Source

Remove android-activity dependency + add activity features (#2863)

Instead of depending on android-activity directly, this exposes the
android-native-activity and android-game-activity features from Winit.

This ensures that applications can choose what android-backend they use
while also relying on Winit to decide what version of android-activity to
use - without increasing the risk of a version conflict by having a direct
dependency.

_(NB: Egui doesn't currently use the android-activity API itself)_

Since android-activity provides the `android_main()` entry point for
Android applications it's not possible to link in multiple version of
the android-activity crate and so it's particularly important to
avoid unnecessary direct dependencies that could cause a version
conflict in the future.

To help avoid the need for applications to directly depend on
android-activity the Winit crate re-exports the android-activity API
and exposes features to configure the backend so that application crates
can instead rely on Winit to pull in a compatible version of
android-activity. (This way version bumps for android-activity only
need to be synchronized with the Winit crate).

CI now enables the `android-native-activity` feature for testing.

Fixes: #2829
Fixes: #2720
Closes: #2834
pull/2905/head
Robert Bragg 2 years ago
committed by GitHub
parent
commit
89e42884fc
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      .github/workflows/rust.yml
  2. 1
      Cargo.lock
  3. 9
      crates/eframe/Cargo.toml
  4. 13
      crates/egui-winit/Cargo.toml

2
.github/workflows/rust.yml

@ -205,7 +205,7 @@ jobs:
- name: Set up cargo cache - name: Set up cargo cache
uses: Swatinem/rust-cache@v2 uses: Swatinem/rust-cache@v2
- run: cargo check --features wgpu --target aarch64-linux-android - run: cargo check --features wgpu,android-native-activity --target aarch64-linux-android
working-directory: crates/eframe working-directory: crates/eframe
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------

1
Cargo.lock

@ -1272,7 +1272,6 @@ name = "egui-winit"
version = "0.21.1" version = "0.21.1"
dependencies = [ dependencies = [
"accesskit_winit", "accesskit_winit",
"android-activity",
"arboard", "arboard",
"document-features", "document-features",
"egui", "egui",

9
crates/eframe/Cargo.toml

@ -69,6 +69,15 @@ __screenshot = ["dep:image"]
## This overrides the `glow` feature. ## This overrides the `glow` feature.
wgpu = ["dep:wgpu", "dep:egui-wgpu", "dep:pollster"] wgpu = ["dep:wgpu", "dep:egui-wgpu", "dep:pollster"]
# Allow crates to choose an android-activity backend via Winit
# - It's important that most applications should not have to depend on android-activity directly, and can
# rely on Winit to pull in a suitable version (unlike most Rust crates, any version conflicts won't link)
# - It's also important that we don't impose an android-activity backend by taking this choice away from applications.
## Enable the `native-activity` backend via `egui-winit` on Android
android-native-activity = [ "egui-winit/android-native-activity" ]
## Enable the `game-activity` backend via `egui-winit` on Android
android-game-activity = [ "egui-winit/android-game-activity" ]
[dependencies] [dependencies]
egui = { version = "0.21.0", path = "../egui", default-features = false, features = [ egui = { version = "0.21.0", path = "../egui", default-features = false, features = [

13
crates/egui-winit/Cargo.toml

@ -42,6 +42,16 @@ serde = ["egui/serde", "dep:serde"]
## Enables Wayland support. ## Enables Wayland support.
wayland = ["winit/wayland"] wayland = ["winit/wayland"]
# Allow crates to choose an android-activity backend via Winit
# - It's important that most applications should not have to depend on android-activity directly, and can
# rely on Winit to pull in a suitable version (unlike most Rust crates, any version conflicts won't link)
# - It's also important that we don't impose an android-activity backend by taking this choice away from applications.
## Enable the `native-activity` backend via Winit on Android
android-native-activity = [ "winit/android-native-activity" ]
## Enable the `game-activity` backend via Winit on Android
android-game-activity = [ "winit/android-game-activity" ]
[dependencies] [dependencies]
egui = { version = "0.21.0", path = "../egui", default-features = false, features = [ egui = { version = "0.21.0", path = "../egui", default-features = false, features = [
"tracing", "tracing",
@ -76,6 +86,3 @@ smithay-clipboard = { version = "0.6.3", optional = true }
[target.'cfg(not(target_os = "android"))'.dependencies] [target.'cfg(not(target_os = "android"))'.dependencies]
arboard = { version = "3.2", optional = true, default-features = false } arboard = { version = "3.2", optional = true, default-features = false }
[target.'cfg(target_os = "android")'.dependencies]
# TODO(emilk): this is probably not the right place for specifying native-activity, but we need to do it somewhere for the CI
android-activity = { version = "0.4", features = ["native-activity"] }

Loading…
Cancel
Save