Comments (6)
Worth noting that this issue is true across the board. If you have hdr enabled but not png, and try to load a .png (say, if you're writing an example for a bevy plugin that itself does not require png support), then you get a cryptic error message about the .hdr loading failing.
There should probably be feature flag checks in the loader that just say "this feature is not enabled" when you try to load an image type you don't have the feature for.
from bevy.
#[cfg_attr(docsrs, doc(cfg(feature = "exr")))]
on what is behind the feature should mark it in docs.rs
rust-lang/rust#43781
from bevy.
I tried your example, it doesn't load exr if I don't enable exr
feature
bevy = { version = "0.13.2" }
But if enable it, example doesn't print any error
bevy = { version = "0.13.2", features = ["exr"] }
@cshenton-work That because this feature affects loader initialization here
@alice-i-cecile Do we need make some note in docs anywere or we should just close issue?
from bevy.
I think ImageFormat or ExrTextureLoader are good places for such note
In case of ImageFormat note should include mention of exr, hdr, basis-universal, png, dds, tga, jpeg, bmp, ktx2, webp and pnm feature
from bevy.
@mockersf Please, help: I added attributes
/// Loads EXR textures as Texture assets
#[derive(Clone, Default)]
#[cfg(feature = "exr")]
#[cfg_attr(docsrs, doc(cfg(feature = "exr")))]
pub struct ExrTextureLoader;
and at fields
Gif,
#[cfg_attr(docsrs, doc(cfg(feature = "exr")))]
OpenExr,
then ran command
cargo doc --workspace --all-features --no-deps --document-private-items --open
and saw that nothing changes
What did I wrong? Or maybe this rustdoc feature is not ready yet?
from bevy.
@mockersf Please, help: I added attributes
What did I wrong? Or maybe this rustdoc feature is not ready yet?
Sorry, missed your message
I think you need to add RUSTDOCFLAGS: -Zunstable-options --cfg=docsrs
as an environment variable to build docs as docs.rs, and use a nightly version of rust
from bevy.
Related Issues (20)
- Allow one-shot systems to be replaced, re-using the same SystemId
- Log window/monitor info on startup HOT 1
- Regression on string representation of entities HOT 2
- `bevy_log` expose `tracing_subscriber::Layer::set_ansi`
- Lights by default affect all but the first RenderLayers ? HOT 2
- Commands.register_system
- [Docs] Add example to demonstrate how to use skinning and morph with custom vertex shaders HOT 1
- macOS asks for permission to use the microphone HOT 7
- `AnyOf` can violate single mutable alias rule HOT 2
- `AnyOf` does not behave correctly with `()` params HOT 4
- Bevy should capture Ctrl+C, send AppExit event
- Make cargo clippy and cargo fmt pre-commit hooks HOT 4
- SubApp::extract cannot be called due to borrow checker HOT 5
- Can't upgrade to 0.14, impossible to render `AlphaMask3d` phase items without mesh HOT 2
- Support the `<verb>_parent_in_place()` API for operating on parents instead of children
- lldb hangs 1-2s whenever I press Ctrl+key or Cmd+key for the first time on Mac (since winit v0.30) HOT 1
- "Error: could not compile `bevy_core_pipeline` (lib)" in CI due to SIGSEGV: invalid memory reference HOT 2
- Transform changes after PostUpdate are not reflected in render HOT 2
- Allow rotating the skybox/environment map
- Rename bevy_core::name::DebugName to better fit its implementation HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from bevy.