Skip to main content

ResolvedSurfaceMode

Enum ResolvedSurfaceMode 

Source
pub enum ResolvedSurfaceMode {
    Unknown,
    Opaque,
    Translucent,
    RefusedTranslucent,
}
Expand description

App-facing resolved surface mode — the read-only outward half of the Mode B seam whose setter is deliberately absent (see the comment above): what the platform actually gave this process, not what the host asked for.

resolved_surface_mode answers ResolvedSurfaceMode::Unknown until a shell publishes (no surface yet, or the desktop preview, which has no Mode B host seam), then Opaque/Translucent — or ResolvedSurfaceMode::RefusedTranslucent, the case this exists for: the host declared Mode B and the platform resolved the surface opaque anyway (no matching CompositeAlphaMode; see docs/NATIVE_WIDGETS_ARCHITECTURE.md’s Mode-B paragraph). frust’s paint side degrades to the Mode A contract on its own, but the host’s native-sibling z-order was fixed at build time, so a sibling arranged behind the surface is invisible and untappable. Branch on ResolvedSurfaceMode::translucency_refused to render a deliberate fallback instead of a dead rect.

This is a poll, not a subscription — the same contract as set_app_theme’s slot: reading it subscribes to nothing and a change never wakes a frame by itself. Read it during a rebuild (or paint/an event handler) on the UI thread, exactly where you’d read any other process-global shell state, and if the answer must change your UI’s shape, write it into your own state so the normal dirty path runs.

use frust::{ResolvedSurfaceMode, resolved_surface_mode};

// A native-widget slot deciding whether its platform sibling can actually
// be seen this frame.
let native_sibling_visible = match resolved_surface_mode() {
    ResolvedSurfaceMode::RefusedTranslucent => false,
    ResolvedSurfaceMode::Unknown
    | ResolvedSurfaceMode::Opaque
    | ResolvedSurfaceMode::Translucent => true,
};

What the platform actually gave us, as opposed to what the host declared (SurfaceMode) — see the module docs’ The RESOLVED slot.

Read via resolved_surface_mode (re-exported by the frust facade); published only by the two mobile shells, once per frame, from the same value that drives RenderRoot::set_surface_translucent.

Variants§

§

Unknown

No shell has published a resolution yet: no surface exists, or the running shell doesn’t participate (the desktop preview shell never publishes — it has no Mode B host seam). Not a synonym for Opaque: app code that must distinguish “opaque” from “don’t know yet” (e.g. deferring a fallback decision to the next frame) can.

§

Opaque

The live surface came up opaque, and that is what the host asked for — the ordinary Mode A contract every pre-platform-views app runs under.

§

Translucent

The live surface came up translucent: frust clears to a transparent base and platform_view punches its slot rects (Mode B).

§

RefusedTranslucent

The refusal (translucencyRefused): the host declared Mode B, and the platform resolved the surface opaque anyway — no matching CompositeAlphaMode (the engine’s premultiplied output has no other refusal case; see docs/NATIVE_WIDGETS_ARCHITECTURE.md’s Mode-B paragraph).

frust’s own paint side degrades correctly (opaque clear, no hole punch), but the host’s native-sibling z-order was fixed at build time: a sibling arranged behind the now-opaque surface is invisible and untappable. That is what this variant exists to tell app/plugin code — so it can render its own fallback content instead of a dead rect.

Implementations§

Source§

impl ResolvedSurfaceMode

Source

pub const fn resolve( declared: SurfaceMode, resolved_translucent: bool, ) -> ResolvedSurfaceMode

The pure mapping publish_resolved_surface_mode applies, split out so it is testable without touching the process-global slots: a resolved translucent surface is Translucent; a resolved opaque one is RefusedTranslucent when the host declared translucency and Opaque when it didn’t.

Never returns Unknown — that variant means “nobody published”, which is the slot’s initial state, not a resolution.

Source

pub const fn translucency_refused(self) -> bool

true only for RefusedTranslucent — the one-liner a native-widget fallback branches on (if frust::resolved_surface_mode().translucency_refused() { ... }).

Source

pub const fn is_translucent(self) -> bool

true only for Translucent, i.e. the frames being painted right now really do follow the Mode B contract. Both refusal and plain opacity answer false; so does Unknown, since no surface has reported in.

Trait Implementations§

Source§

impl Clone for ResolvedSurfaceMode

Source§

fn clone(&self) -> ResolvedSurfaceMode

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 Copy for ResolvedSurfaceMode

Source§

impl Debug for ResolvedSurfaceMode

Source§

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

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

impl Default for ResolvedSurfaceMode

Source§

fn default() -> ResolvedSurfaceMode

Returns the “default value” for a type. Read more
Source§

impl Eq for ResolvedSurfaceMode

Source§

impl PartialEq for ResolvedSurfaceMode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ResolvedSurfaceMode

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> Brush for T
where T: Clone + PartialEq + Default + Debug,

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> 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> DowncastSync for T
where T: Any + Send + Sync,

Source§

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

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

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

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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,

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