14 releases (5 breaking)

0.6.4 Aug 6, 2020
0.6.3 Jul 13, 2020
0.6.2 Mar 26, 2020
0.5.1 Feb 16, 2020
0.1.0 Jan 5, 2020

#98 in Debugging

Download history 7/week @ 2020-05-21 28/week @ 2020-05-28 31/week @ 2020-06-04 8/week @ 2020-06-11 9/week @ 2020-06-18 8/week @ 2020-06-25 31/week @ 2020-07-02 18/week @ 2020-07-09 31/week @ 2020-07-16 24/week @ 2020-07-23 16/week @ 2020-07-30 30/week @ 2020-08-06 42/week @ 2020-08-13 28/week @ 2020-08-20 20/week @ 2020-08-27 51/week @ 2020-09-03

86 downloads per month
Used in aravis-utils

BSD-2-Clause

115KB
2.5K SLoC

Docs.rs CI

show-image

show-image is a library for quickly displaying images. It is intended as a debugging aid for writing image processing code. The library is not intended for making full-featured GUIs, but you can process keyboard events from the created windows.

Supported image types.

The library aims to support as many different data types used to represent images. To keep the dependency graph as small as possible, support for third party libraries must be enabled explicitly with feature flags.

Currently, the following types are supported:

  • Tuples of binary data and ImageInfo.
  • image::DynamicImage and image::ImageBuffer with the image feature.
  • tch::Tensor with the tch feature.

If you think support for a some data type is missing, feel free to send a PR or create an issue on GitHub.

Event handling.

You can receive events using Window::events. This is a general channel on which all events for that window are sent. Alternatively you can use Window::add_event_handler to register an asynchronous event handler. This event handler will run in the context thread, so shouldn't block for too long.

You can also handle keyboard events for windows using Window::wait_key or Window::wait_key_deadline. These functions will wait for key press events while discarding key up events.

Saving displayed images.

If the save feature is enabled, windows allow the displayed image to be saved using Ctrl+S. This will open a file dialog to save the currently displayed image.

Note that images are saved in a background thread. To ensure that no data loss occurs, call stop to gracefully stop and join the background thread.

Example 1: Showing an image.

This example uses a tuple of (&[u8], ImageInfo) as image, but any type that implements ImageData will do.

use show_image::{ImageInfo, make_window};

let image = (pixel_data, ImageInfo::rgb8(1920, 1080));

// Create a window and display the image.
let window = make_window("image")?;
window.set_image(image, "image-001")?;

Example 2: Handling keyboard events.

use show_image::{KeyCode, make_window};

// Create a window and display the image.
let window = make_window("image")?;
window.set_image(&image, "image-001")?;

// Print keyboard events until Escape is pressed, then exit.
// If the user closes the window, wait_key() will return an error and the loop also exits.
while let Ok(event) = window.wait_key(Duration::from_millis(100)) {
    if let Some(event) = event {
        println!("{:#?}", event);
        if event.key == KeyCode::Escape {
            break;
        }
    }
}

// Make sure all background tasks are stopped cleanly.
show_image::stop()?;

Dependencies

~2.5–4.5MB
~110K SLoC