[Merged by Bors] - android - fix issues other than the rendering

.github/workflows/validation-jobs.yml

@@ -52,17 +52,14 @@ jobs:
  target/
  key: ${{ runner.os }}-cargo-build-android-${{ hashFiles('**/Cargo.toml') }}
 
- - name: Uninstall android-31
- run: $ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager --uninstall "platforms;android-31"
-
  - name: Install Android targets
  run: rustup target add aarch64-linux-android armv7-linux-androideabi
 
  - name: Install Cargo APK
  run: cargo install --force cargo-apk
 
  - name: Build APK
- run: cargo apk build --example android
+ run: cargo apk build --example android_example
 
  run-examples-on-windows:
  runs-on: windows-latest

Cargo.toml

@@ -1467,19 +1467,22 @@ hidden = true
 # Android
 [[example]]
 crate-type = ["cdylib"]
-name = "android"
+name = "android_example"
 path = "examples/android/android.rs"
 
-[package.metadata.example.android]
+[package.metadata.example.android_example]
 hidden = true
 
 [package.metadata.android]
-apk_label = "Bevy Example"
+package = "org.bevyengine.example"
+apk_name = "bevyexample"
 assets = "assets"
 resources = "assets/android-res"
 build_targets = ["aarch64-linux-android", "armv7-linux-androideabi"]
-min_sdk_version = 16
-target_sdk_version = 29
+
+[package.metadata.android.sdk]
+target_sdk_version = 31
 
 [package.metadata.android.application]
 icon = "@mipmap/ic_launcher"
+label = "Bevy Example"

crates/bevy_derive/src/bevy_main.rs

