Trait Renderer 

pub trait Renderer {
    // Required methods
    fn width(&self) -> u32;
    fn height(&self) -> u32;
    fn data(&self) -> &[Color];
    fn data_mut(&mut self) -> &mut [Color];
    fn sync(&mut self) -> bool;
    fn update(&mut self) -> bool;
    fn update_rects(&mut self, rects: &[(i32, i32, u32, u32)]) -> bool;
    fn mode(&self) -> &Cell<Mode>;

    // Provided methods
    fn pixel(&mut self, x: i32, y: i32, color: Color) { ... }
    fn arc(&mut self, x0: i32, y0: i32, radius: i32, parts: u8, color: Color) { ... }
    fn circle(&mut self, x0: i32, y0: i32, radius: i32, color: Color) { ... }
    fn line4points(&mut self, x0: i32, y0: i32, x: i32, y: i32, color: Color) { ... }
    fn line(
        &mut self,
        argx1: i32,
        argy1: i32,
        argx2: i32,
        argy2: i32,
        color: Color,
    ) { ... }
    fn lines(&mut self, points: &[[i32; 2]], color: Color) { ... }
    fn draw_path_stroke(&mut self, graphicspath: GraphicsPath, color: Color) { ... }
    fn char(&mut self, x: i32, y: i32, c: char, color: Color) { ... }
    fn set(&mut self, color: Color) { ... }
    fn clear(&mut self) { ... }
    fn rect(&mut self, x: i32, y: i32, w: u32, h: u32, color: Color) { ... }
    fn box_blur(&mut self, x: i32, y: i32, w: u32, h: u32, r: i32) { ... }
    fn box_shadow(
        &mut self,
        x: i32,
        y: i32,
        w: u32,
        h: u32,
        offset_x: i32,
        offset_y: i32,
        r: i32,
        color: Color,
    ) { ... }
    fn image(
        &mut self,
        start_x: i32,
        start_y: i32,
        w: u32,
        h: u32,
        data: &[Color],
    ) { ... }
    fn image_legacy(
        &mut self,
        start_x: i32,
        start_y: i32,
        w: u32,
        h: u32,
        data: &[Color],
    ) { ... }
    fn image_over(&mut self, start: i32, image_data: &[Color]) { ... }
    fn image_opaque(
        &mut self,
        start_x: i32,
        start_y: i32,
        w: u32,
        h: u32,
        image_data: &[Color],
    ) { ... }
    fn image_fast(
        &mut self,
        start_x: i32,
        start_y: i32,
        w: u32,
        h: u32,
        image_data: &[Color],
    ) { ... }
    fn linear_gradient(
        &mut self,
        rect_x: i32,
        rect_y: i32,
        rect_width: u32,
        rect_height: u32,
        start_x: i32,
        start_y: i32,
        end_x: i32,
        end_y: i32,
        start_color: Color,
        end_color: Color,
    ) { ... }
    fn rounded_rect(
        &mut self,
        x: i32,
        y: i32,
        w: u32,
        h: u32,
        radius: u32,
        filled: bool,
        color: Color,
    ) { ... }
    fn wu_line(&mut self, x0: i32, y0: i32, x1: i32, y1: i32, color: Color) { ... }
    fn wu_circle(&mut self, x0: i32, y0: i32, radius: i32, color: Color) { ... }
    fn getpixel(&self, x: i32, y: i32) -> Color { ... }
}

The trait to allow rendering code to be placed. All rendering in this trait is done in software.

Required Methods

fn width(&self) -> u32

Get width

fn height(&self) -> u32

Get height

fn data(&self) -> &[Color]

Access the pixel buffer

fn data_mut(&mut self) -> &mut [Color]

Access the pixel buffer mutably

fn sync(&mut self) -> bool

Update the hardware buffer

fn update(&mut self) -> bool

Update the software buffer

fn update_rects(&mut self, rects: &[(i32, i32, u32, u32)]) -> bool

Update the specified software buffer region (x, y, w, h)

fn mode(&self) -> &Cell<Mode>

Set/get drawing mode

Provided Methods

fn pixel(&mut self, x: i32, y: i32, color: Color)

Draw a pixel

fn arc(&mut self, x0: i32, y0: i32, radius: i32, parts: u8, color: Color)

Draw a piece of an arc. Negative radius will fill in the inside

Examples found in repository

examples/simple.rs (line 58)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn circle(&mut self, x0: i32, y0: i32, radius: i32, color: Color)

