bevy
bevy copied to clipboard
document file formats for `bytes` field of `AudioSource`
Objective
Fixes #6299
Solution
Change one line of documentation.
Change LGTM :) Can you update your PR title to explain what was done so it's easier to skim in the commit history?
👋 Could you change your PR title to something that describe the change? The PR title will end up as the commit in git history and it will improve readability of the git log.
Also, do you know if the formats supported depend on the feature flag enabled, or if those are only used when decoding files?
do you know if the formats supported depend on the feature flag enabled, or if those are only used when decoding files?
As far as I know you could store any bytes you would like in the bytes field, but playback won't work if the bytes aren't one of the supported formats and that format is enabled in the feature flag.
You should run cargo fmt --all. Also check if that link to rodio::decoder::Decoder is working in cargo doc.
bors r+
Pull request successfully merged into main.
Build succeeded:
- build-and-install-on-iOS
- build-android
- build (macos-latest)
- build (ubuntu-latest)
- build-wasm
- build (windows-latest)
- build-without-default-features (bevy)
- build-without-default-features (bevy_ecs)
- build-without-default-features (bevy_reflect)
- check-compiles
- check-doc
- check-missing-examples-in-docs
- ci
- markdownlint
- run-examples
- run-examples-on-wasm
- run-examples-on-windows-dx12