Need help with android-ndk-rs?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

rust-windowing
357 Stars 51 Forks Other 158 Commits 23 Opened issues

Description

Rust bindings to the Android NDK

Services available

!
?

Need anything else?

Contributors list

Rust on Android

Rust MIT license APACHE2 license

Libraries and tools for Rust programming on Android targets:

Name

Description Badges

ndk-sys
| Raw FFI bindings to the NDK | crates.io crates.io
ndk
| Safe abstraction of the bindings | crates.io crates.io
ndk-glue
| Startup code | crates.io crates.io
ndk-build
| Everything for building apk's | crates.io crates.io
cargo-apk
| Build tool | crates.io crates.io

See

ndk-examples
for examples using the NDK and the README files of the crates for more details.

Supported NDK versions

android-ndk-rs
aims to support at least the
LTS
and
Rolling Release
branches of the NDK, as described on their wiki. Additionally the
Beta Release
might be supported to prepare for an upcoming release.

As of writing (2021-07-24) the following NDKs are tested:

Branch

Version Status Working
r18 18.1.5063045 Deprecated :x:
r19 19.2.5345600 Deprecated :heavycheckmark:
r20 20.1.5948944 Deprecated :heavycheckmark:
r21 21.4.7075529 LTS :heavycheckmark:
r22 22.1.7171670 Rolling Release :heavycheckmark:
r23 beta 1/2 Beta :heavycheckmark:
r23 beta 3 and beyond Beta :x: Breaking on #149 :x:

Hello world

Quick start for setting up a new project with support for Android. For communication with the Android framework in our native Rust application we require a

NativeActivity
.
ndk-glue
will do the necessary initialization when calling
main
but requires a few adjustments:

Cargo.toml
toml
[lib]
crate-type = ["lib", "cdylib"]

Wraps

main
function using attribute macro
ndk::glue::main
:

src/lib.rs
```rust

[cfgattr(targetos = "android", ndk_glue::main(backtrace = "on"))]

pub fn main() { println!("hello world"); } ```

src/main.rs
rust
fn main() {
    $crate::main();
}

Install

cargo apk
for building, running and debugging your application:
sh
cargo install cargo-apk

We can now directly execute our

Hello World
application on a real connected device or an emulator:
sh
cargo apk run

Logging and stdout

Stdout is redirected to the android log api when using

ndk-glue
. Any logger that logs to stdout, like
println!
, should therefore work.

Use can filter the output in logcat

adb logcat RustStdoutStderr:D *:S

Android logger

Android logger can be setup using feature "logger" and attribute macro like so:

src/lib.rs
```rust

[cfgattr(targetos = "android", ndk_glue::main(logger(level = "debug", tag = "my-tag")))]

pub fn main() { log!("hello world"); } ```

Overriding crate paths

The macro

ndk_glue::main
tries to determine crate names from current Cargo.toml. In cases when it is not possible the default crate names will be used. You can override this names with specific paths like so: ```rust

[ndk_glue::main(

ndkglue = "path::to::ndkglue", )] fn main() {} ```

JNI

Java Native Interface (JNI) allows executing Java code in a VM from native applications.

ndk-examples
contains an
jni_audio
example which will print out all output audio devices in the log.
  • jni
    , JNI bindings for Rust

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.