raw_window_handle/
android.rs

1use core::ffi::c_void;
2use core::ptr::NonNull;
3
4use super::DisplayHandle;
5
6/// Raw display handle for Android.
7#[non_exhaustive]
8#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
9pub struct AndroidDisplayHandle {}
10
11impl AndroidDisplayHandle {
12    /// Create a new empty display handle.
13    ///
14    ///
15    /// # Example
16    ///
17    /// ```
18    /// # use raw_window_handle::AndroidDisplayHandle;
19    /// let handle = AndroidDisplayHandle::new();
20    /// ```
21    pub fn new() -> Self {
22        Self {}
23    }
24}
25
26impl DisplayHandle<'static> {
27    /// Create an Android-based display handle.
28    ///
29    /// As no data is borrowed by this handle, it is completely safe to create. This function
30    /// may be useful to windowing framework implementations that want to avoid unsafe code.
31    ///
32    /// # Example
33    ///
34    /// ```
35    /// # use raw_window_handle::{DisplayHandle, HasDisplayHandle};
36    /// # fn do_something(rwh: impl HasDisplayHandle) { let _ = rwh; }
37    /// let handle = DisplayHandle::android();
38    /// do_something(handle);
39    /// ```
40    pub fn android() -> Self {
41        // SAFETY: No data is borrowed.
42        unsafe { Self::borrow_raw(AndroidDisplayHandle::new().into()) }
43    }
44}
45
46/// Raw window handle for Android NDK.
47#[non_exhaustive]
48#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
49pub struct AndroidNdkWindowHandle {
50    /// A pointer to an `ANativeWindow`.
51    pub a_native_window: NonNull<c_void>,
52}
53
54impl AndroidNdkWindowHandle {
55    /// Create a new handle to an `ANativeWindow`.
56    ///
57    ///
58    /// # Example
59    ///
60    /// ```
61    /// # use core::ptr::NonNull;
62    /// # use raw_window_handle::AndroidNdkWindowHandle;
63    /// # type ANativeWindow = ();
64    /// #
65    /// let ptr: NonNull<ANativeWindow>;
66    /// # ptr = NonNull::from(&());
67    /// let handle = AndroidNdkWindowHandle::new(ptr.cast());
68    /// ```
69    pub fn new(a_native_window: NonNull<c_void>) -> Self {
70        Self { a_native_window }
71    }
72}
raw_window_handle/android.rs

raw_window_handle/
android.rs
