Struct Renderer 

pub struct Renderer<B, M>
where
    B: ScreenBuffer,
    B::Drawer: CellDrawer,
{ /* private fields */ }

Implementations

impl<B, M> Renderer<B, M>

where B: ScreenBuffer, B::Drawer: CellDrawer, M: RenderModeBehavior,

pub fn set_update_interval(&mut self, amount: usize)

set how aggrisive draw batches should try to merge

pub fn get_terminal_size(&self) -> (u16, u16)

pub fn create_renderer(size: (u16, u16)) -> Self

Create a new renderer with an initial terminal size.

pub fn create_screen(&mut self, rect: AreaRect, layer: usize) -> ScreenKey

Create a new screen and return its key.

pub fn change_screen_area( &mut self, screen_id: ScreenKey, new_area: AreaRect, ) -> Result<(), DrawError>

pub fn fit_screen_area_to_contents( &mut self, screen_id: ScreenKey, ) -> Result<(), DrawError>

pub fn add_on_screen_select( &mut self, screen_id: ScreenKey, callback: Box<dyn FnMut() + Send + 'static>, )

pub fn change_screen_layer( &mut self, screen_id: ScreenKey, new_layer: usize, ) -> Result<(), DrawError>

pub fn register_drawable( &mut self, screen_id: ScreenKey, obj: DrawObject, ) -> Result<DrawObjectKey, DrawError>

Register a drawable object on a screen.

pub fn remove_drawable(&mut self, id: DrawObjectKey) -> Result<(), DrawError>

pub fn explicit_remove_drawable( &mut self, id: &DrawObjectKey, ) -> Result<(), DrawError>

pub fn replace_drawable( &mut self, id: DrawObjectKey, drawable: Box<dyn Drawable>, ) -> Result<(), DrawError>

pub fn check_if_object_lifetime_ended(&mut self) -> Result<(), DrawError>

checks if any of the currently existing drawobjects should be removed, because its duration on screen has ended

pub fn register_sprite_from_source( &mut self, path: &str, ) -> Result<SpriteId, AppError>

Load a sprite from an ASCII video file.

pub fn render_screen(&mut self, screen_id: ScreenKey) -> Result<(), AppError>

pub fn render_drawable( &mut self, object_key: DrawObjectKey, ) -> Result<(), DrawError>

Render a single drawable object.

pub fn handle_resize(&mut self, new_size: (u16, u16)) -> Result<(), DrawError>

pub fn generate_screen_key(&self) -> ScreenKey

Generate a unique screen key.

pub fn move_drawable_to( &mut self, handle: DrawObjectKey, new_pos: Point<i32>, ) -> Result<(), DrawError>

pub fn move_drawable_by( &mut self, handle: DrawObjectKey, dx: i32, dy: i32, ) -> Result<(), DrawError>

pub fn move_drawable_point( &mut self, handle: DrawObjectKey, point_index: usize, new_pos: Point<i32>, ) -> Result<(), DrawError>

pub fn move_multipoint_drawable_point( &mut self, handle: DrawObjectKey, point_index: usize, new_pos: Point<i32>, ) -> Result<(), DrawError>

pub fn replace_drawable_points( &mut self, handle: DrawObjectKey, new_points: Vec<Point<i32>>, ) -> Result<(), DrawError>

replace a drawables points

pub fn run_drawable_screen_fitting( &mut self, handle: DrawObjectKey, unadjusted_screen_area: Rect<i32>, ) -> Result<(), DrawError>

pub fn get_amount_of_points( &mut self, handle: DrawObjectKey, ) -> Result<Option<usize>, DrawError>

pub fn handle_screen_selection( &mut self, hook: &EventHook, ) -> Result<(), AppError>

selects a different screen, if a mouse button has been clicked the EventHook is needed to access the mouse’s current position

pub fn add_screen_select_handler( &mut self, screen_select_handler: ScreenSelectHandler, )

pub fn into_buffered(self) -> Renderer<B, M>

pub fn into_instant(self) -> Renderer<B, M>

impl<B, Buffered> Renderer<B, Buffered>

where B: ScreenBuffer, B::Drawer: CellDrawer, Buffered: RenderModeBehavior,

pub fn render_frame(&mut self) -> Result<(), DrawError>

pub fn remove_all_framebased_objects(&mut self) -> Result<(), DrawError>

removes all the objects from screen, that have frame-based removal