1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
// Copyright 2022 The peniko authors.
// SPDX-License-Identifier: Apache-2.0 OR MIT
use super::{Color, Extend};
use kurbo::Point;
use smallvec::SmallVec;
use core::{
cmp,
hash::{Hash, Hasher},
};
/// Offset and color of a transition point in a [gradient](Gradient).
#[derive(Copy, Clone, PartialOrd, Default, Debug)]
pub struct ColorStop {
/// Normalized offset of the stop.
pub offset: f32,
/// Color at the specified offset.
pub color: Color,
}
impl Hash for ColorStop {
fn hash<H: Hasher>(&self, state: &mut H) {
self.offset.to_bits().hash(state);
self.color.hash(state);
}
}
// Override PartialEq to use to_bits for the offset to match with the Hash impl
impl cmp::PartialEq for ColorStop {
fn eq(&self, other: &Self) -> bool {
self.offset.to_bits() == other.offset.to_bits() && self.color == other.color
}
}
impl cmp::Eq for ColorStop {}
impl ColorStop {
/// Returns the color stop with the alpha component multiplied by the specified
/// factor.
#[must_use]
pub fn with_alpha_factor(self, alpha: f32) -> Self {
Self {
offset: self.offset,
color: self.color.with_alpha_factor(alpha),
}
}
}
impl From<(f32, Color)> for ColorStop {
fn from(pair: (f32, Color)) -> Self {
Self {
offset: pair.0,
color: pair.1,
}
}
}
/// Collection of color stops.
pub type ColorStops = SmallVec<[ColorStop; 4]>;
/// Properties for the supported [gradient](Gradient) types.
#[derive(Copy, Clone, PartialEq, Debug)]
pub enum GradientKind {
/// Gradient that transitions between two or more colors along a line.
Linear {
/// Starting point.
start: Point,
/// Ending point.
end: Point,
},
/// Gradient that transitions between two or more colors that radiate from an origin.
Radial {
/// Center of start circle.
start_center: Point,
/// Radius of start circle.
start_radius: f32,
/// Center of end circle.
end_center: Point,
/// Radius of end circle.
end_radius: f32,
},
/// Gradient that transitions between two or more colors that rotate around a center
/// point.
Sweep {
/// Center point.
center: Point,
/// Start angle of the sweep, counter-clockwise of the x-axis.
start_angle: f32,
/// End angle of the sweep, counter-clockwise of the x-axis.
end_angle: f32,
},
}
/// Definition of a gradient that transitions between two or more colors.
#[derive(Clone, PartialEq, Debug)]
pub struct Gradient {
/// Kind and properties of the gradient.
pub kind: GradientKind,
/// Extend mode.
pub extend: Extend,
/// Color stop collection.
pub stops: ColorStops,
}
impl Default for Gradient {
fn default() -> Self {
Self {
kind: GradientKind::Linear {
start: Point::default(),
end: Point::default(),
},
extend: Default::default(),
stops: Default::default(),
}
}
}
impl Gradient {
/// Creates a new linear gradient for the specified start and end points.
pub fn new_linear(start: impl Into<Point>, end: impl Into<Point>) -> Self {
Self {
kind: GradientKind::Linear {
start: start.into(),
end: end.into(),
},
extend: Default::default(),
stops: Default::default(),
}
}
/// Creates a new radial gradient for the specified center point and radius.
pub fn new_radial(center: impl Into<Point>, radius: f32) -> Self {
let center = center.into();
Self {
kind: GradientKind::Radial {
start_center: center,
start_radius: 0.0,
end_center: center,
end_radius: radius,
},
extend: Default::default(),
stops: Default::default(),
}
}
/// Creates a new two point radial gradient for the specified center points and radii.
pub fn new_two_point_radial(
start_center: impl Into<Point>,
start_radius: f32,
end_center: impl Into<Point>,
end_radius: f32,
) -> Self {
Self {
kind: GradientKind::Radial {
start_center: start_center.into(),
start_radius,
end_center: end_center.into(),
end_radius,
},
extend: Default::default(),
stops: Default::default(),
}
}
/// Creates a new sweep gradient for the specified center point, start and
/// end angles.
pub fn new_sweep(center: impl Into<Point>, start_angle: f32, end_angle: f32) -> Self {
Self {
kind: GradientKind::Sweep {
center: center.into(),
start_angle,
end_angle,
},
extend: Default::default(),
stops: Default::default(),
}
}
/// Builder method for setting the gradient extend mode.
#[must_use]
pub fn with_extend(mut self, mode: Extend) -> Self {
self.extend = mode;
self
}
/// Builder method for setting the color stop collection.
#[must_use]
pub fn with_stops(mut self, stops: impl ColorStopsSource) -> Self {
self.stops.clear();
stops.collect_stops(&mut self.stops);
self
}
}
/// Trait for types that represent a source of color stops.
pub trait ColorStopsSource {
fn collect_stops(&self, vec: &mut SmallVec<[ColorStop; 4]>);
}
impl<T> ColorStopsSource for &'_ [T]
where
T: Into<ColorStop> + Copy,
{
fn collect_stops(&self, vec: &mut SmallVec<[ColorStop; 4]>) {
for &stop in *self {
vec.push(stop.into());
}
}
}
impl<T, const N: usize> ColorStopsSource for [T; N]
where
T: Into<ColorStop> + Copy,
{
fn collect_stops(&self, vec: &mut SmallVec<[ColorStop; 4]>) {
for stop in *self {
vec.push(stop.into());
}
}
}
impl ColorStopsSource for &'_ [Color] {
fn collect_stops(&self, vec: &mut SmallVec<[ColorStop; 4]>) {
if !self.is_empty() {
let denom = (self.len() - 1).max(1) as f32;
vec.extend(self.iter().enumerate().map(|(i, c)| ColorStop {
offset: (i as f32) / denom,
color: *c,
}));
}
}
}
impl<const N: usize> ColorStopsSource for [Color; N] {
fn collect_stops(&self, vec: &mut SmallVec<[ColorStop; 4]>) {
(&self[..]).collect_stops(vec);
}
}