11dca72955
* Add Dear ImGui example - Closes #90 * Change argument order to match `render_with` * Remove unnecessary borrow * Refactor error messages * Add a space * Refactor Gui field privacy * Add a menu bar and allow the about window to be closed - The local bool is necessary because the menu bar closures are not allowed to borrow `self` for mutable access while `imgui::Ui<'ui>` is alive. - The token-based menu bar lifetime is even more verbose than this. |
||
|---|---|---|
| .github | ||
| examples | ||
| img | ||
| internals/pixels-mocks | ||
| shaders | ||
| src | ||
| .gitignore | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
A tiny hardware-accelerated pixel frame buffer. 🦀
But why?
Rapidly prototype a simple 2D game, pixel-based animations, software renderers, or an emulator for your favorite platform. Then add shaders to simulate a CRT or just to spice it up with some nice VFX.
pixels is more than just a library to push pixels to a screen, but less than a full framework. You're in charge of managing a window environment, event loop, and input handling.
Features
- Built on modern graphics APIs powered by
wgpu: DirectX 12, Vulkan, Metal. OpenGL support is a work in progress. - Use your own custom shaders for special effects. (WIP)
- Hardware accelerated scaling on perfect pixel boundaries.
- Supports non-square pixel aspect ratios. (WIP)
Examples
- Conway's Game of Life
- Custom Shader
- Dear ImGui example with
winit - Minimal example with SDL2
- Minimal example with
winit - Pixel Invaders
Troubleshooting
The most common issue is having an outdated graphics driver installed on the host machine. pixels
requests a low power (aka integrated) GPU by default. If the examples are not working for any reason, you may try setting the PIXELS_HIGH_PERF environment variable (the value does not matter, e.g. PIXELS_HIGH_PERF=1 is fine) to see if that addresses the issue on your host machine.
You should also try to keep your graphics drivers up-to-date, especially if you have an old Intel integrated GPU. Keep in mind that some drivers and GPUs are EOL and will not be supported.
Logging
You may want to use the RUST_LOG environment variable (see env_logger for full documentation) to gain additional insight while troubleshooting the examples. RUST_LOG=trace will spew all logs to stderr on debug builds:
$ RUST_LOG=trace cargo run --package minimal-winit
And also on release builds when default features are disabled:
$ RUST_LOG=trace cargo run --release --manifest-path examples/minimal-winit/Cargo.toml --no-default-features
Alternatively, nightly Cargo allows using the --no-default-features flag directly from the top-level directory in combination with the unstable -Zpackage-features flag:
$ RUST_LOG=trace cargo run --release --package minimal-winit -Zpackage-features --no-default-features
Comparison with minifb
The minifb crate shares some similarities with pixels; it also allows rapid prototyping of 2D games and emulators. But it requires the use of its own window/GUI management, event loop, and input handling. One of the disadvantages with the minifb approach is the lack of hardware acceleration (except on macOS, which uses Metal but is not configurable). An advantage is that it relies on fewer dependencies.