Enum OverlayError 

#[non_exhaustive]
pub enum OverlayError {
    NoDevice,
    Surface(String),
    UnsupportedSurface,
    NoTranslucentMode,
    StraightAlpha,
    Engine(EngineError),
}

Why an overlay could not be created or could not draw a frame.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoDevice

The context has no device yet: an overlay shares the main surface’s device, so it is created after the main surface.

Surface(String)

The platform object could not be turned into a surface, or the surface could not be configured.

UnsupportedSurface

The main surface’s adapter cannot present to this surface. Refused rather than answered with a second device: the overlay must share the main frame’s device.

NoTranslucentMode

The platform granted no translucent composite mode — an opaque overlay would cover everything under it.

StraightAlpha

The compositor reads the overlay’s alpha straight, which the spike does not serve (no un-premultiplying pass).

Engine(EngineError)

The overlay’s engine renderer could not be built or refused the frame.

Trait Implementations

impl Debug for OverlayError

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

Formats the value using the given formatter.

impl Display for OverlayError

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

Formats the value using the given formatter.

impl Error for OverlayError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.