Struct ndk::native_window::NativeWindow

pub struct NativeWindow { /* private fields */ }

It is the C counterpart of the android.view.Surface object in Java, and can be converted both ways. Depending on the consumer, images submitted to NativeWindow can be shown on the display or sent to other consumers, such as video encoders.

Implementations

impl NativeWindow

pub unsafe fn from_ptr(ptr: NonNull<ANativeWindow>) -> Self

Assumes ownership of ptr

Safety

ptr must be a valid pointer to an Android ffi::ANativeWindow.

pub unsafe fn clone_from_ptr(ptr: NonNull<ANativeWindow>) -> Self

Acquires ownership of ptr

Safety

ptr must be a valid pointer to an Android ffi::ANativeWindow.

pub fn ptr(&self) -> NonNull<ANativeWindow>

pub fn height(&self) -> i32

pub fn width(&self) -> i32

pub fn format(&self) -> HardwareBufferFormat

Return the current pixel format (HardwareBufferFormat) of the window surface.

pub fn set_buffers_geometry(
    &self,
    width: i32,
    height: i32,
    format: Option<HardwareBufferFormat>
) -> Result<()>

Change the format and size of the window buffers.

The width and height control the number of pixels in the buffers, not the dimensions of the window on screen. If these are different than the window’s physical size, then its buffer will be scaled to match that size when compositing it to the screen. The width and height must be either both zero or both non-zero.

For all of these parameters, if 0 or None is supplied then the window’s base value will come back in force.

pub unsafe fn from_surface(env: *mut JNIEnv, surface: jobject) -> Option<Self>

Return the NativeWindow associated with a JNI android.view.Surface pointer.

Safety

By calling this function, you assert that env is a valid pointer to a JNIEnv and surface is a valid pointer to an android.view.Surface.

pub unsafe fn to_surface(&self, env: *mut JNIEnv) -> jobject

Available on crate feature api-level-26 only.

Return a JNI android.view.Surface pointer derived from this NativeWindow.

Safety

By calling this function, you assert that env is a valid pointer to a JNIEnv.

Trait Implementations

impl Clone for NativeWindow

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NativeWindow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for NativeWindow

fn drop(&mut self)

Executes the destructor for this type.

impl HasRawWindowHandle for NativeWindow

fn raw_window_handle(&self) -> RawWindowHandle

impl Hash for NativeWindow

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for NativeWindow

fn cmp(&self, other: &NativeWindow) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<NativeWindow> for NativeWindow

fn eq(&self, other: &NativeWindow) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NativeWindow) -> bool

This method tests for !=.

impl PartialOrd<NativeWindow> for NativeWindow

fn partial_cmp(&self, other: &NativeWindow) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for NativeWindow

impl Send for NativeWindow

impl StructuralEq for NativeWindow

impl StructuralPartialEq for NativeWindow

impl Sync for NativeWindow