Struct OverlayConfig 

pub struct OverlayConfig {
    pub position: OverlayPosition,
    pub font_size: FontSize,
    pub fg_color: Rgba,
    pub bg_color: Rgba,
    pub margin: u32,
    pub show_df_indicator: bool,
    pub show_background: bool,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
    pub show_field_indicator: bool,
    pub current_field: u8,
}

Configuration for the timecode overlay.

Fields

position: OverlayPosition

Position of the overlay on screen.

font_size: FontSize

Font size.

fg_color: Rgba

Foreground (text) colour.

bg_color: Rgba

Background box colour (set alpha to 0 for no background).

margin: u32

Margin in pixels from the edge of the frame.

show_df_indicator: bool

Whether to show a drop-frame indicator (red dot or “DF” suffix).

show_background: bool

Whether to render a background box behind the text.

prefix: Option<String>

Optional prefix text (e.g., reel name or “REC”).

suffix: Option<String>

Optional suffix text (e.g., scene/take number).

show_field_indicator: bool

Whether to show field indicator (F1/F2) for interlaced content.

current_field: u8

Current field (1 or 2) when show_field_indicator is true.

Implementations

impl OverlayConfig

pub fn monitoring() -> Self

Create a config for monitoring (small, bottom-left, semi-transparent BG).

pub fn burn_in() -> Self

Create a config for burn-in (large, top-center, opaque BG).

pub fn no_background() -> Self

Create a config with no background box.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Set a prefix string.

pub fn with_suffix(self, suffix: impl Into<String>) -> Self

Set a suffix string.

pub fn with_field(self, field: u8) -> Self

Enable field indicator display.

Trait Implementations

impl Clone for OverlayConfig

fn clone(&self) -> OverlayConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayConfig

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

Formats the value using the given formatter.

impl Default for OverlayConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OverlayConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OverlayConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.