bevy_mod_opacity
| Crates.io | bevy_mod_opacity |
| lib.rs | bevy_mod_opacity |
| version | 0.5.0 |
| created_at | 2024-10-04 00:07:24.689219+00 |
| updated_at | 2026-01-14 00:41:49.596171+00 |
| description | Hierarchical opacity for bevy. |
| homepage | |
| repository | https://github.com/mintlu8/bevy_mod_opacity |
| max_upload_size | |
| id | 1395837 |
| size | 397,246 |
Mincong Lu (mintlu8)
documentation
README
bevy_mod_opacity
Hierarchical opacity for bevy.
The Opacity component
When Opacity is inserted to an entity, the entity and all its descendants
will be affected by the opacity value. Unlike bevy components like Visibility
Opacity does not need to be put on every entity in the tree.
Entities with no Opacity ancestor will not be affected by this crate.
Support for native types
We innately support 2d, 3d and ui, this includes Sprite, TextColor, StandardMaterial,
ColorMaterial, Image, BackgroundColor and ForegroundColor.
Additionally you can implement OpacityQuery or derive Opacity to make your own types
and materials work with this crate. Combining OpacityQuery with custom QueryData can
add support for third party types.
Fade in and fade out
Call functions like Opacity::fade_in and Opacity::fade_out to fade items in and out via tweening.
fade_out can also be responsible for deleting the entity.
FAQ
- My 3d scene is not fading correctly
Ensure materials are duplicated and unique, since we write to the underlying material directly.
Also make sure AlphaMode is set to Blend if applicable.
Versions
| bevy | bevy_mod_opacity |
|---|---|
| 0.14 | 0.1 |
| 0.15 | 0.2 |
| 0.16 | 0.3 |
License
License 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.
Contribution
Contributions are welcome!
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.