pixelar

Crates.iopixelar
lib.rspixelar
version0.1.0
sourcesrc
created_at2022-11-25 16:26:42.084667
updated_at2022-11-25 16:26:42.084667
descriptionShow everyone the art hidden inside your code.
homepage
repositoryhttps://github.com/immmdreza/pixelar
max_upload_size
id722869
size96,458
MohammadReza (immmdreza)

documentation

README

Pixelar

Show everyone the art hidden inside your code 🧁

Alt text

Code for this piece of pixel art can be found here (It's a copy of a picture on pin).

What

Pixelar is a package that provides you simple API to create pixel arts using rust code.

  • The main purposes of this package is for Learning purposes and turning the code to something visual so it may become easier to understand.

  • It can also be used for creating unique pixel arts and FUN.

Dependencies

Pixelar uses imageproc and image from image-rs to create images.

Get Started

To quickly get started with the package, just bring our prelude into the scope and create a PixelPaper.

use pixelar::prelude::*;

fn main() {
    let mut pixel_paper = PixelPaper::<10, 10>::default();
}

Note that constant generic numbers on pixel paper ( ::<10, 10> ). These're the height and width of your paper in pixels.

Here we have a 10*10 paper.

Now you can mutably access the pixels table on the paper and modify it.

use pixelar::prelude::*;

fn main() {
    let mut pixel_paper = PixelPaper::<10, 10>::default();

    let table = pixel_paper.get_mut_table();
}

You're given a 10*10 2D array of PixelDescriptor.

A PixelDescriptor, describes a pixel at the specified position. It's a simple enum with only two variants:

pub enum PixelDescriptor {
    Nothing, // Nothing there
    Pixel(Pixel), // A pixel with some color.
}

Now you can do whatever you want on the pixels.

    // ---- sniff ----

    let red = PixelDescriptor::Pixel((255, 0, 0).into());
    let green = [0, 255, 0];
    let blue = (0, 0, 255);
    let gray = 100; // (100, 100, 100)

    table[0][0] = blue.into();
    table[0][9] = red;
    table[9][9] = green.into();
    table[9][0] = gray.into();
 
    // ---- sniff ----

You can turn anything that translates to an rgb code into a PixelDescriptor simply by calling into on it.

All pixels are PixelDescriptor::Nothing by default.`

Then finally save your art to a file.

    // --- sniff ---

    pixel_paper.save("arts/simple_1.png").unwrap()
}

Run the code and check the result.

Alt text

This was the whole idea! But there're more ...

use pixelar::{colors::*, positions::*, prelude::*};

fn main() {
    let mut pixel_paper = PixelPaper::<6, 6>::default();

    let rainbow = [
        (250, 130, 0),
        (240, 250, 0),
        (60, 250, 0),
        (0, 250, 220),
        (0, 10, 250),
        (210, 0, 250),
    ];

    for i in 0..6 {
        for j in 0..6 {
            let choose = match j.cmp(&i) {
                std::cmp::Ordering::Less => i,
                std::cmp::Ordering::Equal => j,
                std::cmp::Ordering::Greater => j,
            };

            pixel_paper.change_pixel_color((i, j), rainbow[choose])
        }
    }

    pixel_paper.draw_straight_line(Red, RightTopEdge, LeftBottomEdge);

    pixel_paper.save("arts/simple_2.png").unwrap()
}

Here's the result:

Alt text

PixelBook

Pixel book is a collection of pixel papers and can be saved as a GIF.

use pixelar::{colors::*, positions::*, prelude::*};

fn main() {
    let mut paper = PixelPaper::<5, 5>::default();
    let mut animation = PixelBook::new(Repeat::Infinite);

    animation.add_paper(&paper);

    for i in 0..5 {
        paper.change_pixel_color((i, i), Red);
        paper.change_pixel_color((i, 4 - i), Blue);

        animation.add_paper(&paper);
    }

    animation.save("arts/animated_1.gif").unwrap();
}

Alt text

Pixelar is a work in progress and it's not completed yet!

Commit count: 11

cargo fmt