Skip to main content

Embedded

Struct Embedded 

Source
pub struct Embedded<A: App> { /* private fields */ }
Expand description

A fenestra app embedded in a caller-owned wgpu world. See the module docs for the contract.

Implementations§

Source§

impl<A: App> Embedded<A>
where A::Msg: Send,

Source

pub fn new( app: A, theme: Theme, device: &Device, target_format: TextureFormat, ) -> Self

Builds the renderer on your device. target_format is the format of the views you will pass to Self::render (usually your surface format).

§Panics

If vello’s shaders fail to compile on the device.

Source

pub fn set_clear(&mut self, color: Color)

The base color behind the UI. Defaults to the theme background; set Color::TRANSPARENT to composite over your own scene.

Source

pub fn set_theme(&mut self, theme: Theme)

Replaces the theme (e.g. a light/dark toggle driven by your app).

Source

pub fn app(&self) -> &A

The app under the UI.

Source

pub fn app_mut(&mut self) -> &mut A

Mutable app access (the next Self::render rebuilds).

Source

pub fn pump(&mut self) -> bool

Drains proxied messages (from App::init / threads) into the app. Returns whether anything was applied — repaint if so.

Source

pub fn input(&mut self, event: InputEvent) -> EventResponse

Routes one raw input event into the UI. Prefer Self::handle_window_event in winit apps; this is the window-system-agnostic form (and what tests drive).

Source

pub fn handle_window_event( &mut self, window: &Window, event: &WindowEvent, ) -> EventResponse

Translates and routes one winit event (cursor, buttons, wheel, keyboard with the printable/shortcut split, IME commit/preedit, modifiers) — the same mapping the built-in runner uses.

Source

pub fn animating(&self) -> bool

Whether the last built frame is still animating (keep rendering).

Source

pub fn render( &mut self, device: &Device, queue: &Queue, target: &TextureView, physical: (u32, u32), scale: f64, )

Builds the current frame and composites it onto target with premultiplied-alpha blending. physical is the target size in physical pixels; scale the DPI factor (logical = physical / scale). Call after your own passes each frame.

§Panics

If vello fails to render (device loss).

Source

pub fn frame(&self) -> Option<&Frame>

The last built frame (after Self::render) — semantic queries and inspector dumps work on it like anywhere else.

Source

pub fn texture_view(&self) -> Option<&TextureView>

The internal premultiplied-alpha texture view from the last Self::render — sample it in your own pipeline for custom compositing instead of the built-in blit.

Auto Trait Implementations§

§

impl<A> !Freeze for Embedded<A>

§

impl<A> !RefUnwindSafe for Embedded<A>

§

impl<A> !Send for Embedded<A>

§

impl<A> !Sync for Embedded<A>

§

impl<A> !UnwindSafe for Embedded<A>

§

impl<A> Unpin for Embedded<A>
where A: Unpin, <A as App>::Msg: Unpin,

§

impl<A> UnsafeUnpin for Embedded<A>
where A: UnsafeUnpin, <A as App>::Msg: UnsafeUnpin,

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> Downcast for T
where T: Any,

Source§

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

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

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

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

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

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

impl<T> Upcast<T> for T

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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