forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Mention that default spawned primary window is spawned with PrimaryWindow marker component (#8752)

Browse Source 
# Objective

Fixes #8751 

## Solution

The doc string for the `primary_window` field on `Window` now mentions
that the default spawned primary window is spawned with the
`PrimaryWindow` marker component.

---------

Co-authored-by: François <mockersf@gmail.com>
This commit is contained in:
Brian Merchant 2023-06-05 13:56:49 -07:00 committed by GitHub
parent 4e25008dd6
commit 25add57614
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_window/src/lib.rs
View File

@ -39,8 +39,8 @@ impl Default for WindowPlugin {
/// A [`Plugin`] that defines an interface for windowing support in Bevy. /// A [`Plugin`] that defines an interface for windowing support in Bevy.
pub struct WindowPlugin { pub struct WindowPlugin {
/// Settings for the primary window. This will be spawned by /// Settings for the primary window. This will be spawned by
/// default, if you want to run without a primary window you should /// default, with the marker component [`PrimaryWindow`](PrimaryWindow).
/// set this to `None`. /// If you want to run without a primary window you should set this to `None`.
/// ///
/// Note that if there are no windows, by default the App will exit, /// Note that if there are no windows, by default the App will exit,
/// due to [`exit_on_all_closed`]. /// due to [`exit_on_all_closed`].