xray

Release 0.1.0

Screenshot testing for Rust games

Repository Cargo Documentation Download

Keywords
test, screenshot
License
Apache-2.0

Documentation

XRay

Screenshot testing for Rust games

Features

  • Compares screenshots taken at test time with reference screenshots.
  • Outputs the actual screenshot taken and a image containing only those pixels which differ.
  • Compatible with OpenGL apps

Example test (for a Piston + OpenGL app):

#[test]
fn check_basic_screen() {
    let size = [1280, 720];
    let mut app = App::new(size, build_glutin_window(size));
    let Size { width: draw_width, height: draw_height } = app.window.draw_size();
    let Size { width, height } = app.window.size();
    app.render_into_viewport(Viewport {
        rect: [0, 0, draw_width as i32, draw_height as i32],
        window_size: [width, height],
        draw_size: [draw_width, draw_height]
    });
    xray::screenshot_test("basic_rendering/initial_map", 0, 0, draw_width, draw_height);
}

Usage

  1. Write your test.
  2. Run your test.
  3. The first time the test will fail, as there is no reference screenshot. The actual screenshot taken during the test will be stored at test_output/<test_name>/actual.png.
  4. Verify the generated screenshot is correct.
  5. Copy the generated screenshot to references/<test_name>.png
  6. Continue development.

Known Issues

  • Linux/X11: You should run the tests in single threaded mode. Since each test will be creating X11 windows to render into, and creating multiple windows too quickly will result in some of them failing to obtain an input method. This may be possible to fix by wrapping the new window creation in a mutex, but I have't had time to investigate.

Stats

Dependencies
2
Dependent packages
0
Dependent repositories
0
Total releases
1
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
0

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.1.0

Maintainers

Tony Finn

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2018-06-23 00:32:44 UTC

Login to resync this project