mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 15:14:50 +00:00
b3aff9a7b1
# Objective
- Improve documentation.
- Provide helper functions for common uses of `Windows` relating to getting the primary `Window`.
- Reduce repeated `Window` code.
# Solution
- Adds infallible `primary()` and `primary_mut()` functions with standard error text. This replaces the commonly used `get_primary().unwrap()` seen throughout bevy which has inconsistent or nonexistent error messages.
- Adds `scale_factor(WindowId)` to replace repeated code blocks throughout.
# Considerations
- The added functions can panic if the primary window does not exist.
- It is very uncommon for the primary window to not exist, as seen by the regular use of `get_primary().unwrap()`. Most users will have a single window and will need to reference the primary window in their code multiple times.
- The panic provides a consistent error message to make this class of error easy to spot from the panic text.
- This follows the established standard of short names for infallible-but-unlikely-to-panic functions in bevy.
- Removes line noise for common usage of `Windows`.
|
||
|---|---|---|
| .. | ||
| bevy_ios_example.xcodeproj | ||
| ios-src | ||
| src | ||
| .gitignore | ||
| build_rust_deps.sh | ||
| Cargo.toml | ||
| Makefile | ||