bevy/crates/bevy_winit/src
Aevyrie b3aff9a7b1 Add docs and common helper functions to Windows (#4107)
# 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`.
2022-03-08 00:46:04 +00:00
..
converters.rs Added set_cursor_icon(...) to Window (#3395) 2021-12-20 22:04:45 +00:00
lib.rs Add docs and common helper functions to Windows (#4107) 2022-03-08 00:46:04 +00:00
winit_config.rs Reduce power usage with configurable event loop (#3974) 2022-03-07 23:32:05 +00:00
winit_windows.rs Make WinitWindows non send (#4027) 2022-02-24 01:40:02 +00:00