Enum OverlayKind 

#[non_exhaustive]
pub enum OverlayKind {
    Callout {
        text: String,
        region: Region,
        style: CalloutStyle,
        soft: bool,
    },
    Caption {
        text: String,
    },
    Spotlight {
        region: Region,
    },
    Hide {
        region: Region,
    },
    Zoom {
        region: Region,
    },
    FadeIn,
    FadeOut,
    PointerHighlight,
    Hotspot {
        region: Region,
        title: String,
        text: String,
        stop: bool,
    },
}

What an overlay does.

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.

Callout

A balloon with text, placed on the film.

Fields

text: String

What it says.

region: Region

Where it is.

style: CalloutStyle

How it looks.

soft: bool

It comes and goes gradually.

Caption

A line of text at the bottom, as subtitles.

Fields

text: String

What it says.

Spotlight

Darkens everything but this region.

Fields

region: Region

What stays lit.

Hide

Covers this region, for what the film should not show.

Fields

region: Region

What gets covered.

Zoom

Zooms into this region and back out, sliding between them.

Fields

region: Region

What fills the screen.

FadeIn

Comes in from black.

FadeOut

Goes out to black.

PointerHighlight

A soft circle follows the pointer, and clicks show bigger.

Hotspot

A spot that talks to whoever is watching.

Fields

region: Region

Where it is.

title: String

In a few words.

text: String

What to say.

stop: bool

The film waits here for a click on the spot.

Trait Implementations

impl Clone for OverlayKind

fn clone(&self) -> OverlayKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OverlayKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OverlayKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OverlayKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OverlayKind