Struct FrameCaptureHook

Source
pub struct FrameCaptureHook { /* private fields */ }
Expand description

Thread-safe hook to request a one-shot capture on the next redraw.

Recommendation: for apps built with ailloli_ui::App, prefer CaptureHandle and AppBuilder::capture(...) (per logical window or view key, structured results). This hook suits low-level integrations that already own a ailloli_ui_render_wgpu::Renderer and call FrameCaptureHook::capture_if_requested from their own RedrawRequested loop.

Intended usage:

Multiple requests made before consumption coalesce into one capture. The release/acquire atomic flag is safe to share across threads.

§Examples

let hook = ailloli_ui_winit::FrameCaptureHook::default();
assert!(!hook.is_requested());
hook.request_frame_capture_once();
assert!(hook.is_requested());

Implementations§

Source§

impl FrameCaptureHook

Request-latch observation and capture consumption.

Source

pub fn request_frame_capture_once(&self)

Latches a capture request for the next redraw.

Repeated calls before capture coalesce and do not count separately.

§Examples
let hook = ailloli_ui_winit::FrameCaptureHook::default();
hook.request_frame_capture_once();
hook.request_frame_capture_once();
assert!(hook.is_requested());
Source

pub fn is_requested(&self) -> bool

Observes the request latch without consuming it.

§Examples
let hook = ailloli_ui_winit::FrameCaptureHook::default();
assert!(!hook.is_requested());
Source

pub fn capture_if_requested( &self, renderer: &mut Renderer, clear: Color, layers: &[LayerPass<'_>], params: CaptureParams, ) -> Result<Option<FrameCaptureResult>, RendererError>

If a capture was requested, consumes the request and captures the frame.

Returns Ok(None) without touching the renderer when no request is pending. The latch is cleared before rendering, so a render failure is still a consumed request and a concurrent new request remains pending.

§Errors

Propagates the renderer capture failure.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_render_wgpu::{CaptureParams, LayerPass, Renderer};
fn capture(hook: &ailloli_ui_winit::FrameCaptureHook, renderer: &mut Renderer) {
    let layers: [LayerPass<'_>; 0] = [];
    let result: Option<ailloli_ui_winit::FrameCaptureResult> = hook
        .capture_if_requested(renderer, Color::BLACK, &layers, CaptureParams::default())
        .unwrap();
    let _ = result;
}
Source

pub fn capture_single_layer_if_requested( &self, renderer: &mut Renderer, clear: Color, cmds: &[DrawCmd], params: CaptureParams, ) -> Result<Option<FrameCaptureResult>, RendererError>

Convenience helper for the common single-layer path (no clipping).

It wraps cmds in one [LayerPass] and otherwise has the same latch, error, and consumption semantics as Self::capture_if_requested.

§Errors

Propagates the renderer capture failure.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_render_wgpu::{CaptureParams, Renderer};
fn capture(hook: &ailloli_ui_winit::FrameCaptureHook, renderer: &mut Renderer) {
    let result = hook.capture_single_layer_if_requested(
        renderer, Color::BLACK, &[], CaptureParams::default()).unwrap();
    let _: Option<ailloli_ui_winit::FrameCaptureResult> = result;
}

Trait Implementations§

Source§

impl Clone for FrameCaptureHook

Source§

fn clone(&self) -> FrameCaptureHook

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FrameCaptureHook

Source§

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

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

impl Default for FrameCaptureHook

Creates a hook with no pending request.

Source§

fn default() -> Self

Allocates the shared atomic request flag, initially false.

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<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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

§

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

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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