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

Small fixes for gradient docs (#19388)

Browse Source 
# Objective

Found a typo while looking at gradients in another issue and gave the
docs a skim for more.

## Solution

A couple typo fixes and some tiny improvements
This commit is contained in:
Rob Parrett 2025-05-26 16:20:24 -07:00 committed by GitHub
parent 1e1853b876
commit 0ff44c9493
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/bevy_ui/src/gradients.rs
View File

@ -43,7 +43,7 @@ impl ColorStop {
} }
} }
// Set the interpolation midpoint between this and and the following stop // Set the interpolation midpoint between this and the following stop
pub fn with_hint(mut self, hint: f32) -> Self { pub fn with_hint(mut self, hint: f32) -> Self {
self.hint = hint; self.hint = hint;
self self
@ -155,7 +155,7 @@ impl AngularColorStop {
} }
} }
// Set the interpolation midpoint between this and and the following stop // Set the interpolation midpoint between this and the following stop
pub fn with_hint(mut self, hint: f32) -> Self { pub fn with_hint(mut self, hint: f32) -> Self {
self.hint = hint; self.hint = hint;
self self
@ -213,8 +213,8 @@ impl Default for AngularColorStop {
reflect(Serialize, Deserialize) reflect(Serialize, Deserialize)
)] )]
pub struct LinearGradient { pub struct LinearGradient {
/// The direction of the gradient. /// The direction of the gradient in radians.
/// An angle of `0.` points upward, angles increasing clockwise. /// An angle of `0.` points upward, with the value increasing in the clockwise direction.
pub angle: f32, pub angle: f32,
/// The list of color stops /// The list of color stops
pub stops: Vec<ColorStop>, pub stops: Vec<ColorStop>,
@ -376,7 +376,7 @@ pub struct ConicGradient {
} }
impl ConicGradient { impl ConicGradient {
/// create a new conic gradient /// Create a new conic gradient
pub fn new(position: Position, stops: Vec<AngularColorStop>) -> Self { pub fn new(position: Position, stops: Vec<AngularColorStop>) -> Self {
Self { Self {
start: 0., start: 0.,
@ -385,7 +385,7 @@ impl ConicGradient {
} }
} }
/// Sets the starting angle of the gradient /// Sets the starting angle of the gradient in radians
pub fn with_start(mut self, start: f32) -> Self { pub fn with_start(mut self, start: f32) -> Self {
self.start = start; self.start = start;
self self
@ -430,7 +430,7 @@ impl Gradient {
} }
} }
/// If the gradient has only a single color stop `get_single` returns its color. /// If the gradient has only a single color stop, `get_single` returns its color.
pub fn get_single(&self) -> Option<Color> { pub fn get_single(&self) -> Option<Color> {
match self { match self {
Gradient::Linear(gradient) => gradient Gradient::Linear(gradient) => gradient