Skip to main content

AImageFrame

Struct AImageFrame 

Source
pub struct AImageFrame { /* private fields */ }
Available on Android only.
Expand description

AImage* with extracted AHB + per-frame metadata.

Implementations§

Source§

impl AImageFrame

Source

pub unsafe fn try_from_raw( image: *mut c_void, hardware: *mut c_void, timestamp_ns: i64, crop: Option<(i32, i32, i32, i32)>, format: PixelFormat, color: Option<ColorMetadata>, keep_alive: Option<KeepAlive>, ) -> Result<Self, InvalidHandleError>

Wrap an AImage* together with the AHardwareBuffer* extracted from it. Borrowing: the handle is stored non-owningly, this type has no Drop, and every obligation below extends to each Clone.

§Safety
  • image must point to a live AImage that has not been AImage_deleted, and hardware to the AHardwareBuffer* obtained from that AImage via AImage_getHardwareBuffer. Both nulls are rejected as InvalidHandleError::NullPointer and are not caller obligations.
  • AImage_getHardwareBuffer returns a borrowed pointer. The returned buffer’s reference belongs to the AImage and is invalidated by AImage_delete. Neither pointer is retained here and there is no Drop, so keep_alive must hold whatever keeps the AImage — and therefore the buffer — alive for the lifetime of this value and every Clone of it. With keep_alive == None the caller carries that directly. Releasing the image while a clone survives is a use-after-free in the importer.
  • crop, when Some, must be (left, top, right, bottom) from AImage_getCropRect and must lie inside the buffer’s dimensions; consumers sample only that rectangle.
  • format must be the buffer’s real layout and timestamp_ns the value from AImage_getTimestamp.
  • color, when Some, overrides the AHB driver’s suggested YCbCr model on the compute-unpack path (see the field docs above). It must be the stream’s true matrix and range: a wrong value is not unsound, but it silently decodes with the wrong matrix, which is exactly the failure it exists to prevent.
  • No thread affinity for the handle itself; the usual acquire-fence discipline still applies before reading the buffer’s pixels.
Source

pub fn image(&self) -> *mut c_void

Source

pub fn hardware(&self) -> *mut c_void

Source

pub fn timestamp_ns(&self) -> i64

Source

pub fn crop(&self) -> Option<(i32, i32, i32, i32)>

Source

pub fn format(&self) -> PixelFormat

Source

pub fn color(&self) -> Option<ColorMetadata>

Caller-known color metadata, when the producer signalled it. See the field docs — authoritative over the AHB driver’s suggested YCbCr model on the compute-unpack path.

Source

pub fn keep_alive(&self) -> Option<&KeepAlive>

Trait Implementations§

Source§

impl Clone for AImageFrame

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AImageFrame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Send for AImageFrame

Source§

impl Sync for AImageFrame

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,