Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jinleili/wgpu-in-app

Integrate wgpu into existing iOS | Android apps.
https://github.com/jinleili/wgpu-in-app

android-app cargo-plugin ios-app rust visionos webgpu wgpu wgpu-step-by-step wgpu-tutorial xros

Last synced: 7 days ago
JSON representation

Integrate wgpu into existing iOS | Android apps.

Host: GitHub
URL: https://github.com/jinleili/wgpu-in-app
Owner: jinleili
License: mit
Created: 2021-09-10T06:33:42.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-11-23T07:09:36.000Z (20 days ago)
Last Synced: 2024-11-23T08:18:30.244Z (20 days ago)
Topics: android-app, cargo-plugin, ios-app, rust, visionos, webgpu, wgpu, wgpu-step-by-step, wgpu-tutorial, xros
Language: Rust
Homepage:
Size: 22.5 MB
Stars: 289
Watchers: 8
Forks: 25
Open Issues: 3
Metadata Files:
- Readme: README.MD
- License: LICENSE.MIT

Awesome Lists containing this project

awesome-visionos - WGSL running in visionOS
Awesome-Vision-Pro - WGSL running in visionOS

README

# wgpu in App

![Minimum Rust Version](https://img.shields.io/badge/min%20rust-1.76-green.svg)
[![Build Status](https://github.com/jinleili/wgpu-in-app/workflows/CI/badge.svg?branch=master)](https://github.com/jinleili/wgpu-in-app/actions)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jinleili/wgpu-in-app/blob/master/LICENSE.MIT)

Integrate wgpu into your existing iOS | Android apps.

wgpu does not depend on any window program, so it does not provide window creation and management functions. Only when creating a window-based `Surface`, an argument that implements the [raw-window-handle](https://github.com/rust-windowing/raw-window-handle) abstract interface may be needed (_may be needed_ because on iOS/macOS, instance of `Surface` can be created directly by `CAMetalLayer`). The `winit` used by the wgpu examples is a cross-platform window creation and management crate that implements the raw-window-handle abstract interface. It will take over the window management and events loop of the entire app, there is no doubt that for game apps, the combination of wgpu + winit is very suitable.

However, a large number of non-game apps also need to use graphics APIs (such as charts, image filters, etc.). These apps may require a large number of system components, as well as the ability to freely control various input devices (e.g., stylus, motion sensors). So, it would be very useful to integrate wgpu into these apps without using third-party window management libraries.

#### [中文版文档](https://jinleili.github.io/learn-wgpu-zh/integration-and-debugging/)

## Screenshot

| ![wgpu in iOS](screenshot/on_ios.png) | ![wgpu in Android](screenshot/on_android.png) |
| ------------------------------------- | --------------------------------------------- |

https://github.com/jinleili/wgpu-in-app/assets/1001342/9209b81b-f336-4322-986e-70dd9bb155c3

## **iOS | iPadOS | visionOS**

### Add target

```sh
# Add Apple device (iOS | iPadOS | visionOS) target
# Since iPhone 5 and later are all 64-bit devices, `armv7s-apple-ios` and `armv7-apple-ios` are not required.
rustup target add aarch64-apple-ios

# Add Apple Simulator target
# M1+ Mac
rustup target add aarch64-apple-ios-sim
```

### Build for Apple real device

```sh
# Build for iOS | iPadOS
sh ./apple_lib_build.sh --release
```

Then, Open `Apple/wgpu_in_App.xcodeproj` with Xcode and run on iPhone、iPad.

### Build for visionOS Simulator

```sh
sh ./apple_lib_build.sh aarch64-apple-ios-sim --release
```

Then, Open `Apple/wgpu_in_App.xcodeproj` with Xcode 15 Beta 2+ and run on visionOS Simulator.

### About Rust and Swift Interaction

[Passing Primitive Data Between Rust and iOS](https://bignerdranch.com/blog/building-an-ios-app-in-rust-part-2-passing-primitive-data-between-rust-and-ios/)

[Passing Owned Objects between Rust and iOS](https://bignerdranch.com/blog/building-an-ios-app-in-rust-part-3-passing-owned-objects-between-rust-and-ios/)

[Sending a boxed trait over FFI](https://users.rust-lang.org/t/sending-a-boxed-trait-over-ffi/21708)

## **Android**

### Set up Android environment

Assuming your computer already has Android Studio installed, go to `Android Studio` > `Tools` > `SDK Manager` > `Android SDK` > `SDK Tools`. Check the following options for installation and click OK.

- [x] Android SDK Build-Tools
- [x] Android SDK Command-line Tools
- [x] NDK(Side by side)

Then, set two following environment variables:

```sh
export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk
# Replace the NDK version number with the version you installed
export NDK_HOME=$ANDROID_SDK_ROOT/ndk/23.1.7779620
```

### Install cargo so subcommand

```sh
# from crates.io
cargo install cargo-so
# frome source code
cargo install --path cargo-so
```

### Build

```sh
# Add build targets
# Since simulator and virtual devices only support GLES, `x86_64-linux-android` and `i686-linux-android` targets are not necessary
rustup target add aarch64-linux-android armv7-linux-androideabi

# Build
sh ./android_lib_build.sh --release
```

## **Desktop**

```sh
# Use primary backend (metal vulkan or dx12, depend on your computer OS).
cargo run
# Use OpenGL backend (platforms other than Linux, need to add the `angle` feature).
# https://github.com/gfx-rs/wgpu/pull/2461
WGPU_BACKEND=gl cargo run --features=angle
# Use Vulkan backend (on macOS, need to add the `vulkan-portability` feature)
# https://github.com/gfx-rs/wgpu/pull/2488
WGPU_BACKEND=vk cargo run --features=vulkan-portability
# Then, press 0, 1, 2, 3, 4 keys change running example.
```