MiniView is a bare-bones image viewer intended to be used during development and testing. MiniView can be called as binary from the CLI, and used as a Rust library.
To see what it can do, and whether it would fit your purpose, please see: * Use from the cli * Use as library * Documentation: docs.rs
MiniView is not intended to be used as your primary image viewer. For that purpose, I would recommend Emulsion.
With cargo install: cargo install --force miniview
Pre-build binary: see releases
Run cargo add miniview with cargo-edit, or add miniview as a dependency to your Cargo.toml:
toml
miniview = "*" # replace `*` with the latest version
| Usage | Linux example | Windows example (cmd.exe) |
|----------------------------------------|------------------------------------------------|------------------------------------------------|
| miniview <PATH_TO_IMAGE> | miniview image.png | miniview image.png |
| miniview --from-path <PATH_TO_IMAGE> | miniview --from-path image.png | miniview --from-path image.png |
| miniview --from-stdin-path | echo image.png \| miniview --from-stdin-path | echo image.png \| miniview --from-stdin-path |
| miniview --from-stdin-bytes | cat image.png \| miniview --from-stdin-bytes | type image.png \| miniview --from-stdin-bytes |
Flags & Options
| Flag/Option | Description |
| --- | --- |
| --fullscreen | Set the window to fullscreen |
| --allow-window-resizing | Allow the window to resize (doesn't resize the image!) |
| --close-after <n> | Close the window after n milliseconds |
Keyboard shortcuts
Press ESC to exit the image window.
```rust use miniview::config::ConfigBuilder; use std::time::Duration;
fn main() { let config = ConfigBuilder::frompath(concat!(env!("CARGOMANIFESTDIR"), "/resources/plant.jpg")) .setfullscreen(true) .setlazywindow(false) .build();
let controls = MiniView::show(config).expect("unable to create miniview");
// do some important other work!
std::thread::sleep(Duration::from_millis(1000));
let closed = controls.close();
assert!(closed.is_ok());
} ```
MiniView supports two backends: piston-window and pixels. You can switch between backends on compile time. This requires
setting Cargo features. The piston-window backend can be
enabled using the backend_piston_window feature, and the pixels backend can be enabled using the backend_pixels feature.
The default backend is pixels. This backend will be used if no-default-features is not specified. Note that the default backend is not available on MacOS.
The next sections provide examples, on how to enable each backend. Only one backend should be enabled at a time.
| Platform | Supported | Tested | Notes | |----|----|----|-----| | Linux | ✅ | ✅ || | MacOS | | | MacOS does not allow the creation of graphical windows off the main thread. | | Windows | ✅ | ✅ || | ... other piston-window + glutin platforms | ✅ | | Assuming graphical windows can be created off the main thread.
When building MiniView, the piston-window backend can be used by compiling with:
bash
cargo run --no-default-features --features backend_piston_window
When using MiniView as a library, you can use:
toml
[dependencies.miniview]
version = "*" # replace `*` with the latest version
default-features = false
features = ["backend_piston_window"]
or
toml
[dependencies]
miniview = { version = "*", default-features = false, features = ["backend_piston_window"] }
NB: replace * in version = "*" with any supported version.
| Platform | Supported | Tested | Notes | |----|----|----|-----| | Linux | ✅ | ✅ || | Windows | ✅ | ✅ || | MacOS | | | MacOS does not allow the creation of graphical windows off the main thread. | | FreeBSD | ✅ ||| | DragonflyBSD | ✅ ||| | NetBSD | ✅ ||| | OpenBSD | ✅ ||| | ... other pixels + winit platforms | | | Assuming graphical windows can be created off the main thread, support can be added. Please open an issue.
When building MiniView, the pixels backend can be used by compiling with:
bash
cargo run --no-default-features --features backend_pixels
When using MiniView as a library, you can use:
toml
[dependencies.miniview]
version = "*" # replace `*` with the latest version
default-features = false
features = ["backend_pixels"]
or
toml
[dependencies]
miniview = { version = "*", default-features = false, features = ["backend_pixels"] }
NB: replace * in version = "*" with any supported version.
Feel free to open an issue :mailboxwithmail: if you have a suggestion, a question or found a bug =).
🎸 🎺 🎻 🎷