Draw a circle. Negative radius will fill in the inside

Examples found in repository

examples/simple.rs (line 62)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn line4points(&mut self, x0: i32, y0: i32, x: i32, y: i32, color: Color)

fn line(&mut self, argx1: i32, argy1: i32, argx2: i32, argy2: i32, color: Color)

Draw a line

Examples found in repository

examples/simple.rs (line 66)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn lines(&mut self, points: &[[i32; 2]], color: Color)

fn draw_path_stroke(&mut self, graphicspath: GraphicsPath, color: Color)

Draw a path (GraphicsPath)

Examples found in repository

examples/simple.rs (line 83)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn char(&mut self, x: i32, y: i32, c: char, color: Color)

Draw a character, using the loaded font

Examples found in repository

examples/simple.rs (line 96)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn set(&mut self, color: Color)

Set entire window to a color

Examples found in repository

examples/rect_bench.rs (line 23)

fn main() {
    let mut window = Window::new(10, 10, 800, 600, "RECTANGLE BENCHMARK").unwrap();

    time!("set", { window.set(Color::rgb(255, 255, 255)) });

    time!("rect 400x400", {
        window.rect(0, 0, 400, 400, Color::rgb(0, 0, 255))
    });

    time!("rect 200x200", {
        window.rect(0, 0, 200, 200, Color::rgb(0, 255, 0))
    });

    time!("rect 100x100", {
        window.rect(0, 0, 100, 100, Color::rgb(255, 0, 0))
    });

    time!("sync", {
        window.update();
    });

    'events: loop {
        for event in window.events() {
            #[allow(clippy::single_match)]
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                _ => (),
            }
        }
    }
}

examples/image_bench.rs (line 27)

