Struct mage_core::image::Image

pub struct Image {
    pub width: u32,
    pub height: u32,
    pub fore_image: Vec<u32>,
    pub back_image: Vec<u32>,
    pub text_image: Vec<u32>,
}

Represents a rectangular collection of chars to render as sprites or screens.

Fields

width: u32

The width of the image in chars.

height: u32

The height of the image in chars.

fore_image: Vec<u32>

The foreground color of each char in the image.

back_image: Vec<u32>

The background color of each char in the image.

text_image: Vec<u32>

The char to render at each position in the image.

Implementations

impl Image

pub fn new(width: u32, height: u32) -> Self

Creates a new image with the given dimensions.

Arguments

• width - The width of the image in chars.
• height - The height of the image in chars.

Returns

A new image with the given dimensions. The image is filled with character zero.

pub fn point_to_index(&self, p: Point) -> Option<usize>

Returns the index of the char at the given coordinates.

Arguments

• p - The coordinates of the char to get the index of.

Returns

The index of the char at the given coordinates, or None if the coordinates are out of bounds.

pub fn coords_to_index(&self, x: i32, y: i32) -> Option<usize>

Returns the index of the char at the given coordinates.

Arguments

• x - The x coordinate of the char to get the index of.
• y - The y coordinate of the char to get the index of.

Returns

The index of the char at the given coordinates, or None if the coordinates are out of bounds.

pub fn clear(&mut self, ink: u32, paper: u32)

Clears the image with a given ink and paper colour.

Arguments

• ink - The foreground colour to clear the image with.
• paper - The background colour to clear the image with.

pub fn draw_char(&mut self, p: Point, ch: Char)

Draws a character at the given coordinates.

Arguments

• p - The coordinates to draw the character at.
• ch - The character to draw.

Notes

If the coordinates are out of bounds, the character is not drawn.

pub fn draw_string(&mut self, p: Point, text: &str, ink: u32, paper: u32)

Draws a string at the given coordinates.

Arguments

• p - The coordinates to draw the string at.
• text - The string to draw.
• ink - The foreground colour of the string.
• paper - The background colour of the string.

Notes

If the coordinates are out of bounds, the string is clipped.

pub fn draw_filled_rect(&mut self, rect: Rect, ch: Char)

Draws a rectangle at the given coordinates and dimensions using the given character.

Arguments

• p - The coordinates to draw the rectangle at.
• width - The width of the rectangle.
• height - The height of the rectangle.
• ch - The character to draw the rectangle with.

Notes

If the coordinates are out of bounds, the rectangle is clipped.

pub fn rect(&self) -> Rect

Returns a rectangle representing the bounds of the image.

Returns

A rectangle representing the bounds of the image.

Notes

The rectangle returned is always at the origin.

The width and height of the rectangle are the same as the width and height of the image.