1 unstable release

0.1.0 Mar 26, 2024

#8 in Rendering

Download history 107/week @ 2024-03-21 44/week @ 2024-03-28 42/week @ 2024-04-04 19/week @ 2024-04-11 17/week @ 2024-04-18 26/week @ 2024-04-25 43/week @ 2024-05-02 12/week @ 2024-05-09 46/week @ 2024-05-16

128 downloads per month
Used in bevy_vello

Apache-2.0 OR MIT

215KB
4K SLoC

Velato

An integration to parse and render Lottie with Vello.

Linebender Zulip dependency status MIT/Apache 2.0 vello version

Crates.io Docs Build status

[!WARNING] The goal of this crate is to provide coverage of the large Lottie spec, up to what vello can render, for use in interactive graphics. We are working towards correctness, but there are missing features listed below.

Missing features

Several Lottie features are not yet supported, including:

  • Non-linear easings
  • Position keyframe (ti, to) easing
  • Time remapping (tm)
  • Text
  • Image embedding
  • Advanced shapes (stroke dash, zig-zag, etc.)
  • Advanced effects (motion blur, drop shadows, etc.)
  • Correct color stop handling
  • Split rotations
  • Split positions

Usage

Velato makes it simple to encode Lottie as a vello::Scene.

// Parse your lottie file
let lottie = include_str!("../lottie.json");
let composition = velato::Composition::from_str(lottie).expect("valid file");

// Render to a scene
let mut new_scene = vello::Scene::new();

// Render to a scene!
let mut renderer = velato::Renderer::new();
let frame = 0.0; // Arbitrary number chosen. Ensure it's a valid frame!
let transform = vello::kurbo::Affine::IDENTITY;
let alpha = 1.0;
renderer.render(&composition, frame, transform, alpha, &mut new_scene);

Examples

Cross platform (Winit)

cargo run -p with_winit

You can also load an entire folder or individual files.

cargo run -p with_winit -- examples/assets

Web platform

Because Vello relies heavily on compute shaders, we rely on the emerging WebGPU standard to run on the web. Until browser support becomes widespread, it will probably be necessary to use development browser versions (e.g. Chrome Canary) and explicitly enable WebGPU.

This uses cargo-run-wasm to build the example for web, and host a local server for it

# Make sure the Rust toolchain supports the wasm32 target
rustup target add wasm32-unknown-unknown

# The binary name must also be explicitly provided as it differs from the package name
cargo run_wasm -p with_winit --bin with_winit_bin

There is also a web demo available here on supporting web browsers.

[!WARNING] The web is not currently a primary target for Vello, and WebGPU implementations are incomplete, so you might run into issues running this example.

Community

Discussion of Velato development happens in the Linebender Zulip, specifically the #gpu stream. All public content can be read without logging in.

Contributions are welcome by pull request. The Rust code of conduct applies.

License

Licensed under either of

at your option.

The files in subdirectories of the examples/assets directory are licensed solely under their respective licenses, available in the LICENSE file in their directories.

Contribution

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

Dependencies

~8–40MB
~646K SLoC