fn main() {
    //let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(10, 10, 800, 600, "IMAGE BENCHMARK").unwrap();

    window.set(Color::rgb(255, 255, 255));

    //create image data : a green square
    let data = vec![Color::rgba(100, 200, 10, 3); 412500];
    let mut data2 = vec![Color::rgba(200, 100, 10, 3); 412500];
    let mut data3 = vec![Color::rgba(10, 100, 100, 3); 412500];
    let mut data4 = vec![Color::rgba(10, 100, 200, 3); 800 * 400];

    //draw image benchmarking
    println!("Benchmarking implementations to draw an image on window:");

    time!("image_legacy", {
        for _i in 0..TIMES {
            window.image_legacy(15, 15, 750, 550, &data[..]);
        }
    });

    time!("image_over", {
        for _i in 0..TIMES {
            window.image_over(50, &data4[..]);
        }
    });

    time!("image_fast", {
        for _i in 0..TIMES {
            window.image_fast(20, 20, 750, 550, &data2[..]);
        }
    });

    time!("image_opaque", {
        for _i in 0..TIMES {
            window.image_opaque(30, 30, 750, 550, &data3[..]);
        }
    });

    time!("image_roi_mut_blend", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blend(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_mask", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blit_mask(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit", {
        let data3_roi = ImageRef::from_data(750, 550, &mut data3[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(50, 50, 750, 550))
                .blit(&data3_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_over", {
        let data4_roi = ImageRef::from_data(800, 400, &mut data4[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                // .roi_mut(&Rect::new(10, 120, 790, 400)) // to test blit_over does not trigger
                .roi_mut(&Rect::new(0, 120, 800, 400))
                .blit(&data4_roi.roi(&Rect::new(0, 0, 800, 400)));
        }
    });

    println!("------------------------------------------------");

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn clear(&mut self)

Sets the whole window to black

fn rect(&mut self, x: i32, y: i32, w: u32, h: u32, color: Color)

Examples found in repository

examples/rect_bench.rs (line 26)

fn main() {
    let mut window = Window::new(10, 10, 800, 600, "RECTANGLE BENCHMARK").unwrap();

    time!("set", { window.set(Color::rgb(255, 255, 255)) });

    time!("rect 400x400", {
        window.rect(0, 0, 400, 400, Color::rgb(0, 0, 255))
    });

    time!("rect 200x200", {
        window.rect(0, 0, 200, 200, Color::rgb(0, 255, 0))
    });

    time!("rect 100x100", {
        window.rect(0, 0, 100, 100, Color::rgb(255, 0, 0))
    });

    time!("sync", {
        window.update();
    });

    'events: loop {
        for event in window.events() {
            #[allow(clippy::single_match)]
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                _ => (),
            }
        }
    }
}

examples/simple.rs (line 111)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn box_blur(&mut self, x: i32, y: i32, w: u32, h: u32, r: i32)

Examples found in repository

examples/simple.rs (line 125)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn box_shadow( &mut self, x: i32, y: i32, w: u32, h: u32, offset_x: i32, offset_y: i32, r: i32, color: Color, )

Examples found in repository

examples/simple.rs (line 128)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn image(&mut self, start_x: i32, start_y: i32, w: u32, h: u32, data: &[Color])

Display an image

fn image_legacy( &mut self, start_x: i32, start_y: i32, w: u32, h: u32, data: &[Color], )

Examples found in repository

examples/image_bench.rs (line 40)

fn main() {
    //let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(10, 10, 800, 600, "IMAGE BENCHMARK").unwrap();

    window.set(Color::rgb(255, 255, 255));

    //create image data : a green square
    let data = vec![Color::rgba(100, 200, 10, 3); 412500];
    let mut data2 = vec![Color::rgba(200, 100, 10, 3); 412500];
    let mut data3 = vec![Color::rgba(10, 100, 100, 3); 412500];
    let mut data4 = vec![Color::rgba(10, 100, 200, 3); 800 * 400];

    //draw image benchmarking
    println!("Benchmarking implementations to draw an image on window:");

    time!("image_legacy", {
        for _i in 0..TIMES {
            window.image_legacy(15, 15, 750, 550, &data[..]);
        }
    });

    time!("image_over", {
        for _i in 0..TIMES {
            window.image_over(50, &data4[..]);
        }
    });

    time!("image_fast", {
        for _i in 0..TIMES {
            window.image_fast(20, 20, 750, 550, &data2[..]);
        }
    });

    time!("image_opaque", {
        for _i in 0..TIMES {
            window.image_opaque(30, 30, 750, 550, &data3[..]);
        }
    });

    time!("image_roi_mut_blend", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blend(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_mask", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blit_mask(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit", {
        let data3_roi = ImageRef::from_data(750, 550, &mut data3[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(50, 50, 750, 550))
                .blit(&data3_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_over", {
        let data4_roi = ImageRef::from_data(800, 400, &mut data4[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                // .roi_mut(&Rect::new(10, 120, 790, 400)) // to test blit_over does not trigger
                .roi_mut(&Rect::new(0, 120, 800, 400))
                .blit(&data4_roi.roi(&Rect::new(0, 0, 800, 400)));
        }
    });

    println!("------------------------------------------------");

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn image_over(&mut self, start: i32, image_data: &[Color])

Display an image overwriting a portion of window starting at given line : very quick!!

Examples found in repository

examples/image_bench.rs (line 46)

fn main() {
    //let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(10, 10, 800, 600, "IMAGE BENCHMARK").unwrap();

    window.set(Color::rgb(255, 255, 255));

    //create image data : a green square
    let data = vec![Color::rgba(100, 200, 10, 3); 412500];
    let mut data2 = vec![Color::rgba(200, 100, 10, 3); 412500];
    let mut data3 = vec![Color::rgba(10, 100, 100, 3); 412500];
    let mut data4 = vec![Color::rgba(10, 100, 200, 3); 800 * 400];

    //draw image benchmarking
    println!("Benchmarking implementations to draw an image on window:");

    time!("image_legacy", {
        for _i in 0..TIMES {
            window.image_legacy(15, 15, 750, 550, &data[..]);
        }
    });

    time!("image_over", {
        for _i in 0..TIMES {
            window.image_over(50, &data4[..]);
        }
    });

    time!("image_fast", {
        for _i in 0..TIMES {
            window.image_fast(20, 20, 750, 550, &data2[..]);
        }
    });

    time!("image_opaque", {
        for _i in 0..TIMES {
            window.image_opaque(30, 30, 750, 550, &data3[..]);
        }
    });

    time!("image_roi_mut_blend", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blend(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_mask", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blit_mask(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit", {
        let data3_roi = ImageRef::from_data(750, 550, &mut data3[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(50, 50, 750, 550))
                .blit(&data3_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_over", {
        let data4_roi = ImageRef::from_data(800, 400, &mut data4[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                // .roi_mut(&Rect::new(10, 120, 790, 400)) // to test blit_over does not trigger
                .roi_mut(&Rect::new(0, 120, 800, 400))
                .blit(&data4_roi.roi(&Rect::new(0, 0, 800, 400)));
        }
    });

    println!("------------------------------------------------");

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn image_opaque( &mut self, start_x: i32, start_y: i32, w: u32, h: u32, image_data: &[Color], )

Display an image using non transparent method

Examples found in repository

examples/image_bench.rs (line 58)

fn main() {
    //let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(10, 10, 800, 600, "IMAGE BENCHMARK").unwrap();

    window.set(Color::rgb(255, 255, 255));

    //create image data : a green square
    let data = vec![Color::rgba(100, 200, 10, 3); 412500];
    let mut data2 = vec![Color::rgba(200, 100, 10, 3); 412500];
    let mut data3 = vec![Color::rgba(10, 100, 100, 3); 412500];
    let mut data4 = vec![Color::rgba(10, 100, 200, 3); 800 * 400];

    //draw image benchmarking
    println!("Benchmarking implementations to draw an image on window:");

    time!("image_legacy", {
        for _i in 0..TIMES {
            window.image_legacy(15, 15, 750, 550, &data[..]);
        }
    });

    time!("image_over", {
        for _i in 0..TIMES {
            window.image_over(50, &data4[..]);
        }
    });

    time!("image_fast", {
        for _i in 0..TIMES {
            window.image_fast(20, 20, 750, 550, &data2[..]);
        }
    });

    time!("image_opaque", {
        for _i in 0..TIMES {
            window.image_opaque(30, 30, 750, 550, &data3[..]);
        }
    });

    time!("image_roi_mut_blend", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blend(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_mask", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blit_mask(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit", {
        let data3_roi = ImageRef::from_data(750, 550, &mut data3[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(50, 50, 750, 550))
                .blit(&data3_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_over", {
        let data4_roi = ImageRef::from_data(800, 400, &mut data4[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                // .roi_mut(&Rect::new(10, 120, 790, 400)) // to test blit_over does not trigger
                .roi_mut(&Rect::new(0, 120, 800, 400))
                .blit(&data4_roi.roi(&Rect::new(0, 0, 800, 400)));
        }
    });

    println!("------------------------------------------------");

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn image_fast( &mut self, start_x: i32, start_y: i32, w: u32, h: u32, image_data: &[Color], )

Examples found in repository

examples/image_bench.rs (line 52)

fn main() {
    //let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(10, 10, 800, 600, "IMAGE BENCHMARK").unwrap();

    window.set(Color::rgb(255, 255, 255));

    //create image data : a green square
    let data = vec![Color::rgba(100, 200, 10, 3); 412500];
    let mut data2 = vec![Color::rgba(200, 100, 10, 3); 412500];
    let mut data3 = vec![Color::rgba(10, 100, 100, 3); 412500];
    let mut data4 = vec![Color::rgba(10, 100, 200, 3); 800 * 400];

    //draw image benchmarking
    println!("Benchmarking implementations to draw an image on window:");

    time!("image_legacy", {
        for _i in 0..TIMES {
            window.image_legacy(15, 15, 750, 550, &data[..]);
        }
    });

    time!("image_over", {
        for _i in 0..TIMES {
            window.image_over(50, &data4[..]);
        }
    });

    time!("image_fast", {
        for _i in 0..TIMES {
            window.image_fast(20, 20, 750, 550, &data2[..]);
        }
    });

    time!("image_opaque", {
        for _i in 0..TIMES {
            window.image_opaque(30, 30, 750, 550, &data3[..]);
        }
    });

    time!("image_roi_mut_blend", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blend(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_mask", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blit_mask(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit", {
        let data3_roi = ImageRef::from_data(750, 550, &mut data3[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(50, 50, 750, 550))
                .blit(&data3_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_over", {
        let data4_roi = ImageRef::from_data(800, 400, &mut data4[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                // .roi_mut(&Rect::new(10, 120, 790, 400)) // to test blit_over does not trigger
                .roi_mut(&Rect::new(0, 120, 800, 400))
                .blit(&data4_roi.roi(&Rect::new(0, 0, 800, 400)));
        }
    });

    println!("------------------------------------------------");

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn linear_gradient( &mut self, rect_x: i32, rect_y: i32, rect_width: u32, rect_height: u32, start_x: i32, start_y: i32, end_x: i32, end_y: i32, start_color: Color, end_color: Color, )

Draw a linear gradient in a rectangular region

Examples found in repository

examples/simple.rs (lines 20-31)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn rounded_rect( &mut self, x: i32, y: i32, w: u32, h: u32, radius: u32, filled: bool, color: Color, )

Draw a rect with rounded corners

fn wu_line(&mut self, x0: i32, y0: i32, x1: i32, y1: i32, color: Color)

Draws antialiased line

Examples found in repository

examples/simple.rs (line 71)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn wu_circle(&mut self, x0: i32, y0: i32, radius: i32, color: Color)

Draws antialiased circle

Examples found in repository

examples/simple.rs (line 65)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

fn getpixel(&self, x: i32, y: i32) -> Color

Gets pixel color at x,y position

Examples found in repository

examples/image_bench.rs (line 110)

fn main() {
    //let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(10, 10, 800, 600, "IMAGE BENCHMARK").unwrap();

    window.set(Color::rgb(255, 255, 255));

    //create image data : a green square
    let data = vec![Color::rgba(100, 200, 10, 3); 412500];
    let mut data2 = vec![Color::rgba(200, 100, 10, 3); 412500];
    let mut data3 = vec![Color::rgba(10, 100, 100, 3); 412500];
    let mut data4 = vec![Color::rgba(10, 100, 200, 3); 800 * 400];

    //draw image benchmarking
    println!("Benchmarking implementations to draw an image on window:");

    time!("image_legacy", {
        for _i in 0..TIMES {
            window.image_legacy(15, 15, 750, 550, &data[..]);
        }
    });

    time!("image_over", {
        for _i in 0..TIMES {
            window.image_over(50, &data4[..]);
        }
    });

    time!("image_fast", {
        for _i in 0..TIMES {
            window.image_fast(20, 20, 750, 550, &data2[..]);
        }
    });

    time!("image_opaque", {
        for _i in 0..TIMES {
            window.image_opaque(30, 30, 750, 550, &data3[..]);
        }
    });

    time!("image_roi_mut_blend", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blend(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_mask", {
        let data2_roi = ImageRef::from_data(750, 550, &mut data2[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(40, 40, 750, 550))
                .blit_mask(&data2_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit", {
        let data3_roi = ImageRef::from_data(750, 550, &mut data3[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                .roi_mut(&Rect::new(50, 50, 750, 550))
                .blit(&data3_roi.roi(&Rect::new(0, 0, 750, 550)));
        }
    });

    time!("image_roi_mut_blit_over", {
        let data4_roi = ImageRef::from_data(800, 400, &mut data4[..]);
        for _i in 0..TIMES {
            ImageRef::from_renderer(&mut window)
                // .roi_mut(&Rect::new(10, 120, 790, 400)) // to test blit_over does not trigger
                .roi_mut(&Rect::new(0, 120, 800, 400))
                .blit(&data4_roi.roi(&Rect::new(0, 0, 800, 400)));
        }
    });

    println!("------------------------------------------------");

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

examples/simple.rs (line 100)

fn main() {
    let (width, height) = orbclient::get_display_size().unwrap();

    let mut window = Window::new(
        (width as i32) / 4,
        (height as i32) / 4,
        width / 2,
        height / 2,
        "TITLE",
    )
    .unwrap();

    let (win_w, win_h) = (width / 2, height / 2);

    // top left -> bottom rigth
    window.linear_gradient(
        0,
        0,
        win_w / 3,
        win_h,
        0,
        0,
        (win_w / 3) as i32,
        (win_h / 2) as i32,
        Color::rgb(128, 128, 128),
        Color::rgb(255, 255, 255),
    );
    // horizontal gradient
    window.linear_gradient(
        (win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        0,
        Color::rgb(128, 255, 255),
        Color::rgb(255, 255, 255),
    );
    // vertical gradient
    window.linear_gradient(
        (2 * win_w / 3) as i32,
        0,
        win_w / 3,
        win_h,
        (2 * win_w / 3) as i32,
        0,
        (2 * win_w / 3) as i32,
        win_h as i32,
        Color::rgb(0, 128, 0),
        Color::rgb(255, 255, 255),
    );
    window.arc(100, 100, -25, 1 << 0 | 1 << 2, Color::rgb(0, 0, 255));
    window.arc(100, 100, -25, 1 << 1 | 1 << 3, Color::rgb(0, 255, 255));
    window.arc(100, 100, -25, 1 << 4 | 1 << 6, Color::rgb(255, 0, 255));
    window.arc(100, 100, -25, 1 << 5 | 1 << 7, Color::rgb(255, 255, 0));
    window.circle(100, 100, 25, Color::rgb(0, 0, 0));
    window.circle(100, 101, -25, Color::rgb(0, 255, 0));
    window.circle(220, 220, -100, Color::rgba(128, 128, 128, 80));
    window.wu_circle(150, 220, 100, Color::rgba(255, 0, 0, 255));
    window.line(0, 0, 200, 200, Color::rgb(255, 0, 0));
    window.line(0, 200, 200, 0, Color::rgb(128, 255, 0));
    // vertical and horizontal line test
    window.line(100, 0, 100, 200, Color::rgb(0, 0, 255));
    window.line(0, 100, 200, 100, Color::rgb(255, 255, 0));
    window.wu_line(100, 220, 400, 250, Color::rgba(255, 0, 0, 255));
    window.line(100, 230, 400, 260, Color::rgba(255, 0, 0, 255));

    // path and bezier curve example draw a cloud
    let mut cloud_path = GraphicsPath::new();
    cloud_path.move_to(170, 80);
    cloud_path.bezier_curve_to(130, 100, 130, 150, 230, 150);
    cloud_path.bezier_curve_to(250, 180, 320, 180, 340, 150);
    cloud_path.bezier_curve_to(420, 150, 420, 120, 390, 100);
    cloud_path.bezier_curve_to(430, 40, 370, 30, 340, 50);
    cloud_path.bezier_curve_to(320, 5, 250, 20, 250, 50);
    cloud_path.bezier_curve_to(200, 5, 150, 20, 170, 80);
    window.draw_path_stroke(cloud_path, Color::rgb(0, 0, 255));

    // path and quadratic curve example draw a balloon
    let mut balloon_path = GraphicsPath::new();
    balloon_path.move_to(75, 25);
    balloon_path.quadratic_curve_to(25, 25, 25, 62);
    balloon_path.quadratic_curve_to(25, 100, 50, 100);
    balloon_path.quadratic_curve_to(50, 120, 30, 125);
    balloon_path.quadratic_curve_to(60, 120, 65, 100);
    balloon_path.quadratic_curve_to(125, 100, 125, 62);
    balloon_path.quadratic_curve_to(125, 25, 75, 25);
    window.draw_path_stroke(balloon_path, Color::rgb(0, 0, 255));

    window.char(200, 200, '═', Color::rgb(0, 0, 0));
    window.char(208, 200, '═', Color::rgb(0, 0, 0));

    // testing for non existent x,y position : does not panic but returns Color(0,0,0,0)
    let _non_existent_pixel = window.getpixel(width as i32 + 10, height as i32 + 10);

    // testing PartialEq for Color
    if Color::rgb(11, 2, 3) == Color::rgba(1, 2, 3, 100) {
        println!("Testing colors: they are the same!")
    } else {
        println!("Testing colors: they are NOT the same!")
    }

    //Draw a transparent rectangle over window content
    // default mode is Blend
    window.rect(250, 200, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw an opaque rectangle replacing window content
    window.mode().set(Mode::Overwrite); // set window drawing mode to Overwrite from now on
    window.rect(300, 220, 80, 80, Color::rgb(100, 100, 100));

    //Draw a hole in the window replacing alpha channel (Only in Orbital, not in SDL2)
    window.rect(300, 100, 80, 80, Color::rgba(10, 10, 10, 1));

    //Draw a transparent rectangle over window content
    window.mode().set(Mode::Blend); //set mode to Blend fron now on
    window.rect(200, 230, 80, 80, Color::rgba(100, 100, 100, 100));

    //Draw a blured box over window content
    window.box_blur(170, 100, 150, 150, 10);

    //Draw a shadow around a box
    window.box_shadow(170, 100, 150, 150, 0, 0, 20, Color::rgba(0, 0, 0, 255));

    window.sync();

    'events: loop {
        for event in window.events() {
            match event.to_option() {
                EventOption::Quit(_quit_event) => break 'events,
                EventOption::Mouse(evt) => println!(
                    "At position {:?} pixel color is : {:?}",
                    (evt.x, evt.y),
                    window.getpixel(evt.x, evt.y)
                ),
                event_option => println!("{:?}", event_option),
            }
        }
    }
}

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Renderer for Image

impl Renderer for Surface

impl Renderer for Window

impl<'a> Renderer for ImageRef<'a>