Struct AcquiredFrameHandle 

pub struct AcquiredFrameHandle { /* private fields */ }

Owns one native handle.

A rendered frame that the caller holds to read or show.

See mln_acquired_frame in the C API reference.

Implementations

impl AcquiredFrameHandle

pub fn id(&self) -> u64

Returns the native handle value.

impl AcquiredFrameHandle

pub fn discard(self) -> Result<(), ReleaseError<Self>>

Gives up an acquired frame without saying when your GPU stops reading it.

Because your GPU may still read the frame’s texture, the session never renders into that texture again.

See mln_acquired_frame_discard in the C API reference.

pub fn get_result(&self) -> Result<RenderFrameResult>

Reads the frame result of an acquired frame.

It succeeds until you release or discard the frame, whatever the session’s state.

See mln_acquired_frame_get_result in the C API reference.

pub unsafe fn release( self, consumer_completion: &GpuSync, ) -> Result<(), ReleaseError<Self>>

Gives an acquired frame back to the session once you’re done reading it.

consumer_completion says when your GPU work that reads the texture finishes. Pass GpuSyncKind::CpuComplete when that work has already finished. The session waits for that point before it renders into the texture again. If that wait fails, such as for an OpenGL fence outside the session’s share group, the session fails.

See mln_acquired_frame_release in the C API reference.

Errors

• Status::Unsupported when RenderSessionCapabilities::consumer_sync_kinds lacks the kind of consumer_completion.

Safety

Native graphics objects must have the types, lifetimes, and synchronization required by the C operation.

impl AcquiredFrameHandle

pub fn view(&self) -> Result<AcquiredFrameView<'_>>

Keeps an acquired frame’s texture and sync objects in place while you use them.

See mln_acquired_frame_view_begin in the C API reference.

Errors

• Status::TargetLost when the session failed, or you detached, abandoned, or disposed it.

Trait Implementations

impl Debug for AcquiredFrameHandle

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

Formats the value using the given formatter.