mirror of https://github.com/bevyengine/bevy synced 2024-11-26 06:30:19 +00:00

History

Vitaliy Sapronenko bc445bb5c6 Add feature requirement info to image loading docs (#13712 ) # Objective - Add "Available on crate feature <image format> only." for docs of image format related types/functions - Add warning "WARN bevy_render::texture::image: feature "<image format>" is not enabled" on load attempt - Fixes #13468 . ## Solution - Added #[cfg(feature = "<image format>")] for types and warn!("feature \"<image format>\" is not enabled"); for ImageFormat enum conversions ## Testing ran reproducing example from issue #13468 and saw in logs `WARN bevy_render::texture::image: feature "exr" is not enabled` generated docs with command `RUSTDOCFLAGS="-Zunstable-options --cfg=docsrs" cargo +nightly doc --workspace --all-features --no-deps --document-private-items --open` and saw ![image](https://github.com/bevyengine/bevy/assets/17225606/820262bb-b4e6-4a5e-a306-bddbe9c40852) that docs contain `Available on crate feature <image format> only.` marks ![image](https://github.com/bevyengine/bevy/assets/17225606/57463440-a2ea-435f-a2c2-50d34f7f55a9) ## Migration Guide Image format related entities are feature gated, if there are compilation errors about unknown names there are some of features in list (`exr`, `hdr`, `basis-universal`, `png`, `dds`, `tga`, `jpeg`, `bmp`, `ktx2`, `webp` and `pnm`) should be added.		2024-08-16 23:43:20 +00:00
..
macros	Generate links to definition in source code pages on docs.rs and dev-docs.bevyengine.org (#12965 )	2024-07-29 23:10:16 +00:00
src	Add feature requirement info to image loading docs (#13712 )	2024-08-16 23:43:20 +00:00
Cargo.toml	Update WGPU to version 22 (#14401 )	2024-08-12 16:55:18 +00:00
README.md	Add `README.md` to all crates (#13184 )	2024-05-02 18:56:00 +00:00

README.md

Bevy Render