Struct PetState 

pub struct PetState {
    pub enabled: bool,
    pub path: String,
    pub x: u16,
    pub y: u16,
    pub width_cells: u16,
    pub speed: u16,
    pub load_error: Option<String>,
    pub image_id: u32,
    /* private fields */
}

Fields

enabled: bool

path: String

x: u16

Cell column / row (top-left of image).

y: u16

width_cells: u16

Display width in terminal cells (height scales with aspect).

speed: u16

Playback speed percent (25..=400). 100 = native GIF timing.

load_error: Option<String>

image_id: u32

Kitty image id (stable so we replace rather than leak).

Implementations

impl PetState

pub fn new() -> Self

pub fn has_frames(&self) -> bool

pub fn frame_count(&self) -> usize

pub fn frame_idx(&self) -> usize

pub fn clamp_speed(s: u16) -> u16

Clamp speed to a sensible range.

pub fn load_path(&mut self, path: &str)

Load GIF (or static PNG) from disk.

pub fn invalidate_display_cache(&mut self)

Invalidate display cache (call when width_cells changes).

pub fn ensure_display_cache(&mut self, cell_px: u32)

Build / refresh pre-scaled + base64 frames for the Kitty paint path.

pub fn effective_delay(&self) -> Duration

Effective delay for the current frame after speed scaling.

pub fn tick(&mut self) -> bool

Advance animation clock; returns true if the visible frame changed. Uses catch-up so heavy frames don’t permanently lag.

pub fn current_frame(&self) -> Option<&PetFrame>

pub fn current_display(&self) -> Option<&PetDisplayFrame>

pub fn display_px(&self, cell_px: u32) -> (u32, u32)

Pixel size when fitting into width_cells × ~cell_px.

pub fn screen_xy(&self, screen_w: u16, screen_h: u16) -> (u16, u16)

Clamp for painting only — never mutates saved x/y.

Startup used to clamp into the default 80×24 before the first draw, permanently wiping a bottom-right config until the next Settings save.

pub fn speed_label(speed: u16) -> String

Human label for speed (e.g. 1.0×).

pub fn speed_slider(speed: u16, width: usize) -> String

ASCII slider for settings (10 segments).

Trait Implementations

impl Default for PetState

fn default() -> Self

Returns the “default value” for a type.