Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-21 20:23:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add docs for how to manually add a WinitPlugin to a MinimalPlugins setup. (#15989)

Browse source 
# Objective

Adding a `WinitPlugin` to a `MinimalPlugins` setup is a bit tricky and
confusing due to having a terrible error message and no examples in the
repo.

## Solution

Document what you need to add.
This commit is contained in:
Elabajaba 2024-10-19 17:44:02 -04:00 committed by GitHub
parent 74dedb2841
commit 8f31c09e60
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
crates/bevy_winit/src/lib.rs
View file

@ -59,6 +59,9 @@ mod winit_windows;
/// ///
/// The `T` event type can be used to pass custom events to the `winit`'s loop, and handled as events /// The `T` event type can be used to pass custom events to the `winit`'s loop, and handled as events
/// in systems. /// in systems.
///
/// When using eg. `MinimalPlugins` you can add this using `WinitPlugin::<WakeUp>::default()`, where
/// `WakeUp` is the default `Event` that bevy uses.
#[derive(Default)] #[derive(Default)]
pub struct WinitPlugin<T: Event = WakeUp> { pub struct WinitPlugin<T: Event = WakeUp> {
/// Allows the window (and the event loop) to be created on any thread /// Allows the window (and the event loop) to be created on any thread