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

Update ClearColor Resource docs (#3842)

Browse Source 
# Objective
- Update the `ClearColor` resource docs as described in #3837  so new users (like me) understand it better

## Solution
- Update the docs to use what @alice-i-cecile described in #3837 


I took this one up because I got confused by it this weekend. I didn't understand why the  "background" was being set by a `ClearColor` resource.
This commit is contained in:
Andrew Jackson 2022-02-02 21:29:48 +00:00
parent f991c73bdf
commit 6cab36165f
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/bevy_core_pipeline/src/lib.rs
View File

@ -35,7 +35,10 @@ use bevy_render::{
RenderApp, RenderStage, RenderWorld, RenderApp, RenderStage, RenderWorld,
}; };
/// Resource that configures the clear color /// When used as a resource, sets the color that is used to clear the screen between frames.
///
/// This color appears as the "background" color for simple apps, when
/// there are portions of the screen with nothing rendered.
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct ClearColor(pub Color); pub struct ClearColor(pub Color);