mbrea-c / bevy_firework Goto Github PK

🎆 CPU-driven, batch-rendered particle system for the Bevy game engine.

License: Apache License 2.0

WGSL 13.51% Rust 86.49%

bevy_firework's Introduction

Bevy Firework 🎆

Bevy firework is a particle system plugin where particles are simulated on the CPU and use GPU batching for rendering. This allows each particle system to be rendered in a single draw call (rather than one per particle).

While not as fast as a pure GPU-based particle system, this provides a massive speed-up from the naive approach to CPU-based particles (making it possible to render tens of thousands of particles without noticeable framerate drops) and maintains much of the flexibility of CPU-based particle systems (e.g. easy access to physics data for particle collision, simplified particle system animation).

Current features

Billboarded particles.
Configurable integration with Bevy's PBR rendering (i.e. particles can receive shadows, are affected by fog and lighting changes).
Particle collision with arbitrary bevy_xpbd colliders.
WASM and WebGL compatible.
Soft particle edges.
Animated properties: certain parameters can be defined as a custom curve to express changes over a particle's lifetime:
- Scale
- Color
Randomized properties: certain properties can be randomized, so that they are randomly sampled for every particle:
- Particle lifetime
- Initial linear velocity
- Initial radial velocity
- Initial scale
Emission shapes:
- Point
- Disk
- Sphere
One-shot emission mode, or continuous emission.

Current limitations

Can't use custom images for particles.

Version table

`bevy_firework`	`bevy`	`bevy_utilitarian`
0.1	0.12	0.2
0.2	0.12	0.3
0.3	0.13	0.4

bevy_firework's People

Contributors

Stargazers

Watchers

Forkers

affinator rparrett

bevy_firework's Issues

0.13 Update

The 0.13 update is long overdue. There should be no major changes, but small tweaks are needed to align with new bind group layout entries API.

Crash if Msaa is disabled/enabled after adding the plugin

Reproduction

Change the main function in the pbr example to:

    let mut app = App::new();
    app.add_plugins(DefaultPlugins);
    app.add_plugins(ParticleSystemPlugin)
        .add_systems(Startup, setup);
    app.insert_resource(Msaa::Off);
    app.run();

Expected

The example runs normally, but with Msaa disabled.

Actual result

The example crashes

Reasoning

Currently we setup the texture bindings that the plugin uses at plugin build time, but those bindings are dependent on whether Msaa is enabled or not. They need to be recreated whenever the Msaa resource changes.
This is the reason for the third crash in #11

Version tested

Tested v0.3.0.

Bisected to aa0b278

Info

AdapterInfo { name: "ANGLE (Apple, ANGLE Metal Renderer: Apple M1 Max, Unspecified Version)", vendor: 4203, device: 0, device_type: IntegratedGpu, driver: "", driver_info: "", backend: Gl }

Reproduction

With wasm-server-runner:
cargo run --example sparks --target=wasm32-unknown-unknown

Panic

(index):159 panicked at /Users/me/.cargo/registry/src/index.crates.io-6f17d22bba15001f/glow-0.13.1/src/web_sys.rs:3184:9:
Tex storage 2D multisample is not supported

Stack:

Error
    at imports.wbg.__wbg_new_abda76e883ba8a5f (http://127.0.0.1:1334/api/wasm.js:482:13)
    at __wbg_new_abda76e883ba8a5f externref shim (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[331084]:0x5b9d84a)
    at console_error_panic_hook::Error::new::h8a92a4862c5a1462 (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[237327]:0x56ded84)
    at console_error_panic_hook::hook_impl::hbd888f2d619deb19 (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[45590]:0x37de1ad)
    at console_error_panic_hook::hook::h7220c272d9834ace (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[289425]:0x59fb7f3)
    at core::ops::function::Fn::call::h9b1dea7da821a03f (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[256753]:0x58310b1)
    at std::panicking::rust_panic_with_hook::h6b00a1542b7e827c (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[94864]:0x459e600)
    at std::panicking::begin_panic_handler::{{closure}}::hcb858dc6b4beb4ae (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[123059]:0x4ac35eb)
    at std::sys_common::backtrace::__rust_end_short_backtrace::hbb248f505066e51b (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[333575]:0x5ba5b70)
    at rust_begin_unwind (http://127.0.0.1:1334/api/wasm.wasm:wasm-function[264653]:0x58aca92)

Notes

With Msaa disabled with

    app.add_plugins(DefaultPlugins)
        .insert_resource(Msaa::Off)
        .add_plugins(ParticleSystemPlugin)

there's a different panic:

wgpu error: Validation Error

Caused by:
    In Device::create_bind_group
      note: label = `Firework Uniform Bindgroup`
    Texture binding 1 expects multisampled = true, but given a view with samples = 1

And just a note: For the pbr example, Msaa must be disabled before the ParticleSystemPlugin is added, otherwise, there's a different panic:

wgpu error: Validation Error

Caused by:
    In Device::create_render_pipeline
      note: label = `Firework Pipeline`
    Error matching ShaderStages(FRAGMENT) shader requirements against the pipeline
    Shader global ResourceBinding { group: 1, binding: 1 } is not available in the pipeline layout
    Texture class Depth { multi: true } doesn't match the shader Depth { multi: false }

mbrea-c / bevy_firework Goto Github PK

bevy_firework's Introduction

Bevy Firework 🎆

Current features

Current limitations

Version table

bevy_firework's People

Contributors

Stargazers

Watchers

Forkers

bevy_firework's Issues

Reproduction

Expected

Actual result

Reasoning

Version tested

Info

Reproduction

Panic

Notes

Recommend Projects

Recommend Topics

Recommend Org