bevy_pixels 0.9.0

Bevy plugin that uses Pixels (a tiny pixel buffer) for rendering
Documentation

Usage

Add bevy and bevy_pixels to Cargo.toml. Be sure to disable bevy's render and bevy_wgpu features (with default-features = false) as they will conflict with rendering provided by bevy_pixels.

[dependencies]
bevy = { version = "0.10", default_features = false }
bevy_pixels = "0.9"

Add PixelsPlugin to your Bevy project.

use bevy::prelude::*;
use bevy_pixels::prelude::*;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugin(PixelsPlugin::default())
        .add_system(draw.in_set(PixelsSet::Draw))
        .run();
}

Use PixelsWrapper in your systems.

fn draw(mut wrapper_query: Query<&mut PixelsWrapper>) {
    // Query the `PixelsWrapper` component that owns an instance of `Pixels` for the given window.
    let Ok(mut wrapper) = wrapper_query.get_single_mut() else { return };

    // Get a mutable slice for the pixel buffer.
    let frame: &mut [u8] = wrapper.pixels.frame_mut();

    // Fill frame with pixel data.
    // ...
}

Bevy and Pixels version mapping

bevy_pixels bevy pixels
0.1 0.5 0.3
0.2 0.5 0.8
0.3-0.4 0.6 0.9
0.5 0.7 0.9
0.6 0.8 0.10
0.7 0.9 0.10
0.8 0.9 0.11
0.9 0.10 0.12

Examples

minimal

This example is based off minimal-winit example from the pixels project.

minimal example

Running examples natively

cargo run --release --example example_name

Running examples in web browser

Install dependencies.

rustup target add wasm32-unknown-unknown
cargo install wasm-bindgen-cli just miniserve

Build and serve example with just. See Justfile for more details.

just serve-web example_name

Open http://localhost:8080/ in your web browser to run the example.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.