[−]Trait rltk::Console
Trait that must be implemented by console types.
Required methods
fn get_char_size(&self) -> (u32, u32)
Gets the dimensions of the console in characters
fn resize_pixels(&mut self, width: u32, height: u32)
fn at(&self, x: i32, y: i32) -> usize
Converts an x/y coordinate to a console index number.
fn cls(&mut self)
Clear the console.
fn cls_bg(&mut self, background: RGBA)
Clear the console to a set background color, if supported.
fn print(&mut self, x: i32, y: i32, output: &str)
Print a string at the specified x/y coordinate.
fn print_color(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, output: &str)
Print a string in color at the specified x/y coordinate, with specified foreground and background.
fn printer(
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
Print a colorized string with the color encoding defined inline. For example: printer(1, 1, "#[blue]This blue text contains a #[pink]pink#[] word") You can get the same effect with a TextBlock, but this can be easier. Thanks to doryen_rs for the idea.
fn set(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, glyph: u16)
Sets a single cell to a color/glyph combination.
fn set_bg(&mut self, x: i32, y: i32, bg: RGBA)
Sets a single cell's background color.
fn draw_box(
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_hollow_box(
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters, without filling in the middle
fn draw_box_double(
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn draw_hollow_box_double(
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
x: i32,
y: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters, without filling in the middle
fn fill_region(&mut self, target: Rect, glyph: u16, fg: RGBA, bg: RGBA)
Fills a rectangle-defined region with a given glyph
fn draw_bar_horizontal(
&mut self,
x: i32,
y: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
x: i32,
y: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a horizontal progress bar.
fn draw_bar_vertical(
&mut self,
x: i32,
y: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
x: i32,
y: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a vertical progress bar.
fn print_centered(&mut self, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered(&mut self, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_centered_at(&mut self, x: i32, y: i32, text: &str)
Prints text, centered on an arbitrary point
fn print_color_centered_at(
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
Prints colored text, centered on an arbitrary point
fn print_right(&mut self, x: i32, y: i32, text: &str)
Prints text right-aligned
fn print_color_right(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints colored text right-aligned
fn to_xp_layer(&self) -> XpLayer
Serializes the console layer to an XpFile
fn set_offset(&mut self, x: f32, y: f32)
Specify a global offset (by character count, so 0.5 is half a character). Useful for drawing walls between tiles.
fn set_scale(&mut self, scale: f32, center_x: i32, center_y: i32)
Specify a scale and center of the console. A scale above 1.0 will make the text larger. The center of the scale is at character position (center_x, center_y).
fn get_scale(&self) -> (f32, i32, i32)
Get the scale & center of the console. Returns (scale, center_x, center_y).
fn as_any(&self) -> &(dyn Any + 'static)
Produces the implementor as an Any that can be matched to determine type and access natively.
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Produces the implementor as an Any that can be matched to determine type and access natively.
fn set_clipping(&mut self, clipping: Option<Rect>)
Permits the creation of an arbitrary clipping rectangle. It's a really good idea to make sure that this rectangle is entirely valid.
fn get_clipping(&self) -> Option<Rect>
Returns the current arbitrary clipping rectangle, None if there isn't one.
fn set_all_fg_alpha(&mut self, alpha: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_all_bg_alpha(&mut self, alpha: f32)
Sets ALL tiles background alpha (only tiles that exist, in sparse consoles).
fn set_all_alpha(&mut self, fg: f32, bg: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_translation_mode(&mut self, mode: CharacterTranslationMode)
Sets the character translation mode
fn set_char_size(&mut self, width: u32, height: u32)
Sets the character size of the layer. Be really careful with this.
Provided methods
fn in_bounds(&self, x: i32, y: i32) -> bool
Returns true if an x/y coordinate is within the console bounds
fn try_at(&self, x: i32, y: i32) -> Option<usize>
Try to use a coordinate: return Some(the coordinate) if it is valid, None if it isn't.
Implementors
impl Console for FlexiConsole
fn get_char_size(&self) -> (u32, u32)
fn resize_pixels(&mut self, _width: u32, _height: u32)
fn at(&self, x: i32, y: i32) -> usize
Translates x/y to an index entry. Not really useful.
fn cls(&mut self)
Clear the screen.
fn cls_bg(&mut self, _background: RGBA)
Clear the screen. Since we don't HAVE a background, it doesn't use it.
fn print(&mut self, x: i32, y: i32, output: &str)
Prints a string to an x/y position.
fn print_color(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, output: &str)
Prints a string to an x/y position, with foreground and background colors.
fn set(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, glyph: u16)
Sets a single cell in the console
fn set_bg(&mut self, _x: i32, _y: i32, _bg: RGBA)
Sets a single cell in the console's background
fn draw_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn draw_hollow_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_hollow_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn fill_region(&mut self, target: Rect, glyph: u16, fg: RGBA, bg: RGBA)
Fills a rectangle with the specified rendering information
fn draw_bar_horizontal(
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a horizontal progress bar
fn draw_bar_vertical(
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a vertical progress bar
fn print_centered(&mut self, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered(&mut self, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_centered_at(&mut self, x: i32, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered_at(
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_right(&mut self, x: i32, y: i32, text: &str)
Prints text right-aligned
fn print_color_right(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints colored text right-aligned
fn printer(
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
Print a colorized string with the color encoding defined inline. For example: printer(1, 1, "#[blue]This blue text contains a #[pink]pink#[] word") You can get the same effect with a TextBlock, but this can be easier. Thanks to doryen_rs for the idea.
fn to_xp_layer(&self) -> XpLayer
Saves the layer to an XpFile structure
fn set_offset(&mut self, x: f32, y: f32)
Sets an offset to total console rendering, useful for layers that draw between tiles. Offsets are specified as a percentage of total character size; so -0.5 will offset half a character to the left/top.
fn set_scale(&mut self, scale: f32, center_x: i32, center_y: i32)
fn get_scale(&self) -> (f32, i32, i32)
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn set_clipping(&mut self, clipping: Option<Rect>)
Permits the creation of an arbitrary clipping rectangle. It's a really good idea to make sure that this rectangle is entirely valid.
fn get_clipping(&self) -> Option<Rect>
Returns the current arbitrary clipping rectangle, None if there isn't one.
fn set_all_fg_alpha(&mut self, alpha: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_all_bg_alpha(&mut self, alpha: f32)
Sets ALL tiles background alpha (only tiles that exist, in sparse consoles).
fn set_all_alpha(&mut self, fg: f32, bg: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_translation_mode(&mut self, mode: CharacterTranslationMode)
Sets the character translation mode
fn set_char_size(&mut self, width: u32, height: u32)
Sets the character size of the terminal
impl Console for SimpleConsole
fn get_char_size(&self) -> (u32, u32)
fn resize_pixels(&mut self, _width: u32, _height: u32)
fn at(&self, x: i32, y: i32) -> usize
Translate an x/y into an array index.
fn cls(&mut self)
Clears the screen.
fn cls_bg(&mut self, background: RGBA)
Clears the screen with a background color.
fn print(&mut self, x: i32, y: i32, output: &str)
Prints a string at x/y.
fn print_color(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, output: &str)
Prints a string at x/y, with foreground and background colors.
fn set(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, glyph: u16)
Sets a single cell in the console
fn set_bg(&mut self, x: i32, y: i32, bg: RGBA)
Sets a single cell in the console's background
fn draw_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_hollow_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn draw_hollow_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn fill_region(&mut self, target: Rect, glyph: u16, fg: RGBA, bg: RGBA)
Fills a rectangle with the specified rendering information
fn draw_bar_horizontal(
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a horizontal progress bar
fn draw_bar_vertical(
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a vertical progress bar
fn print_centered(&mut self, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered(&mut self, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_centered_at(&mut self, x: i32, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered_at(
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_right(&mut self, x: i32, y: i32, text: &str)
Prints text right-aligned
fn print_color_right(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints colored text right-aligned
fn printer(
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
Print a colorized string with the color encoding defined inline. For example: printer(1, 1, "#[blue]This blue text contains a #[pink]pink#[] word") You can get the same effect with a TextBlock, but this can be easier. Thanks to doryen_rs for the idea.
fn to_xp_layer(&self) -> XpLayer
Saves the layer to an XpFile structure
fn set_offset(&mut self, x: f32, y: f32)
Sets an offset to total console rendering, useful for layers that draw between tiles. Offsets are specified as a percentage of total character size; so -0.5 will offset half a character to the left/top.
fn set_scale(&mut self, scale: f32, center_x: i32, center_y: i32)
fn get_scale(&self) -> (f32, i32, i32)
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn set_clipping(&mut self, clipping: Option<Rect>)
Permits the creation of an arbitrary clipping rectangle. It's a really good idea to make sure that this rectangle is entirely valid.
fn get_clipping(&self) -> Option<Rect>
Returns the current arbitrary clipping rectangle, None if there isn't one.
fn set_all_fg_alpha(&mut self, alpha: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_all_bg_alpha(&mut self, alpha: f32)
Sets ALL tiles background alpha (only tiles that exist, in sparse consoles).
fn set_all_alpha(&mut self, fg: f32, bg: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_translation_mode(&mut self, mode: CharacterTranslationMode)
Sets the character translation mode
fn set_char_size(&mut self, width: u32, height: u32)
Sets the character size of the terminal
impl Console for SparseConsole
fn get_char_size(&self) -> (u32, u32)
fn resize_pixels(&mut self, _width: u32, _height: u32)
fn at(&self, x: i32, y: i32) -> usize
Translates x/y to an index entry. Not really useful.
fn cls(&mut self)
Clear the screen.
fn cls_bg(&mut self, _background: RGBA)
Clear the screen. Since we don't HAVE a background, it doesn't use it.
fn print(&mut self, x: i32, y: i32, output: &str)
Prints a string to an x/y position.
fn print_color(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, output: &str)
Prints a string to an x/y position, with foreground and background colors.
fn set(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, glyph: u16)
Sets a single cell in the console
fn set_bg(&mut self, x: i32, y: i32, bg: RGBA)
Sets a single cell in the console's background
fn draw_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn draw_hollow_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_hollow_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn fill_region(&mut self, target: Rect, glyph: u16, fg: RGBA, bg: RGBA)
Fills a rectangle with the specified rendering information
fn draw_bar_horizontal(
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a horizontal progress bar
fn draw_bar_vertical(
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a vertical progress bar
fn print_centered(&mut self, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered(&mut self, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_centered_at(&mut self, x: i32, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered_at(
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_right(&mut self, x: i32, y: i32, text: &str)
Prints text right-aligned
fn print_color_right(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints colored text right-aligned
fn printer(
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
Print a colorized string with the color encoding defined inline. For example: printer(1, 1, "#[blue]This blue text contains a #[pink]pink#[] word") You can get the same effect with a TextBlock, but this can be easier. Thanks to doryen_rs for the idea.
fn to_xp_layer(&self) -> XpLayer
Saves the layer to an XpFile structure
fn set_offset(&mut self, x: f32, y: f32)
Sets an offset to total console rendering, useful for layers that draw between tiles. Offsets are specified as a percentage of total character size; so -0.5 will offset half a character to the left/top.
fn set_scale(&mut self, scale: f32, center_x: i32, center_y: i32)
fn get_scale(&self) -> (f32, i32, i32)
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn set_clipping(&mut self, clipping: Option<Rect>)
Permits the creation of an arbitrary clipping rectangle. It's a really good idea to make sure that this rectangle is entirely valid.
fn get_clipping(&self) -> Option<Rect>
Returns the current arbitrary clipping rectangle, None if there isn't one.
fn set_all_fg_alpha(&mut self, alpha: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_all_bg_alpha(&mut self, alpha: f32)
Sets ALL tiles background alpha (only tiles that exist, in sparse consoles).
fn set_all_alpha(&mut self, fg: f32, bg: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_translation_mode(&mut self, mode: CharacterTranslationMode)
Sets the character translation mode
fn set_char_size(&mut self, width: u32, height: u32)
Sets the character size of the terminal
impl Console for SpriteConsole
fn get_char_size(&self) -> (u32, u32)
fn resize_pixels(&mut self, _width: u32, _height: u32)
fn at(&self, x: i32, y: i32) -> usize
Translates x/y to an index entry. Not really useful.
fn cls(&mut self)
Clear the screen.
fn cls_bg(&mut self, _background: RGBA)
Clear the screen. Since we don't HAVE a background, it doesn't use it.
fn print(&mut self, _x: i32, _y: i32, _output: &str)
Prints a string to an x/y position.
fn print_color(&mut self, _x: i32, _y: i32, _fg: RGBA, _bg: RGBA, _output: &str)
Prints a string to an x/y position, with foreground and background colors.
fn set(&mut self, _x: i32, _y: i32, _fg: RGBA, _bg: RGBA, _glyph: u16)
Sets a single cell in the console
fn set_bg(&mut self, _x: i32, _y: i32, _bg: RGBA)
Sets a single cell in the console's background
fn draw_box(
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_box_double(
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn draw_hollow_box(
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_hollow_box_double(
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_height: i32,
_fg: RGBA,
_bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn fill_region(&mut self, _target: Rect, _glyph: u16, _fg: RGBA, _bg: RGBA)
Fills a rectangle with the specified rendering information
fn draw_bar_horizontal(
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_n: i32,
_max: i32,
_fg: RGBA,
_bg: RGBA
)
&mut self,
_sx: i32,
_sy: i32,
_width: i32,
_n: i32,
_max: i32,
_fg: RGBA,
_bg: RGBA
)
Draws a horizontal progress bar
fn draw_bar_vertical(
&mut self,
_sx: i32,
_sy: i32,
_height: i32,
_n: i32,
_max: i32,
_fg: RGBA,
_bg: RGBA
)
&mut self,
_sx: i32,
_sy: i32,
_height: i32,
_n: i32,
_max: i32,
_fg: RGBA,
_bg: RGBA
)
Draws a vertical progress bar
fn print_centered(&mut self, _y: i32, _text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered(&mut self, _y: i32, _fg: RGBA, _bg: RGBA, _text: &str)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_centered_at(&mut self, _x: i32, _y: i32, _text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered_at(
&mut self,
_x: i32,
_y: i32,
_fg: RGBA,
_bg: RGBA,
_text: &str
)
&mut self,
_x: i32,
_y: i32,
_fg: RGBA,
_bg: RGBA,
_text: &str
)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_right(&mut self, _x: i32, _y: i32, _text: &str)
Prints text right-aligned
fn print_color_right(
&mut self,
_x: i32,
_y: i32,
_fg: RGBA,
_bg: RGBA,
_text: &str
)
&mut self,
_x: i32,
_y: i32,
_fg: RGBA,
_bg: RGBA,
_text: &str
)
Prints colored text right-aligned
fn printer(
&mut self,
_x: i32,
_y: i32,
_output: &str,
_align: TextAlign,
_background: Option<RGBA>
)
&mut self,
_x: i32,
_y: i32,
_output: &str,
_align: TextAlign,
_background: Option<RGBA>
)
Print a colorized string with the color encoding defined inline. For example: printer(1, 1, "#[blue]This blue text contains a #[pink]pink#[] word") You can get the same effect with a TextBlock, but this can be easier. Thanks to doryen_rs for the idea.
fn to_xp_layer(&self) -> XpLayer
Saves the layer to an XpFile structure
fn set_offset(&mut self, _x: f32, _y: f32)
Sets an offset to total console rendering, useful for layers that draw between tiles. Offsets are specified as a percentage of total character size; so -0.5 will offset half a character to the left/top.
fn set_scale(&mut self, _scale: f32, _center_x: i32, _center_y: i32)
fn get_scale(&self) -> (f32, i32, i32)
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn set_clipping(&mut self, _clipping: Option<Rect>)
Permits the creation of an arbitrary clipping rectangle. It's a really good idea to make sure that this rectangle is entirely valid.
fn get_clipping(&self) -> Option<Rect>
Returns the current arbitrary clipping rectangle, None if there isn't one.
fn set_all_fg_alpha(&mut self, alpha: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_all_bg_alpha(&mut self, _alpha: f32)
Sets ALL tiles background alpha (only tiles that exist, in sparse consoles).
fn set_all_alpha(&mut self, fg: f32, _bg: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_translation_mode(&mut self, _mode: CharacterTranslationMode)
Sets the character translation mode
fn set_char_size(&mut self, width: u32, height: u32)
Sets the character size of the terminal
impl Console for VirtualConsole
fn get_char_size(&self) -> (u32, u32)
fn resize_pixels(&mut self, _width: u32, _height: u32)
fn at(&self, x: i32, y: i32) -> usize
Translate an x/y into an array index.
fn cls(&mut self)
Clears the screen.
fn cls_bg(&mut self, background: RGBA)
Clears the screen with a background color.
fn print(&mut self, x: i32, y: i32, output: &str)
Prints a string at x/y.
fn print_color(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, output: &str)
Prints a string at x/y, with foreground and background colors.
fn set(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, glyph: u16)
Sets a single cell in the console
fn set_bg(&mut self, x: i32, y: i32, bg: RGBA)
Sets a single cell in the console's background
fn draw_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_hollow_box(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 line characters
fn draw_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn draw_hollow_box_double(
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
height: i32,
fg: RGBA,
bg: RGBA
)
Draws a box, starting at x/y with the extents width/height using CP437 double line characters
fn fill_region(&mut self, target: Rect, glyph: u16, fg: RGBA, bg: RGBA)
Fills a rectangle with the specified rendering information
fn draw_bar_horizontal(
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
width: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a horizontal progress bar
fn draw_bar_vertical(
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
&mut self,
sx: i32,
sy: i32,
height: i32,
n: i32,
max: i32,
fg: RGBA,
bg: RGBA
)
Draws a vertical progress bar
fn print_centered(&mut self, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered(&mut self, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_centered_at(&mut self, x: i32, y: i32, text: &str)
Prints text, centered to the whole console width, at vertical location y.
fn print_color_centered_at(
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
&mut self,
x: i32,
y: i32,
fg: RGBA,
bg: RGBA,
text: &str
)
Prints text in color, centered to the whole console width, at vertical location y.
fn print_right(&mut self, x: i32, y: i32, text: &str)
Prints text right-aligned
fn print_color_right(&mut self, x: i32, y: i32, fg: RGBA, bg: RGBA, text: &str)
Prints colored text right-aligned
fn printer(
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
&mut self,
x: i32,
y: i32,
output: &str,
align: TextAlign,
background: Option<RGBA>
)
Print a colorized string with the color encoding defined inline. For example: printer(1, 1, "#[blue]This blue text contains a #[pink]pink#[] word") You can get the same effect with a TextBlock, but this can be easier. Thanks to doryen_rs for the idea.
fn to_xp_layer(&self) -> XpLayer
Saves the layer to an XpFile structure
fn set_offset(&mut self, _x: f32, _y: f32)
Sets an offset to total console rendering, useful for layers that draw between tiles. Offsets are specified as a percentage of total character size; so -0.5 will offset half a character to the left/top.
fn set_scale(&mut self, _scale: f32, _center_x: i32, _center_y: i32)
fn get_scale(&self) -> (f32, i32, i32)
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn set_clipping(&mut self, clipping: Option<Rect>)
Permits the creation of an arbitrary clipping rectangle. It's a really good idea to make sure that this rectangle is entirely valid.
fn get_clipping(&self) -> Option<Rect>
Returns the current arbitrary clipping rectangle, None if there isn't one.
fn set_all_fg_alpha(&mut self, alpha: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_all_bg_alpha(&mut self, alpha: f32)
Sets ALL tiles background alpha (only tiles that exist, in sparse consoles).
fn set_all_alpha(&mut self, fg: f32, bg: f32)
Sets ALL tiles foreground alpha (only tiles that exist, in sparse consoles).
fn set_translation_mode(&mut self, mode: CharacterTranslationMode)
Sets the character translation mode
fn set_char_size(&mut self, _width: u32, _height: u32)
Sets the character size of the terminal