Struct BackgroundConfig 

pub struct BackgroundConfig {
    pub transparency_affects_only_default_background: bool,
    pub keep_text_opaque: bool,
    pub background_image: Option<String>,
    pub background_image_enabled: bool,
    pub background_image_mode: BackgroundImageMode,
    pub background_image_opacity: f32,
}

Background image source and how window transparency applies to cells and text.

Fields

transparency_affects_only_default_background: bool

When true, only the default terminal background is transparent. Colored backgrounds (syntax highlighting, status bars, etc.) remain opaque. This keeps text readable while allowing window transparency.

keep_text_opaque: bool

When true, text is always rendered at full opacity regardless of window transparency. This ensures text remains crisp and readable even with transparent backgrounds.

background_image: Option<String>

Background image path (optional, supports ~ for home directory)

background_image_enabled: bool

Enable or disable background image rendering (even if a path is set)

background_image_mode: BackgroundImageMode

Background image display mode

• fit: Scale to fit window while maintaining aspect ratio
• fill: Scale to fill window while maintaining aspect ratio (may crop)
• stretch: Stretch to fill window, ignoring aspect ratio (default)
• tile: Repeat image in a tiled pattern
• center: Center image at original size

background_image_opacity: f32

Background image opacity (0.0 = fully transparent, 1.0 = fully opaque)

Trait Implementations

impl Clone for BackgroundConfig

fn clone(&self) -> BackgroundConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackgroundConfig

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

Formats the value using the given formatter.

impl Default for BackgroundConfig

fn default() -> BackgroundConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BackgroundConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<BackgroundConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BackgroundConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.