Struct Renderer 

pub struct Renderer { /* private fields */ }

Renderer for the terminal using custom wgpu cell renderer

Implementations

impl Renderer

pub async fn new( window: Arc<Window>, font_family: Option<&str>, font_family_bold: Option<&str>, font_family_italic: Option<&str>, font_family_bold_italic: Option<&str>, font_ranges: &[FontRange], font_size: f32, window_padding: f32, line_spacing: f32, char_spacing: f32, scrollbar_position: &str, scrollbar_width: f32, scrollbar_thumb_color: [f32; 4], scrollbar_track_color: [f32; 4], enable_text_shaping: bool, enable_ligatures: bool, enable_kerning: bool, vsync_mode: VsyncMode, window_opacity: f32, background_color: [u8; 3], background_image_path: Option<&str>, background_image_enabled: bool, background_image_mode: BackgroundImageMode, background_image_opacity: f32, custom_shader_path: Option<&str>, custom_shader_enabled: bool, custom_shader_animation: bool, custom_shader_animation_speed: f32, custom_shader_text_opacity: f32, custom_shader_full_content: bool, ) -> Result<Self>

Create a new renderer

pub fn resize(&mut self, new_size: PhysicalSize<u32>) -> (usize, usize)

Resize the renderer and recalculate grid dimensions based on padding/font metrics

pub fn handle_scale_factor_change( &mut self, scale_factor: f64, new_size: PhysicalSize<u32>, ) -> (usize, usize)

Update scale factor and resize so the PTY grid matches the new DPI.

pub fn update_cells(&mut self, cells: &[Cell])

Update the terminal cells

pub fn update_cursor( &mut self, position: (usize, usize), opacity: f32, style: CursorStyle, )

Update cursor position and style for geometric rendering

pub fn clear_cursor(&mut self)

Clear cursor (hide it)

pub fn update_scrollbar( &mut self, scroll_offset: usize, visible_lines: usize, total_lines: usize, )

Update scrollbar state

Arguments

• scroll_offset - Current scroll offset (0 = at bottom)
• visible_lines - Number of lines visible on screen
• total_lines - Total number of lines including scrollback

pub fn set_visual_bell_intensity(&mut self, intensity: f32)

Set the visual bell flash intensity

Arguments

• intensity - Flash intensity from 0.0 (no flash) to 1.0 (full white flash)

pub fn update_opacity(&mut self, opacity: f32)

Update window opacity in real-time

pub fn update_window_padding(&mut self, padding: f32) -> Option<(usize, usize)>

Update window padding in real-time without full renderer rebuild Returns Some((cols, rows)) if grid size changed and terminal needs resize

pub fn set_background_image_enabled( &mut self, enabled: bool, path: Option<&str>, mode: BackgroundImageMode, opacity: f32, )

Enable/disable background image and reload if needed

pub fn set_custom_shader_animation(&mut self, enabled: bool)

Enable or disable animation for the custom shader at runtime

pub fn set_shader_mouse_position(&mut self, x: f32, y: f32)

Update mouse position for custom shader (iMouse uniform)

Arguments

• x - Mouse X position in pixels (0 = left edge)
• y - Mouse Y position in pixels (0 = top edge)

pub fn set_shader_mouse_button(&mut self, pressed: bool, x: f32, y: f32)

Update mouse button state for custom shader (iMouse uniform)

Arguments

• pressed - True if left mouse button is pressed
• x - Mouse X position at time of click/release
• y - Mouse Y position at time of click/release

pub fn update_scrollbar_appearance( &mut self, width: f32, thumb_color: [f32; 4], track_color: [f32; 4], )

Update scrollbar appearance in real-time

pub fn update_scrollbar_position(&mut self, position: &str)

Update scrollbar position (left/right) in real-time

pub fn reload_shader_from_source(&mut self, source: &str) -> Result<()>

Reload the custom shader from source code

This method compiles the new shader source and replaces the current pipeline. If compilation fails, returns an error and the old shader remains active.

Arguments

• source - The GLSL shader source code

Returns

Ok(()) if successful, Err with error message if compilation fails

pub fn set_custom_shader_enabled( &mut self, enabled: bool, shader_path: Option<&str>, window_opacity: f32, text_opacity: f32, animation_enabled: bool, animation_speed: f32, full_content: bool, ) -> Result<(), String>

Enable/disable custom shader at runtime. When enabling, tries to (re)load the shader from the given path; when disabling, drops the renderer instance.

Returns Ok(()) on success, or Err with error message on failure.

pub fn update_background_image_opacity(&mut self, opacity: f32)

Update background image opacity in real-time

pub fn update_graphics( &mut self, graphics: &[TerminalGraphic], view_scroll_offset: usize, scrollback_len: usize, visible_rows: usize, ) -> Result<()>

Update graphics textures (Sixel, iTerm2, Kitty)

Arguments

• graphics - Graphics from the terminal with RGBA data
• view_scroll_offset - Current view scroll offset (0 = viewing current content)
• scrollback_len - Total lines in scrollback buffer
• visible_rows - Number of visible rows in terminal

pub fn needs_continuous_render(&self) -> bool

Check if animation requires continuous rendering

pub fn render( &mut self, egui_data: Option<(FullOutput, &Context)>, force_egui_opaque: bool, show_scrollbar: bool, ) -> Result<bool>

Render a frame with optional egui overlay Returns true if rendering was performed, false if skipped

pub fn size(&self) -> PhysicalSize<u32>

Get the current size

pub fn grid_size(&self) -> (usize, usize)

Get the current grid dimensions (columns, rows)

pub fn cell_width(&self) -> f32

Get cell width in pixels

pub fn cell_height(&self) -> f32

Get cell height in pixels

pub fn window_padding(&self) -> f32

Get window padding in pixels

pub fn scrollbar_contains_point(&self, x: f32, y: f32) -> bool

Check if a point (in pixel coordinates) is within the scrollbar bounds

Arguments

• x - X coordinate in pixels (from left edge)
• y - Y coordinate in pixels (from top edge)

pub fn scrollbar_thumb_bounds(&self) -> Option<(f32, f32)>

Get the scrollbar thumb bounds (top Y, height) in pixels

pub fn scrollbar_track_contains_x(&self, x: f32) -> bool

Check if an X coordinate is within the scrollbar track

pub fn scrollbar_mouse_y_to_scroll_offset(&self, mouse_y: f32) -> Option<usize>

Convert a mouse Y position to a scroll offset

Arguments

• mouse_y - Mouse Y coordinate in pixels (from top edge)

Returns

The scroll offset corresponding to the mouse position, or None if scrollbar is not visible

pub fn is_dirty(&self) -> bool

Check if the renderer needs to be redrawn

pub fn mark_dirty(&mut self)

Mark the renderer as dirty, forcing a redraw on next render call

pub fn clear_sixel_cache(&mut self)

Clear all cached sixel textures

pub fn sixel_cache_size(&self) -> usize

Get the number of cached sixel textures

pub fn remove_sixel_texture(&mut self, id: u64)

Remove a specific sixel texture from cache

pub fn render_debug_overlay(&mut self, text: &str)

Set debug overlay text to be rendered

pub fn reconfigure_surface(&mut self)

Reconfigure the surface (call when surface becomes outdated or lost) This typically happens when dragging the window between displays

pub fn clear_glyph_cache(&mut self)

Clear the glyph cache to force re-rasterization Useful after display changes where font rendering may differ