Struct Window

pub struct Window { /* private fields */ }

The window configuration section repr.

None values will not override current ones.

See terminal::set().

Implementations

impl Window

pub fn empty() -> Window

Construct a window configuration section override segment with everything being equal to None.

Examples found in repository

examples/simple.rs (line 10)

fn main() {
	terminal::open("Simple example", 80, 30);
	terminal::set(config::Window::empty().resizeable(true));

	terminal::print_xy(0, 0, "Your mom");
	terminal::with_colors(Color::from_rgb(0xFA, 0xAF, 0x29), Color::from_rgb(0x05, 0x50, 0xD6), || terminal::print_xy(0, 1, "Colerd"));
	for (i, c) in "Coloured letters with pixel-offset!".chars().enumerate() {
		terminal::put_ext(Point::new(i as i32, 2), Point::new(i as i32, i as i32), c, &vec![Color::from_rgb(0xFF, 0x00, 0x00),
		                                                                                    Color::from_rgb(0x00, 0xFF, 0x00),
		                                                                                    Color::from_rgb(0x00, 0x00, 0xFF),
		                                                                                    Color::from_rgb(0xFF, 0xFF, 0xFF)]);
	}
	terminal::refresh();

	terminal::set_foreground(Color::from_rgb(0xFF, 0xFF, 0xFF));
	if let Some(string) = terminal::read_str(Point::new(0, 5), 30) {
		terminal::print_xy(0, 5, &*&string);
	}
	terminal::refresh();
	for event in terminal::events() {
		match event {
			Event::Resize{width, height} => {
				terminal::print_xy(0, 0, &*&format!("Width: {}\nHeight: {}", width, height));
				terminal::refresh();
			},
			Event::Close | Event::KeyPressed{key: KeyCode::Escape, ctrl: _, shift: _} => break,
			_                                                                         => (),
		}
	}
	terminal::close();
}

pub fn size(self, size: Size) -> Self

Window size in cells.

Default: 80x25.

pub fn cellsize(self, cellsize: Cellsize) -> Self

Size of all cells, in pixels.

Default: Cellsize::Auto.

pub fn title(self, title: String) -> Self

The terminal window’s title.

Default: "BearLibTerminal".

pub fn icon<T: AsRef<Path>>(self, icon: T) -> Self

The path of the icon used for the terminal window.

Default: none.

pub fn resizeable(self, resizeable: bool) -> Self

Whether the terminal window should be resizeable.

Default: false.

Examples found in repository

examples/simple.rs (line 10)

fn main() {
	terminal::open("Simple example", 80, 30);
	terminal::set(config::Window::empty().resizeable(true));

	terminal::print_xy(0, 0, "Your mom");
	terminal::with_colors(Color::from_rgb(0xFA, 0xAF, 0x29), Color::from_rgb(0x05, 0x50, 0xD6), || terminal::print_xy(0, 1, "Colerd"));
	for (i, c) in "Coloured letters with pixel-offset!".chars().enumerate() {
		terminal::put_ext(Point::new(i as i32, 2), Point::new(i as i32, i as i32), c, &vec![Color::from_rgb(0xFF, 0x00, 0x00),
		                                                                                    Color::from_rgb(0x00, 0xFF, 0x00),
		                                                                                    Color::from_rgb(0x00, 0x00, 0xFF),
		                                                                                    Color::from_rgb(0xFF, 0xFF, 0xFF)]);
	}
	terminal::refresh();

	terminal::set_foreground(Color::from_rgb(0xFF, 0xFF, 0xFF));
	if let Some(string) = terminal::read_str(Point::new(0, 5), 30) {
		terminal::print_xy(0, 5, &*&string);
	}
	terminal::refresh();
	for event in terminal::events() {
		match event {
			Event::Resize{width, height} => {
				terminal::print_xy(0, 0, &*&format!("Width: {}\nHeight: {}", width, height));
				terminal::refresh();
			},
			Event::Close | Event::KeyPressed{key: KeyCode::Escape, ctrl: _, shift: _} => break,
			_                                                                         => (),
		}
	}
	terminal::close();
}

pub fn fullscreen(self, fullscreen: bool) -> Self

Whether to enforce fullscreen mode.

Default: false.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConfigPart for Window

fn to_config_str(&self) -> String

impl Debug for Window

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

Formats the value using the given formatter.

impl Hash for Window

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Window

fn eq(&self, other: &Window) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Window

impl StructuralPartialEq for Window