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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
// Take a look at the license at the top of the repository in the LICENSE file.
use crate::RGBA;
use glib::{translate::*, IntoGStr};
use std::{fmt, str::FromStr};
#[derive(Debug)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`RGBA`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct RGBABuilder(RGBA);
impl Default for RGBABuilder {
fn default() -> Self {
Self(RGBA::WHITE)
}
}
impl RGBABuilder {
// rustdoc-stripper-ignore-next
/// Create a new [`RGBABuilder`].
pub fn new() -> Self {
Self::default()
}
pub fn blue(mut self, blue: f32) -> Self {
self.0.set_blue(blue);
self
}
pub fn green(mut self, green: f32) -> Self {
self.0.set_green(green);
self
}
pub fn red(mut self, red: f32) -> Self {
self.0.set_red(red);
self
}
pub fn alpha(mut self, alpha: f32) -> Self {
self.0.set_alpha(alpha);
self
}
// rustdoc-stripper-ignore-next
/// Build the [`RGBA`].
#[must_use = "The RGBA returned by this builder should probably be used"]
pub fn build(self) -> RGBA {
self.0
}
}
impl RGBA {
#[inline]
pub const fn new(red: f32, green: f32, blue: f32, alpha: f32) -> Self {
skip_assert_initialized!();
Self {
inner: ffi::GdkRGBA {
red,
green,
blue,
alpha,
},
}
}
// rustdoc-stripper-ignore-next
/// Creates an owned [`RGBA`] like `self` but with the given red value.
///
/// # Example
///
/// ```
/// # use gdk4::RGBA;
///
/// let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
/// assert_eq!(rgba.with_red(0.5), RGBA::new(0.5, 1.0, 1.0, 1.0));
/// ```
#[inline]
pub const fn with_red(self, red: f32) -> Self {
Self {
inner: ffi::GdkRGBA { red, ..self.inner },
}
}
// rustdoc-stripper-ignore-next
/// Creates an owned [`RGBA`] like `self` but with the given green value.
///
/// # Example
///
/// ```
/// # use gdk4::RGBA;
///
/// let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
/// assert_eq!(rgba.with_green(0.5), RGBA::new(1.0, 0.5, 1.0, 1.0));
/// ```
#[inline]
pub const fn with_green(self, green: f32) -> Self {
Self {
inner: ffi::GdkRGBA {
green,
..self.inner
},
}
}
// rustdoc-stripper-ignore-next
/// Creates an owned [`RGBA`] like `self` but with the given blue value.
///
/// # Example
///
/// ```
/// # use gdk4::RGBA;
///
/// let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
/// assert_eq!(rgba.with_blue(0.5), RGBA::new(1.0, 1.0, 0.5, 1.0));
/// ```
#[inline]
pub const fn with_blue(self, blue: f32) -> Self {
Self {
inner: ffi::GdkRGBA { blue, ..self.inner },
}
}
// rustdoc-stripper-ignore-next
/// Creates an owned [`RGBA`] like `self` but with the given alpha value.
///
/// # Example
///
/// ```
/// # use gdk4::RGBA;
///
/// let rgba = RGBA::new(1.0, 1.0, 1.0, 1.0);
/// assert_eq!(rgba.with_alpha(0.5), RGBA::new(1.0, 1.0, 1.0, 0.5));
/// ```
#[inline]
pub const fn with_alpha(self, alpha: f32) -> Self {
Self {
inner: ffi::GdkRGBA {
alpha,
..self.inner
},
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`RGBA`] objects.
///
/// This method returns an instance of [`RGBABuilder`](crate::builders::RGBABuilder) which can be used to create [`RGBA`] objects.
pub fn builder() -> RGBABuilder {
RGBABuilder::default()
}
#[inline]
pub fn red(&self) -> f32 {
self.inner.red
}
#[inline]
pub fn set_red(&mut self, red: f32) {
self.inner.red = red;
}
#[inline]
pub fn green(&self) -> f32 {
self.inner.green
}
#[inline]
pub fn set_green(&mut self, green: f32) {
self.inner.green = green;
}
#[inline]
pub fn blue(&self) -> f32 {
self.inner.blue
}
#[inline]
pub fn set_blue(&mut self, blue: f32) {
self.inner.blue = blue;
}
#[inline]
pub fn alpha(&self) -> f32 {
self.inner.alpha
}
#[inline]
pub fn set_alpha(&mut self, alpha: f32) {
self.inner.alpha = alpha;
}
/// Parses a textual representation of a color.
///
/// The string can be either one of:
///
/// - A standard name (Taken from the CSS specification).
/// - A hexadecimal value in the form “\#rgb”, “\#rrggbb”,
/// “\#rrrgggbbb” or ”\#rrrrggggbbbb”
/// - A hexadecimal value in the form “\#rgba”, “\#rrggbbaa”,
/// or ”\#rrrrggggbbbbaaaa”
/// - A RGB color in the form “rgb(r,g,b)” (In this case the color
/// will have full opacity)
/// - A RGBA color in the form “rgba(r,g,b,a)”
/// - A HSL color in the form "hsl(hue, saturation, lightness)"
/// - A HSLA color in the form "hsla(hue, saturation, lightness, alpha)"
///
/// Where “r”, “g”, “b” and “a” are respectively the red, green,
/// blue and alpha color values. In the last two cases, “r”, “g”,
/// and “b” are either integers in the range 0 to 255 or percentage
/// values in the range 0% to 100%, and a is a floating point value
/// in the range 0 to 1.
/// ## `spec`
/// the string specifying the color
///
/// # Returns
///
/// [`true`] if the parsing succeeded
#[doc(alias = "gdk_rgba_parse")]
pub fn parse(s: impl IntoGStr) -> Result<RGBA, glib::error::BoolError> {
skip_assert_initialized!();
unsafe {
s.run_with_gstr(|s| {
let mut res = RGBA::uninitialized();
glib::result_from_gboolean!(
ffi::gdk_rgba_parse(res.to_glib_none_mut().0, s.as_ptr()),
"Can't parse RGBA"
)
.map(|_| res)
})
}
}
pub const BLACK: RGBA = Self::new(0f32, 0f32, 0f32, 1f32);
pub const BLUE: RGBA = Self::new(0f32, 0f32, 1f32, 1f32);
pub const GREEN: RGBA = Self::new(0f32, 1f32, 0f32, 1f32);
pub const RED: RGBA = Self::new(1f32, 0f32, 0f32, 1f32);
pub const WHITE: RGBA = Self::new(1f32, 1f32, 1f32, 1f32);
pub const TRANSPARENT: RGBA = Self::new(0f32, 0f32, 0f32, 0f32);
}
impl fmt::Debug for RGBA {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("RGBA")
.field("red", &self.red())
.field("green", &self.green())
.field("blue", &self.blue())
.field("alpha", &self.alpha())
.finish()
}
}
impl FromStr for RGBA {
type Err = glib::BoolError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
skip_assert_initialized!();
RGBA::parse(s)
}
}