Struct android_activity::AndroidApp

source · [−]

pub struct AndroidApp { /* private fields */ }

Implementations

source

impl AndroidApp

source

pub fn native_window<'a>(&self) -> Option<NativeWindow>

Queries the current NativeWindow for the application.

This will only return Some(window) between MainEvent::InitWindow and MainEvent::TerminateWindow events.

source

pub fn poll_events<F>(&self, timeout: Option<Duration>, callback: F)where
F: FnMut(PollEvent<'_>),

Polls for any events associated with this AndroidApp and processes those events (such as lifecycle events) via the given callback.

It’s important to use this API for polling, and not call ALooper_pollAll directly since some events require pre- and post-processing either side of the callback. For correct behavior events should be handled immediately, before returning from the callback and not simply queued for batch processing later. For example the existing NativeWindow is accessible during a MainEvent::TerminateWindow callback and will be set to None once the callback returns, and this is also synchronized with the Java main thread. The MainEvent::SaveState event is also synchronized with the Java main thread.

source

pub fn create_waker(&self) -> AndroidAppWaker

Creates a means to wake up the main loop while it is blocked waiting for events within AndroidApp::poll_events().

source

pub fn config(&self) -> ConfigurationRef

Returns a (cheaply clonable) reference to this application’s ndk::configuration::Configuration

source

pub fn content_rect(&self) -> Rect

Queries the current content rectangle of the window; this is the area where the window’s content should be placed to be seen by the user.

source

pub fn asset_manager(&self) -> AssetManager

Queries the Asset Manager instance for the application.

Use this to access binary assets bundled inside your application’s .apk file.

source

pub fn set_window_flags(
    &self,
    add_flags: WindowManagerFlags,
    remove_flags: WindowManagerFlags
)

Change the window flags of the given activity.

Note that some flags must be set before the window decoration is created, see <https://developer.android.com/reference/android/view/Window#setFlags(int,%20int)>.

source

pub fn enable_motion_axis(&self, axis: Axis)

Enable additional input axis

To reduce overhead, by default only input::Axis::X and input::Axis::Y are enabled and other axis should be enabled explicitly.

source

pub fn disable_motion_axis(&self, axis: Axis)

Disable input axis

To reduce overhead, by default only input::Axis::X and input::Axis::Y are enabled and other axis should be enabled explicitly.

source

pub fn show_soft_input(&self, show_implicit: bool)

Explicitly request that the current input method’s soft input area be shown to the user, if needed.

Call this if the user interacts with your view in such a way that they have expressed they would like to start performing input into it.

source

pub fn hide_soft_input(&self, hide_implicit_only: bool)

Request to hide the soft input window from the context of the window that is currently accepting input.

This should be called as a result of the user doing some action that fairly explicitly requests to have the input window hidden.

source

pub fn input_events<'b, F>(&self, callback: F)where
F: FnMut(&InputEvent) -> InputStatus,

Query and process all out-standing input event

callback should return InputStatus::Unhandled for any input events that aren’t directly handled by the application, or else InputStatus::Handled. Unhandled events may lead to a fallback interpretation of the event.

Applications are generally either expected to call this in-sync with their rendering or in response to a MainEvent::InputAvailable event being delivered. Note though that your application is will only be delivered a single MainEvent::InputAvailable event between calls to this API.

To reduce overhead, by default only input::Axis::X and input::Axis::Y are enabled and other axis should be enabled explicitly via Self::enable_motion_axis.

source