hanabi_effect_graph 0.1.0

Serializable authoring graph and runtime bake pipeline for bevy_hanabi effects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

//! Edit-time effect graph asset and its bake to a runtime [`EffectAsset`].
//!
//! [`EffectGraphAsset`] is a stable-identity, serializable graph the editor
//! mutates directly and saves to disk. An `EffectAsset` is a *derived* bake
//! output of it (see [`bake`]), used for preview and runtime.
//!
//! This crate is `egui`- and editor-agnostic so it can be used in two ways:
//!
//! - **Offline baking**: a build tool consumes [`EffectGraphAsset`] and
//!   produces an [`EffectAsset`], e.g. through an [`AssetProcessor`]. See the
//!   `bake` example.
//! - **Runtime loading**: a game loads unbaked `EffectGraphAsset` files during
//!   development via [`EffectGraphLoader`] and bakes them in-process.
//!
//! [`EffectAsset`]: bevy_hanabi::EffectAsset
//! [`EffectGraphAsset`]: model::EffectGraphAsset
//! [`AssetProcessor`]: bevy::asset::processor::AssetProcessor

pub mod bake;
pub mod demo;
pub mod import;
pub mod model;
pub mod modifier_names;
pub mod modifier_ops;
pub mod modifier_registry;
pub mod processor;
pub mod schema;
pub mod validation;

mod loader;
mod modifier_group;

pub use loader::{
    EffectGraphLoader, EffectGraphLoaderError, EffectGraphPlugin, MAGIC_HEADER, from_ron_bytes,
    to_ron_string,
};
pub use modifier_group::ModifierGroup;