kywinston / bevy_vello

An integration to render with Vello in Bevy game engine.

Bevy Vello

A vector graphics rendering integration for Bevy game engine using Vello.

Warning

The support of SVG and Lottie is limited. If there is an SVG-related issue, please file the issue in vello_svg. If there is a Lottie-related issue, please file the issue in velato. Please see the respective backends for for more information about limitations.

bevy_vello is a rendering integration for rendering vector graphics in the Bevy game engine. Currently it renders standard vello Scenes, as well as SVG and Lottie files.

Quickstart to run the demo:

cargo run -p demo

It uses several support backends for assets:

• vello_svg - Converting SVG files to a vello Scene
• velato - Converting Lottie files to a vello Scene

Visual inconsistencies discovered should be reported to the respective backend.

Bevy version support

NOTE: You must use a git rev for now, but we are planning a publish. See issue #3.

bevy	bevy_vello
0.13	0.1-0.2, main
< 0.13	unsupported

Features

• Spawn vector graphics rendering in screen-space or world-space coordinates.
• Runtime color swapping of Lottie files with a Theme component.
• Augment playback options with a PlaybackOptions component.
• Limited state machine support with a LottiePlayer component.
• Text
  • NOTE: To avoid conflict with bevy's built-in font loader, rename fonts used by bevy_vello to end with *.vtff. This is a limitation of the bevy game engine, and can probably be an improvement in the future.
• Debug drawing for bounding boxes and origin
• Render immediate-mode vello Scenes

Examples

Cross platform (Bevy)

cargo run -p <demo name>

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 text

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

All Loopy projects and development happens in the Loopy Discord. The discord is open to the public.

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

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.