ukiyoe

Render images to the terminal using truecolor and unicode.

This package was meant to be used by it's sister package kimono.

cargo add ukiyoe

Examples

Render to terminal with width and height.

use ukiyoe::Image;

fn main() {
    let mut image = Image::new("examples/test.png");
    image.render(100, 40);
}

Render at a specific location.

use ukiyoe::Image;

fn main() {
    let mut image = Image::new("examples/test.png");
    image.render_at_position(0, 0, 100, 40);
}

Render raw pixels.

use ukiyoe::Image;

fn main() {
    Image::render_pixels(
        20,
        20,
        &[
            [255, 0, 0, 255],
            [0, 255, 0, 255],
            [0, 0, 255, 255],
            [0, 0, 255, 255],
        ],
        2,
    );
}

Art

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ukiyoe by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.