v0.18.0

Author: djeedai

CHANGELOG.md

@@ -3,7 +3,7 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [0.18.0] 2026-02-01
 
 _This version is compatible with Bevy 0.18_
 

README.md

@@ -5,19 +5,19 @@
 [![Crate](https://img.shields.io/crates/v/bevy_hanabi.svg)](https://crates.io/crates/bevy_hanabi)
 [![Build Status](https://github.com/djeedai/bevy_hanabi/actions/workflows/ci.yaml/badge.svg)](https://github.com/djeedai/bevy_hanabi/actions/workflows/ci.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/djeedai/bevy_hanabi/badge.svg?branch=main)](https://coveralls.io/github/djeedai/bevy_hanabi?branch=main)
-[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-v0.17-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
+[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-v0.18-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
 
 🎆 Hanabi — a GPU particle system for the Bevy game engine.
 
-![firework](https://raw.githubusercontent.com/djeedai/bevy_hanabi/f1878586b57129ea4d53fa89c7c7a5ef579d8924/examples/firework.gif)
+![firework](https://raw.githubusercontent.com/djeedai/bevy_hanabi/ea57ad23be55a098b9d9446425f1909a8e88f6fc/examples/firework.gif)
 
 ## Overview
 
 The Hanabi particle system is a modern GPU-based particle system for the Bevy game engine. It focuses on scale to produce stunning visual effects (VFX) in real time, offloading most of the work to the GPU, with minimal CPU intervention. The design is inspired by modern particle systems found in other industry-leading game engines.
 
 🚧 _This project is under heavy development, and is currently lacking both features and performance / usability polish. However, for moderate-size effects, it can already be used in your project. Feedback and contributions on both design and features are very much welcome._
 
-🎆 Hanabi makes heavy use of compute shaders to offload work to the GPU in a performant way. Support for compute shaders on the `wasm` target (WebAssembly) is available as of v0.13 (Bevy 0.14), and only through WebGPU. See the [WebAssembly support](https://github.com/djeedai/bevy_hanabi/blob/f1878586b57129ea4d53fa89c7c7a5ef579d8924/docs/wasm.md) documentation for details.
+🎆 Hanabi makes heavy use of compute shaders to offload work to the GPU in a performant way. Support for compute shaders on the `wasm` target (WebAssembly) is available as of v0.13 (Bevy 0.14), and only through WebGPU. See the [WebAssembly support](https://github.com/djeedai/bevy_hanabi/blob/ea57ad23be55a098b9d9446425f1909a8e88f6fc/docs/wasm.md) documentation for details.
 
 ## Usage
 
@@ -29,7 +29,7 @@ Add the `bevy_hanabi` dependency to `Cargo.toml`:
 
 ```toml
 [dependencies]
-bevy_hanabi = "0.17"
+bevy_hanabi = "0.18"
 ```
 
 See also [Features](#features) below for the list of supported features.
@@ -124,9 +124,9 @@ commands.spawn((
 
 ## Examples
 
-See the [`examples/`](https://github.com/djeedai/bevy_hanabi/tree/f1878586b57129ea4d53fa89c7c7a5ef579d8924/examples) folder.
+See the [`examples/`](https://github.com/djeedai/bevy_hanabi/tree/ea57ad23be55a098b9d9446425f1909a8e88f6fc/examples) folder.
 
-A web demo (using the WebAssembly target) showing all examples is availabe in the [`examples/wasm/`](https://github.com/djeedai/bevy_hanabi/tree/f1878586b57129ea4d53fa89c7c7a5ef579d8924/examples/wasm) folder. You can open `index.html` in any browser to see a GIF of all the examples. Running the actual WebAssembly example however requires serving the files with an HTTP server. If you have NodeJS installed, you can do that for example by running `npx http-server examples/wasm`.
+A web demo (using the WebAssembly target) showing all examples is availabe in the [`examples/wasm/`](https://github.com/djeedai/bevy_hanabi/tree/ea57ad23be55a098b9d9446425f1909a8e88f6fc/examples/wasm) folder. You can open `index.html` in any browser to see a GIF of all the examples. Running the actual WebAssembly example however requires serving the files with an HTTP server. If you have NodeJS installed, you can do that for example by running `npx http-server examples/wasm`.
 
 Note for Linux users: The examples build with the `bevy/x11` feature by default to enable support for the X11 display server. If you want to use the Wayland display server instead, add the `bevy/wayland` feature.
 
@@ -188,8 +188,8 @@ This list contains the major fixed features provided by 🎆 Hanabi. Beyond that
     - [x] Trails / Ribbons
   - [x] Camera support
     - [x] Render layers
-    - [x] 2D cameras ([`Camera2d`](https://docs.rs/bevy/0.17.2/bevy/core_pipeline/core_2d/struct.Camera2d.html)) only
-    - [x] 3D cameras ([`Camera3d`](https://docs.rs/bevy/0.17.2/bevy/core_pipeline/core_3d/struct.Camera3d.html)) only
+    - [x] 2D cameras ([`Camera2d`](https://docs.rs/bevy/0.18/bevy/core_pipeline/core_2d/struct.Camera2d.html)) only
+    - [x] 3D cameras ([`Camera3d`](https://docs.rs/bevy/0.18/bevy/core_pipeline/core_3d/struct.Camera3d.html)) only
     - [x] Simultaneous dual 2D/3D cameras
     - [x] Multiple viewports (split screen)
     - [x] HDR camera and bloom
@@ -211,16 +211,16 @@ This list contains the major fixed features provided by 🎆 Hanabi. Beyond that
 
 | Feature | Default | Description |
 |---|:-:|---|
-| `2d` | ✔ | Enable rendering through 2D cameras ([`Camera2d`](https://docs.rs/bevy/0.17.2/bevy/core_pipeline/core_2d/struct.Camera2d.html)) |
-| `3d` | ✔ | Enable rendering through 3D cameras ([`Camera3d`](https://docs.rs/bevy/0.17.2/bevy/core_pipeline/core_3d/struct.Camera3d.html)) |
+| `2d` | ✔ | Enable rendering through 2D cameras ([`Camera2d`](https://docs.rs/bevy/0.18/bevy/core_pipeline/core_2d/struct.Camera2d.html)) |
+| `3d` | ✔ | Enable rendering through 3D cameras ([`Camera3d`](https://docs.rs/bevy/0.18/bevy/core_pipeline/core_3d/struct.Camera3d.html)) |
 | `serde`* | ✔ | Use `serde` to derive `Serialization` and `Deserialization` on asset-related types. |
 
 (*) `serde` is not compatible with WASM (due to the `typetag` dependency not being available on `wasm` without extra setup).
 
 For optimization purpose, users of a single type of camera can disable the other type by skipping default features in their `Cargo.toml`. For example to use only the 3D mode:
 
 ```toml
-bevy_hanabi = { version = "0.17", default-features = false, features = [ "3d", "serde" ] }
+bevy_hanabi = { version = "0.18", default-features = false, features = [ "3d", "serde" ] }
 ```
 
 ## Compatible Bevy versions
@@ -231,6 +231,7 @@ Compatibility of `bevy_hanabi` versions:
 
 | `bevy_hanabi` | `bevy` |
 | :--           | :--    |
+| `0.18`        | `0.18` |
 | `0.17`        | `0.17` |
 | `0.16`        | `0.16` |
 | `0.14`-`0.15` | `0.15` |

src/lib.rs

@@ -40,7 +40,7 @@
 //!
 //! ```toml
 //! # Example: enable only 3D integration
-//! bevy_hanabi = { version = "0.17", default-features = false, features = ["3d"] }
+//! bevy_hanabi = { version = "0.18", default-features = false, features = ["3d"] }
 //! ```
 //!
 //! # Example

src/render/sort.rs

@@ -216,7 +216,13 @@ impl SortBindGroups {
             sort_fill_bind_group_layout_descs: default(),
             sort_fill_bind_groups: default(),
             sort_bind_group_layout_desc,
-            sort_bind_group: None, // created once the pipeline and its bind group layouts are created by the pipeline cache
+            // This bind group is created later, once the pipeline and its bind group layouts are
+            // created by the pipeline cache. Technically we could create the bind group layout
+            // immediately because the PipelineCache pretends to but actually creates them
+            // on-the-fly in get_bind_group_layout(), but this is brittle as any behavior change
+            // would break Hanabi. Instead we create this bind group alongside all others, which is
+            // more consistent too.
+            sort_bind_group: None,
             sort_copy_bind_group_layout_desc,
             sort_pipeline_id,
             sort_copy_pipeline_id,