Struct insa::Insa

pub struct Insa { /* private fields */ }

The main interface to image to text converion

Implementations

impl Insa

pub fn plain() -> Insa

Initialize using just space brush, no fixed background.

pub fn simple_on_dark() -> Insa

Initialize using well known round chars on dark background

pub fn simple_on_bright() -> Insa

Initialize using well known round chars on dark background

pub fn blocks() -> Insa

Initialize using well known block drawing elements and using background

pub fn load_brushes(&mut self, font: &Font, brushes: impl AsRef<str>) -> &mut Self

Load additional brushes from a font

let font = include_bytes!("../docs/unifont-15.0.01.ttf");
let font = fontdue::Font::from_bytes(font.as_ref(), fontdue::FontSettings::default())
 .expect("tried and tested included font");
let mut insa = insa::Insa::default();
insa.load_brushes(&font, ".oO8°");
println!("{insa:?}")

pub fn brushes(&self) -> &BrushMap

ref access the internal brush map

pub fn brushes_mut(&mut self) -> &mut BrushMap

Mut access internal brush map

pub fn invert(&self) -> bool

Does Insa invert dark/light?

pub fn invert_mut(&mut self) -> &mut bool

Mut access to - does Insa invert dark/light?

pub fn set_invert(&mut self, invert: bool) -> &mut Self

Should Insa invert dark/light?

pub fn fixed_background(&self) -> Option<(u8, u8, u8)>

Does Insa invert dark/light?

pub fn fixed_background_mut(&mut self) -> Option<&mut (u8, u8, u8)>

Mut access to - does Insa invert dark/light?

pub fn set_fixed_background(&mut self, invert: Option<(u8, u8, u8)>) -> &mut Self

Should Insa invert dark/light?

pub fn brush_width(&self) -> u8

The width of the brush in pixels

pub fn brush_height(&self) -> u8

The height of the brush in pixels

pub fn convert<'a>(&'a self, img: &'a DynamicImage) -> ConvertIterator<'a>

Convert a raster bitmap image to text. The returned iterator reveals the number of text columns and rows

pub fn convert_symbol(&self, img: &SubImage<&DynamicImage>) -> Symbol

Convert a single symbol, assuming position 0,0 and the symbol width and height for input

Trait Implementations

impl Debug for Insa

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Insa

fn default() -> Insa

Returns the “default value” for a type.