Struct NativeHandle 

pub struct NativeHandle { /* private fields */ }

An opaque platform GPU buffer a NativeImporter turns into a texture.

The bus never dereferences the pointer; only the importer installed for its kind does. The frame’s producer owns the buffer’s lifetime and drops its own reference in the frame’s release callback.

The fields are private and the only constructor is the unsafe Self::new: an importer dereferences the pointer on that constructor’s contract alone, so safe code cannot hand the bus a forged one.

A handle is move-only — neither Clone nor Copy — so it cannot be copied, and a frame’s payload and release callback are private to the frame: outside unsafe, a handle cannot leave the frame that carries its release (see SourceFrame::into_parts).

Implementations

impl NativeHandle

pub unsafe fn new(kind: NativeHandleKind, ptr: *mut c_void) -> NativeHandle

Wraps ptr, a platform object of kind, for a SourcePayload::Native frame.

Safety

ptr is a live platform object of exactly kind — a CVPixelBufferRef for NativeHandleKind::CvPixelBuffer, an AHardwareBuffer* for NativeHandleKind::AHardwareBuffer — on which the producer holds a retained reference of its own (CFRetain, AHardwareBuffer_acquire), kept until the release callback of the one frame this handle is placed in has run (the handle is move-only, so it cannot be copied, and outside unsafe it cannot leave that frame without the callback). The NativeImporter installed for kind dereferences the pointer (describes, imports and retains the object) on this promise alone, so a dangling, foreign or mistyped pointer is undefined behaviour there. A bridge from the plugin substrate’s own handle forwards that handle’s identical contract.

pub fn kind(&self) -> NativeHandleKind

The platform object Self::ptr points at.

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

The platform object itself, as handed to Self::new. Only the handle is move-only: an address copied out of it carries no lifetime guarantee past the frame’s release, and using it needs the caller’s own unsafe.

Trait Implementations

impl Debug for NativeHandle

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

Formats the value using the given formatter.

impl Eq for NativeHandle

impl PartialEq for NativeHandle

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

Equality operator ==.

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

Inequality operator !=.

impl Send for NativeHandle

impl StructuralPartialEq for NativeHandle