Merge pull request #16 from ckaznable/fps

feat: add `--show-fps` flags

Author: ckaznable

README.md

@@ -45,6 +45,7 @@ Usage: tenki [OPTIONS]
 Options:
       --mode <MODE>    [default: rain] [rain, snow]
       --fps <FPS>      [default: 60] [1-60]
+      --show-fps       Show fps at right-top in screen
       --timer-color    <COLOR>  Timer color [default: white] [red, green, blue, yellow, cyan, magenta, white, black]
       --wind <WIND>    Decide on the direction of the rain/snow [defualt: random] [random, disable, only-right, only-left]
   -l, --level <LEVEL>  Effect level, The lower, the stronger [default: 50] [4-1000]

src/app.rs

@@ -11,12 +11,19 @@ use crate::{
     cli::Args, state::{EachFrameImpl, State}, tui::{Event, Tui}, ui::ui, widget::AsWeatherWidget
 };
 
+#[derive(Copy, Clone)]
+pub struct AppRuntimeInfo {
+    pub fps: usize,
+}
+
 pub struct App<T> {
     terminal: Terminal<CrosstermBackend<std::io::Stdout>>,
     tui: Tui,
     state: State<T>,
     should_quit: bool,
     args: Args,
+    frame_in_second: usize,
+    runtime_info: AppRuntimeInfo,
 }
 
 impl<T> App<T>
@@ -39,6 +46,8 @@ where
             args,
             tui: Tui::new(args.fps as f64)?,
             should_quit: false,
+            frame_in_second: 0,
+            runtime_info: AppRuntimeInfo { fps: 0 },
         })
     }
 
@@ -51,9 +60,9 @@ where
                 match event {
                     Init => (),
                     Quit | Error => self.should_quit = true,
-                    Render => self.state.tick(),
+                    Render => self.on_render(),
                     Key(key) => self.handle_keyboard(key),
-                    Timer => self.state.tick_timer(),
+                    Timer => self.on_timer(),
                     Resize(columns, rows) => self.state.on_resize(columns, rows),
                 };
             };
@@ -62,7 +71,7 @@ where
                 break;
             }
 
-            self.terminal.draw(|f| ui(f, &mut self.state, self.args))?;
+            self.terminal.draw(|f| ui(f, &mut self.state, self.args, self.runtime_info))?;
         }
 
         Ok(())
@@ -74,6 +83,17 @@ where
             _ => {}
         }
     }
+
+    fn on_render(&mut self) {
+        self.state.tick();
+        self.frame_in_second = self.frame_in_second.saturating_add(1);
+    }
+
+    fn on_timer(&mut self) {
+        self.state.tick_timer();
+        self.runtime_info.fps = self.frame_in_second;
+        self.frame_in_second = 0;
+    }
 }
 
 impl<T> Drop for App<T> {

src/cli.rs

@@ -26,6 +26,10 @@ pub struct Args {
     /// wind mode. [random, disable, only-right, only-left]
     #[arg(long, value_parser = WindMode::from_str, default_value = "random")]
     pub wind: WindMode,
+
+    /// show fps at right-top in screen
+    #[arg(long)]
+    pub show_fps: bool,
 }
 
 fn fps_range(s: &str) -> Result<u8, String> {

src/ui.rs

@@ -1,13 +1,19 @@
 use ratatui::Frame;
+use crate::app::AppRuntimeInfo;
 use crate::state::{EachFrameImpl, State};
 use crate::cli::Args;
 
+use crate::widget::fps::FpsWidget;
 use crate::widget::{AsWeatherWidget, WeatherWidget};
 use crate::widget::timer::Timer;
 
-pub fn ui<T: EachFrameImpl + AsWeatherWidget>(f: &mut Frame, state: &mut State<T>, args: Args) {
+pub fn ui<T: EachFrameImpl + AsWeatherWidget>(f: &mut Frame, state: &mut State<T>, args: Args, runtime_info: AppRuntimeInfo) {
     let area = f.size();
 
     f.render_stateful_widget(WeatherWidget::new(state.weather.as_weather_widget()), area, &mut state.rb);
     f.render_widget(Timer(state.timer, args.timer_color), area);
+
+    if args.show_fps {
+        f.render_widget(FpsWidget(runtime_info.fps), area)
+    }
 }

src/widget/fps.rs

@@ -0,0 +1,24 @@
+use ratatui::{
+    layout::{Constraint, Direction, Layout},
+    style::{Style, Stylize},
+    text::Line,
+    widgets::Widget,
+};
+
+pub struct FpsWidget(pub usize);
+
+impl Widget for FpsWidget {
+    fn render(self, area: ratatui::prelude::Rect, buf: &mut ratatui::prelude::Buffer) {
+        let [_, fps_area, _] = Layout::new(
+            Direction::Horizontal,
+            [
+                Constraint::Min(0),
+                Constraint::Length(3),
+                Constraint::Length(2),
+            ],
+        )
+        .areas(area);
+
+        Line::styled(self.0.to_string(), Style::new().green()).render(fps_area, buf);
+    }
+}

src/widget/mod.rs

@@ -7,6 +7,7 @@ use ratatui::{
 
 use crate::state::{buffer::RenderBuffer, DropCell, DropSpeed};
 
+pub mod fps;
 pub mod timer;
 pub mod weather;