Struct i_slint_core::graphics::rendering_metrics_collector::RenderingMetricsCollector

pub struct RenderingMetricsCollector { /* private fields */ }

Helper class that rendering backends can use to provide an FPS counter

Implementations

impl RenderingMetricsCollector

pub fn new(window: Weak<Window>) -> Option<Rc<Self>>

Returns a new instance of the counter if requested by the user (via SLINT_DEBUG_PERFORMANCE environment variable). The environment variable holds a comma separated list of options: * refresh_lazy: selects the lazy refresh mode, where measurements are only taken when a frame is rendered (due to user input or animations) * refresh_full_speed: frames are continuously rendered * console: the measurement is printed to the console * overlay: the measurement is drawn as overlay on top of the scene

pub fn start(self: &Rc<Self>, winsys_info: &str)

Call this function if you want to start measurements. This will also print out some system information such as whether this is a debug or release build, as well as the provided winsys_info string.

pub fn measure_frame_rendered(self: &Rc<Self>, renderer: &mut dyn ItemRenderer)

Call this function every time you’ve completed the rendering of a frame. The rendere parameter is used to collect additional data and is used to render an overlay if enabled.