@@ -10,19 +10,11 @@ pub fn bevy_main(_attr: TokenStream, item: TokenStream) -> TokenStream {
  );
 
  TokenStream::from(quote! {
- #[no_mangle]
+ // use ndk-glue macro to create an activity: https://github.com/rust-windowing/android-ndk-rs/tree/master/ndk-macro
  #[cfg(target_os = "android")]
- unsafe extern "C" fn ANativeActivity_onCreate(
- activity: *mut std::os::raw::c_void,
- saved_state: *mut std::os::raw::c_void,
- saved_state_size: usize,
- ) {
- bevy::ndk_glue::init(
- activity as _,
- saved_state as _,
- saved_state_size as _,
- main,
- );
+ #[cfg_attr(target_os = "android", bevy::ndk_glue::main(backtrace = "on", ndk_glue = "bevy::ndk_glue"))]
+ fn android_main() {
+ main()
  }
 
  #[no_mangle]

crates/bevy_winit/src/lib.rs

@@ -48,9 +48,13 @@ impl Plugin for WinitPlugin {
  #[cfg(target_arch = "wasm32")]
  app.add_plugin(web_resize::CanvasParentResizePlugin);
  let event_loop = EventLoop::new();
+ #[cfg(not(target_os = "android"))]
  let mut create_window_reader = WinitCreateWindowReader::default();
+ #[cfg(target_os = "android")]
+ let create_window_reader = WinitCreateWindowReader::default();
  // Note that we create a window here "early" because WASM/WebGL requires the window to exist prior to initializing
  // the renderer.
+ #[cfg(not(target_os = "android"))]
  handle_create_window_events(&mut app.world, &event_loop, &mut create_window_reader.0);
  app.insert_resource(create_window_reader)
  .insert_non_send_resource(event_loop);

examples/README.md

@@ -346,32 +346,47 @@ When using `NDK (Side by side)`, the environment variable `ANDROID_NDK_ROOT` mus
 To run on a device setup for Android development, run:
 
 ```sh
-cargo apk run --example android
+cargo apk run --example android_example
 ```
 
-:warning: At this time Bevy does not work in Android Emulator.
-
 When using Bevy as a library, the following fields must be added to `Cargo.toml`:
 
 ```toml
 [package.metadata.android]
 build_targets = ["aarch64-linux-android", "armv7-linux-androideabi"]
-target_sdk_version = 29
-min_sdk_version = 16
+
+[package.metadata.android.sdk]
+target_sdk_version = 31
 ```
 
 Please reference `cargo-apk` [README](https://crates.io/crates/cargo-apk) for other Android Manifest fields.
 
+### Debugging
+
+You can view the logs with the following command:
+
+```sh
+adb logcat | grep 'RustStdoutStderr\|bevy\|wgpu'
+```
+
+In case of an error getting a GPU or setting it up, you can try settings logs of `wgpu_hal` to `DEBUG` to get more informations.
+
+Sometimes, running the app complains about an unknown activity. This may be fixed by uninstalling the application:
+
+```sh
+adb uninstall org.bevyengine.example
+```
+
 ### Old phones
 
-Bevy by default targets Android API level 29 in its examples which is the <!-- markdown-link-check-disable -->
+Bevy by default targets Android API level 31 in its examples which is the <!-- markdown-link-check-disable -->
 [Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). <!-- markdown-link-check-enable -->
 Users of older phones may want to use an older API when testing.
 
 To use a different API, the following fields must be updated in Cargo.toml:
 
 ```toml
-[package.metadata.android]
+[package.metadata.android.sdk]
 target_sdk_version = >>API<<
 min_sdk_version = >>API or less<<
 ```

examples/README.md.tpl

@@ -98,32 +98,47 @@ When using `NDK (Side by side)`, the environment variable `ANDROID_NDK_ROOT` mus
 To run on a device setup for Android development, run:
 
 ```sh
-cargo apk run --example android
+cargo apk run --example android_example
 ```
 
-:warning: At this time Bevy does not work in Android Emulator.
-
 When using Bevy as a library, the following fields must be added to `Cargo.toml`:
 
 ```toml
 [package.metadata.android]
 build_targets = ["aarch64-linux-android", "armv7-linux-androideabi"]
-target_sdk_version = 29
-min_sdk_version = 16
+
+[package.metadata.android.sdk]
+target_sdk_version = 31
 ```
 
 Please reference `cargo-apk` [README](https://crates.io/crates/cargo-apk) for other Android Manifest fields.
 
+### Debugging
+
+You can view the logs with the following command:
+
+```sh
+adb logcat | grep 'RustStdoutStderr\|bevy\|wgpu'
+```
+
+In case of an error getting a GPU or setting it up, you can try settings logs of `wgpu_hal` to `DEBUG` to get more informations.
+
+Sometimes, running the app complains about an unknown activity. This may be fixed by uninstalling the application:
+
+```sh
+adb uninstall org.bevyengine.example
+```
+
 ### Old phones
 
-Bevy by default targets Android API level 29 in its examples which is the <!-- markdown-link-check-disable -->
+Bevy by default targets Android API level 31 in its examples which is the <!-- markdown-link-check-disable -->
 [Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). <!-- markdown-link-check-enable -->
 Users of older phones may want to use an older API when testing.
 
 To use a different API, the following fields must be updated in Cargo.toml:
 
 ```toml
-[package.metadata.android]
+[package.metadata.android.sdk]
 target_sdk_version = >>API<<
 min_sdk_version = >>API or less<<
 ```

examples/android/android.rs

@@ -1,9 +1,26 @@
-use bevy::prelude::*;
+use bevy::{
+ prelude::*,
+ render::{
+ render_resource::WgpuLimits,
+ settings::{WgpuSettings, WgpuSettingsPriority},
+ },
+};
 
 // the `bevy_main` proc_macro generates the required android boilerplate
 #[bevy_main]
 fn main() {
  App::new()
+ // This configures the app to use the most compatible rendering settings.
+ // They help with compatibilty with as many devices as possible.
+ .insert_resource(WgpuSettings {
+ priority: WgpuSettingsPriority::Compatibility,
+ limits: WgpuLimits {
+ // This allows for devices with bigger screens
+ max_texture_dimension_2d: 8192,
+ ..WgpuLimits::downlevel_defaults()
+ },
+ ..default()
+ })
  .add_plugins(DefaultPlugins)
  .add_startup_system(setup)
  .run();