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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
use core::{
any::TypeId,
fmt,
fmt::Debug,
marker::PhantomData,
num::ParseIntError,
ops::{Add, Div},
str::FromStr,
};
use crate::{
alpha::Alpha,
angle::{RealAngle, UnsignedAngle},
bool_mask::{BitOps, HasBoolMask, LazySelect},
cast::{ComponentOrder, Packed},
color_difference::Wcag21RelativeContrast,
convert::{FromColorUnclamped, IntoColorUnclamped},
encoding::{FromLinear, IntoLinear, Linear, Srgb},
luma::LumaStandard,
matrix::{matrix_inverse, matrix_map, multiply_xyz_to_rgb, rgb_to_xyz_matrix},
num::{
Abs, Arithmetics, FromScalar, IsValidDivisor, MinMax, One, PartialCmp, Real, Recip, Round,
Trigonometry, Zero,
},
oklab::oklab_to_linear_srgb,
rgb::{RgbSpace, RgbStandard},
stimulus::{FromStimulus, Stimulus, StimulusColor},
white_point::{Any, WhitePoint, D65},
FromColor, GetHue, Hsl, Hsv, IntoColor, Luma, Oklab, RgbHue, Xyz, Yxy,
};
use super::Primaries;
/// Generic RGB with an alpha component. See the [`Rgba` implementation in
/// `Alpha`](crate::Alpha#Rgba).
pub type Rgba<S = Srgb, T = f32> = Alpha<Rgb<S, T>, T>;
/// Generic RGB.
///
/// RGB is probably the most common color space, when it comes to computer
/// graphics, and it's defined as an additive mixture of red, green and blue
/// light, where gray scale colors are created when these three channels are
/// equal in strength.
///
/// # Creating a Value
///
/// RGB comes in different shapes and formats. You will probably want to start
/// with either the [`Srgb`](crate::Srgb) or [`Srgba`](crate::Srgba) alias,
/// which represents the common sRGB format that most images and tools use.
/// Then, depending on your input, you can either just call [`new`](Rgb::new) or
/// convert from another data format.
///
/// ```
/// use palette::Srgb;
///
/// let rgb_u8 = Srgb::new(171u8, 193, 35);
/// let rgb_f32 = Srgb::new(0.3f32, 0.8, 0.1);
///
/// // `new` is also `const`:
/// const RGB_U8: Srgb<u8> = Srgb::new(171, 193, 35);
///
/// // Converting from one number format to another can be as simple as this:
/// let rgb_u8_from_f32_1: Srgb<u8> = Srgb::new(0.3f32, 0.8, 0.1).into();
///
/// // ...or more explicitly like this:
/// let rgb_u8_from_f32_2 = Srgb::new(0.3f32, 0.8, 0.1).into_format::<u8>();
///
/// // Hexadecimal is also supported, with or without the #:
/// let rgb_from_hex1: Srgb<u8> = "#f034e6".parse().unwrap();
/// let rgb_from_hex2: Srgb<u8> = "f034e6".parse().unwrap();
/// assert_eq!(rgb_from_hex1, rgb_from_hex2);
///
/// // This includes the shorthand format:
/// let rgb_from_short_hex: Srgb<u8> = "f3e".parse().unwrap();
/// let rgb_from_long_hex: Srgb<u8> = "ff33ee".parse().unwrap();
/// assert_eq!(rgb_from_short_hex, rgb_from_long_hex);
///
/// // It's also possible to convert from (and to) arrays, tuples and `u32` values:
/// let rgb_from_array = Srgb::from([171u8, 193, 35]);
/// let rgb_from_tuple = Srgb::from((171u8, 193, 35));
/// let rgb_from_u32 = Srgb::from(0x607F00);
/// ```
///
/// # Linear, sRGB and Gamma Correction
///
/// Many conversions and operations on RGB require that it's linear, meaning
/// that gamma correction is required when converting to and from displayable
/// RGB, such as sRGB. It's common to store and send RGB values where the
/// numbers are on a non-linear scale. In a non-linear format, a value of, for
/// example, 0.5 would not represent a light intensity of 50%, which makes some
/// operations (such as blurring) give incorrect results.
///
/// You will probably encounter or use [`LinSrgb`](crate::LinSrgb) or
/// [`LinSrgba`](crate::LinSrgba) at some point. These are aliases for linear
/// sRGB and would usually be obtained by converting an [`Srgb`] value with
/// [`into_linear`](Rgb::into_linear).
///
/// ```no_run
/// use palette::{LinSrgb, Srgb};
///
/// // This function uses linear sRGB for something. But how do we interface with it?
/// fn uses_linear_srgb(input: LinSrgb<f32>) -> LinSrgb<f32> { todo!() }
///
/// // Linear sRGB will usually be created from non-linear sRGB:
/// let output = uses_linear_srgb(Srgb::new(0.3, 0.8, 0.1).into_linear());
///
/// // It's also possible to convert directly from u8 to f32 for sRGB.
/// // This is much faster than using `into_format` first:
/// let output = uses_linear_srgb(Srgb::new(171u8, 193, 35).into_linear());
///
/// // Converting the output back to `Srgb<u8>` (or `Srgb<f32>`) is just as simple:
/// let output_u8 = Srgb::<u8>::from_linear(output);
/// // ..or:
/// let output_u8: Srgb<u8> = output.into_encoding();
/// ```
///
/// It's of course also possible to create a linear value from constants, but
/// it's not necessarily as intuitive. It's best to avoid storing them as
/// `LinSrgb<u8>` (or `LinRgb<_, u8>`) values, to avoid banding among dark
/// colors.
///
/// See the [`encoding`](crate::encoding) module for built-in encoding formats.
///
/// # Storage Formats and Pixel Buffers
///
/// It's common to read and write RGB values as bytes, hexadecimal strings, or
/// sometimes `u32` values. A single RGB value can be converted to all of these
/// formats and more.
///
/// ```no_run
/// use palette::{Srgb, LinSrgb};
///
/// let source: LinSrgb<f32> = todo!();
///
/// let u8_array: [u8; 3] = Srgb::from_linear(source).into();
/// let hex_string1 = format!("#{:x}", Srgb::<u8>::from_linear(source)); // The # is optional.
/// let u32_value: u32 = Srgb::from_linear(source).into();
/// ```
///
/// It's also possible to control the component order.
/// [`PackedArgb`](crate::rgb::PackedArgb) is one of a few aliases for
/// [`Packed`], which represents a color that has been "packed" into a specific
/// data format. This can be a `u32` or `[u8; 4]`, for example. This is helpful
/// for reading and writing colors with a different order than the default RGBA.
///
/// ```no_run
/// use palette::{rgb::PackedArgb, Srgba, LinSrgba};
///
/// let source: LinSrgba<f32> = todo!();
///
/// let u8_array: [u8; 4] = PackedArgb::from(Srgba::from_linear(source)).into();
/// let u32_value: u32 = PackedArgb::from(Srgba::from_linear(source)).into();
/// ```
///
/// If you need to work with colors in a byte buffer, such as `[u8]`, `Vec<u8>`
/// or the `image` crate, there's a quick way to borrow that buffer as a slice
/// of RGB(A) colors. The [`cast`](crate::cast) module has a number of traits
/// and functions for casting values without copying them.
///
/// ```no_run
/// use image::RgbImage;
/// use palette::{cast::ComponentsAsMut, Srgb};
///
/// let mut image: RgbImage = todo!();
/// let pixels: &mut [Srgb<u8>] = image.components_as_mut();
///
/// for pixel in pixels {
/// std::mem::swap(&mut pixel.red, &mut pixel.blue);
/// }
/// ```
#[derive(Debug, ArrayCast, FromColorUnclamped, WithAlpha)]
#[cfg_attr(feature = "serializing", derive(Serialize, Deserialize))]
#[palette(
palette_internal,
rgb_standard = "S",
component = "T",
skip_derives(Xyz, Hsv, Hsl, Luma, Rgb, Oklab)
)]
#[repr(C)]
pub struct Rgb<S = Srgb, T = f32> {
/// The amount of red light, where 0.0 is no red light and 1.0 (or 255u8) is
/// the highest displayable amount.
pub red: T,
/// The amount of green light, where 0.0 is no green light and 1.0 (or
/// 255u8) is the highest displayable amount.
pub green: T,
/// The amount of blue light, where 0.0 is no blue light and 1.0 (or 255u8)
/// is the highest displayable amount.
pub blue: T,
/// The kind of RGB standard. sRGB is the default.
#[cfg_attr(feature = "serializing", serde(skip))]
#[palette(unsafe_zero_sized)]
pub standard: PhantomData<S>,
}
impl<S, T> Rgb<S, T> {
/// Create an RGB color.
///
/// It's possible to create a color in one number format and convert it to
/// another format with either [`into_format`](Rgb::into_format) or
/// [`into_linear`](Rgb::into_linear).
///
/// ```
/// use palette::{Srgb, LinSrgb};
///
/// // Changes only the number format:
/// let rgb_f32: Srgb<f32> = Srgb::new(171u8, 193, 35).into_format();
///
/// // Changes the number format and converts to linear in one go.
/// // This is faster than `.into_format().into_linear()`:
/// let linear: LinSrgb<f32> = Srgb::new(171u8, 193, 35).into_linear();
/// ```
pub const fn new(red: T, green: T, blue: T) -> Rgb<S, T> {
Rgb {
red,
green,
blue,
standard: PhantomData,
}
}
/// Convert the RGB components into another number type.
///
/// ```
/// use palette::Srgb;
///
/// let rgb_u8: Srgb<u8> = Srgb::new(0.3, 0.7, 0.2).into_format();
/// ```
///
/// See also [`into_linear`](Rgb::into_linear) and
/// [`into_encoding`](Rgb::into_encoding) for a faster option if you need to
/// change between linear and non-linear encoding at the same time.
pub fn into_format<U>(self) -> Rgb<S, U>
where
U: FromStimulus<T>,
{
Rgb {
red: U::from_stimulus(self.red),
green: U::from_stimulus(self.green),
blue: U::from_stimulus(self.blue),
standard: PhantomData,
}
}
/// Convert the RGB components from another number type.
///
/// ```
/// use palette::Srgb;
///
/// let rgb_u8 = Srgb::<u8>::from_format(Srgb::new(0.3, 0.7, 0.2));
/// ```
///
/// See also [`from_linear`](Rgb::from_linear) and
/// [`from_encoding`](Rgb::from_encoding) for a faster option if you need to
/// change between linear and non-linear encoding at the same time.
pub fn from_format<U>(color: Rgb<S, U>) -> Self
where
T: FromStimulus<U>,
{
color.into_format()
}
/// Convert to a `(red, green, blue)` tuple.
pub fn into_components(self) -> (T, T, T) {
(self.red, self.green, self.blue)
}
/// Convert from a `(red, green, blue)` tuple.
pub fn from_components((red, green, blue): (T, T, T)) -> Self {
Self::new(red, green, blue)
}
}
impl<S, T> Rgb<S, T>
where
T: Stimulus,
{
/// Return the `red` value minimum.
pub fn min_red() -> T {
T::zero()
}
/// Return the `red` value maximum.
pub fn max_red() -> T {
T::max_intensity()
}
/// Return the `green` value minimum.
pub fn min_green() -> T {
T::zero()
}
/// Return the `green` value maximum.
pub fn max_green() -> T {
T::max_intensity()
}
/// Return the `blue` value minimum.
pub fn min_blue() -> T {
T::zero()
}
/// Return the `blue` value maximum.
pub fn max_blue() -> T {
T::max_intensity()
}
}
impl<S> Rgb<S, u8> {
/// Convert to a packed `u32` with with specifiable component order.
///
/// ```
/// use palette::{rgb, Srgb};
///
/// let integer = Srgb::new(96u8, 127, 0).into_u32::<rgb::channels::Rgba>();
/// assert_eq!(0x607F00FF, integer);
/// ```
///
/// It's also possible to use `From` and `Into`, which defaults to the
/// `0xAARRGGBB` component order:
///
/// ```
/// use palette::Srgb;
///
/// let integer = u32::from(Srgb::new(96u8, 127, 0));
/// assert_eq!(0xFF607F00, integer);
/// ```
///
/// See [Packed](crate::cast::Packed) for more details.
#[inline]
pub fn into_u32<O>(self) -> u32
where
O: ComponentOrder<Rgba<S, u8>, u32>,
{
O::pack(Rgba::from(self))
}
/// Convert from a packed `u32` with specifiable component order.
///
/// ```
/// use palette::{rgb, Srgb};
///
/// let rgb = Srgb::from_u32::<rgb::channels::Rgba>(0x607F00FF);
/// assert_eq!(Srgb::new(96u8, 127, 0), rgb);
/// ```
///
/// It's also possible to use `From` and `Into`, which defaults to the
/// `0xAARRGGBB` component order:
///
/// ```
/// use palette::Srgb;
///
/// let rgb = Srgb::from(0x607F00);
/// assert_eq!(Srgb::new(96u8, 127, 0), rgb);
/// ```
///
/// See [Packed](crate::cast::Packed) for more details.
#[inline]
pub fn from_u32<O>(color: u32) -> Self
where
O: ComponentOrder<Rgba<S, u8>, u32>,
{
O::unpack(color).color
}
}
impl<S: RgbStandard, T> Rgb<S, T> {
/// Convert the color to linear RGB.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgb, LinSrgb};
///
/// let linear: LinSrgb<f32> = Srgb::new(96u8, 127, 0).into_linear();
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
#[inline(always)]
pub fn into_linear<U>(self) -> Rgb<Linear<S::Space>, U>
where
S::TransferFn: IntoLinear<U, T>,
{
Rgb::new(
S::TransferFn::into_linear(self.red),
S::TransferFn::into_linear(self.green),
S::TransferFn::into_linear(self.blue),
)
}
/// Convert linear RGB to non-linear RGB.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgb, LinSrgb};
///
/// let encoded = Srgb::<u8>::from_linear(LinSrgb::new(0.95f32, 0.90, 0.30));
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
#[inline(always)]
pub fn from_linear<U>(color: Rgb<Linear<S::Space>, U>) -> Self
where
S::TransferFn: FromLinear<U, T>,
{
Rgb::new(
S::TransferFn::from_linear(color.red),
S::TransferFn::from_linear(color.green),
S::TransferFn::from_linear(color.blue),
)
}
}
impl<S: RgbSpace, T> Rgb<Linear<S>, T> {
/// Convert a linear color to a different encoding.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgb, LinSrgb};
///
/// let encoded: Srgb<u8> = LinSrgb::new(0.95f32, 0.90, 0.30).into_encoding();
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
pub fn into_encoding<U, St>(self) -> Rgb<St, U>
where
St: RgbStandard<Space = S>,
St::TransferFn: FromLinear<T, U>,
{
Rgb::<St, U>::from_linear(self)
}
/// Convert linear RGB from a different encoding.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgb, LinSrgb};
///
/// let linear = LinSrgb::<f32>::from_encoding(Srgb::new(96u8, 127, 0));
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
pub fn from_encoding<U, St>(color: Rgb<St, U>) -> Self
where
St: RgbStandard<Space = S>,
St::TransferFn: IntoLinear<T, U>,
{
color.into_linear()
}
}
impl<S, T> Rgb<S, T>
where
S: RgbStandard,
{
#[inline]
pub(crate) fn reinterpret_as<St>(self) -> Rgb<St, T>
where
S::Space: RgbSpace<WhitePoint = <St::Space as RgbSpace>::WhitePoint>,
St: RgbStandard,
{
Rgb {
red: self.red,
green: self.green,
blue: self.blue,
standard: PhantomData,
}
}
}
/// <span id="Rgba"></span>[`Rgba`](crate::rgb::Rgba) implementations.
impl<S, T, A> Alpha<Rgb<S, T>, A> {
/// Non-linear RGB.
pub const fn new(red: T, green: T, blue: T, alpha: A) -> Self {
Alpha {
color: Rgb::new(red, green, blue),
alpha,
}
}
/// Convert the RGBA components into other number types.
///
/// ```
/// use palette::Srgba;
///
/// let rgba_u8: Srgba<u8> = Srgba::new(0.3, 0.7, 0.2, 0.5).into_format();
/// ```
///
/// See also `into_linear` and `into_encoding` for a faster option if you
/// need to change between linear and non-linear encoding at the same time.
pub fn into_format<U, B>(self) -> Alpha<Rgb<S, U>, B>
where
U: FromStimulus<T>,
B: FromStimulus<A>,
{
Alpha {
color: self.color.into_format(),
alpha: B::from_stimulus(self.alpha),
}
}
/// Convert the RGBA components from other number types.
///
/// ```
/// use palette::Srgba;
///
/// let rgba_u8 = Srgba::<u8>::from_format(Srgba::new(0.3, 0.7, 0.2, 0.5));
/// ```
///
/// See also `from_linear` and `from_encoding` for a faster option if you
/// need to change between linear and non-linear encoding at the same time.
pub fn from_format<U, B>(color: Alpha<Rgb<S, U>, B>) -> Self
where
T: FromStimulus<U>,
A: FromStimulus<B>,
{
color.into_format()
}
/// Convert to a `(red, green, blue, alpha)` tuple.
pub fn into_components(self) -> (T, T, T, A) {
(
self.color.red,
self.color.green,
self.color.blue,
self.alpha,
)
}
/// Convert from a `(red, green, blue, alpha)` tuple.
pub fn from_components((red, green, blue, alpha): (T, T, T, A)) -> Self {
Self::new(red, green, blue, alpha)
}
}
impl<S> Rgba<S, u8> {
/// Convert to a packed `u32` with with specifiable component order.
///
/// ```
/// use palette::{rgb, Srgba};
///
/// let integer = Srgba::new(96u8, 127, 0, 255).into_u32::<rgb::channels::Argb>();
/// assert_eq!(0xFF607F00, integer);
/// ```
///
/// It's also possible to use `From` and `Into`, which defaults to the
/// `0xRRGGBBAA` component order:
///
/// ```
/// use palette::Srgba;
///
/// let integer = u32::from(Srgba::new(96u8, 127, 0, 255));
/// assert_eq!(0x607F00FF, integer);
/// ```
///
/// See [Packed](crate::cast::Packed) for more details.
#[inline]
pub fn into_u32<O>(self) -> u32
where
O: ComponentOrder<Rgba<S, u8>, u32>,
{
O::pack(self)
}
/// Convert from a packed `u32` with specifiable component order.
///
/// ```
/// use palette::{rgb, Srgba};
///
/// let rgba = Srgba::from_u32::<rgb::channels::Argb>(0xFF607F00);
/// assert_eq!(Srgba::new(96u8, 127, 0, 255), rgba);
/// ```
///
/// It's also possible to use `From` and `Into`, which defaults to the
/// `0xRRGGBBAA` component order:
///
/// ```
/// use palette::Srgba;
///
/// let rgba = Srgba::from(0x607F00FF);
/// assert_eq!(Srgba::new(96u8, 127, 0, 255), rgba);
/// ```
///
/// See [Packed](crate::cast::Packed) for more details.
#[inline]
pub fn from_u32<O>(color: u32) -> Self
where
O: ComponentOrder<Rgba<S, u8>, u32>,
{
O::unpack(color)
}
}
impl<S: RgbStandard, T, A> Alpha<Rgb<S, T>, A> {
/// Convert the color to linear RGB with transparency.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgba, LinSrgba};
///
/// let linear: LinSrgba<f32> = Srgba::new(96u8, 127, 0, 38).into_linear();
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
pub fn into_linear<U, B>(self) -> Alpha<Rgb<Linear<S::Space>, U>, B>
where
S::TransferFn: IntoLinear<U, T>,
B: FromStimulus<A>,
{
Alpha {
color: self.color.into_linear(),
alpha: B::from_stimulus(self.alpha),
}
}
/// Convert linear RGB to non-linear RGB with transparency.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgba, LinSrgba};
///
/// let encoded = Srgba::<u8>::from_linear(LinSrgba::new(0.95f32, 0.90, 0.30, 0.75));
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
pub fn from_linear<U, B>(color: Alpha<Rgb<Linear<S::Space>, U>, B>) -> Self
where
S::TransferFn: FromLinear<U, T>,
A: FromStimulus<B>,
{
Alpha {
color: Rgb::from_linear(color.color),
alpha: A::from_stimulus(color.alpha),
}
}
}
impl<S: RgbSpace, T, A> Alpha<Rgb<Linear<S>, T>, A> {
/// Convert a linear color to a different encoding with transparency.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgba, LinSrgba};
///
/// let encoded: Srgba<u8> = LinSrgba::new(0.95f32, 0.90, 0.30, 0.75).into_encoding();
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
pub fn into_encoding<U, B, St>(self) -> Alpha<Rgb<St, U>, B>
where
St: RgbStandard<Space = S>,
St::TransferFn: FromLinear<T, U>,
B: FromStimulus<A>,
{
Alpha::<Rgb<St, U>, B>::from_linear(self)
}
/// Convert RGB from a different encoding to linear with transparency.
///
/// Some transfer functions allow the component type to be converted at the
/// same time. This is usually offered with increased performance, compared
/// to using [`into_format`][Rgb::into_format].
///
/// ```
/// use palette::{Srgba, LinSrgba};
///
/// let linear = LinSrgba::<f32>::from_encoding(Srgba::new(96u8, 127, 0, 38));
/// ```
///
/// See the transfer function types in the [`encoding`](crate::encoding)
/// module for details and performance characteristics.
pub fn from_encoding<U, B, St>(color: Alpha<Rgb<St, U>, B>) -> Self
where
St: RgbStandard<Space = S>,
St::TransferFn: IntoLinear<T, U>,
A: FromStimulus<B>,
{
color.into_linear()
}
}
impl_reference_component_methods!(Rgb<S>, [red, green, blue], standard);
impl_struct_of_arrays_methods!(Rgb<S>, [red, green, blue], standard);
impl<S1, S2, T> FromColorUnclamped<Rgb<S2, T>> for Rgb<S1, T>
where
S1: RgbStandard + 'static,
S2: RgbStandard + 'static,
S1::TransferFn: FromLinear<T, T>,
S2::TransferFn: IntoLinear<T, T>,
S2::Space: RgbSpace<WhitePoint = <S1::Space as RgbSpace>::WhitePoint>,
Xyz<<S2::Space as RgbSpace>::WhitePoint, T>: FromColorUnclamped<Rgb<S2, T>>,
Rgb<S1, T>: FromColorUnclamped<Xyz<<S1::Space as RgbSpace>::WhitePoint, T>>,
{
fn from_color_unclamped(rgb: Rgb<S2, T>) -> Self {
let rgb_space1 = TypeId::of::<<S1::Space as RgbSpace>::Primaries>();
let rgb_space2 = TypeId::of::<<S2::Space as RgbSpace>::Primaries>();
if TypeId::of::<S1>() == TypeId::of::<S2>() {
rgb.reinterpret_as()
} else if rgb_space1 == rgb_space2 {
Self::from_linear(rgb.into_linear().reinterpret_as())
} else {
Self::from_color_unclamped(Xyz::from_color_unclamped(rgb))
}
}
}
impl<S, T> FromColorUnclamped<Xyz<<S::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T>
where
S: RgbStandard,
S::TransferFn: FromLinear<T, T>,
<S::Space as RgbSpace>::Primaries: Primaries<T::Scalar>,
<S::Space as RgbSpace>::WhitePoint: WhitePoint<T::Scalar>,
T: Arithmetics + FromScalar,
T::Scalar: Real
+ Recip
+ IsValidDivisor<Mask = bool>
+ Arithmetics
+ Clone
+ FromScalar<Scalar = T::Scalar>,
Yxy<Any, T::Scalar>: IntoColorUnclamped<Xyz<Any, T::Scalar>>,
{
fn from_color_unclamped(color: Xyz<<S::Space as RgbSpace>::WhitePoint, T>) -> Self {
let transform_matrix = S::Space::xyz_to_rgb_matrix().map_or_else(
|| matrix_inverse(rgb_to_xyz_matrix::<S::Space, T::Scalar>()),
|matrix| matrix_map(matrix, T::Scalar::from_f64),
);
Self::from_linear(multiply_xyz_to_rgb(transform_matrix, color))
}
}
impl<S, T> FromColorUnclamped<Hsl<S, T>> for Rgb<S, T>
where
T: Real
+ RealAngle
+ UnsignedAngle
+ Zero
+ One
+ Abs
+ Round
+ PartialCmp
+ Arithmetics
+ Clone,
T::Mask: LazySelect<T> + BitOps + Clone,
{
fn from_color_unclamped(hsl: Hsl<S, T>) -> Self {
let c = (T::one() - (hsl.lightness.clone() * T::from_f64(2.0) - T::one()).abs())
* hsl.saturation;
let h = hsl.hue.into_positive_degrees() / T::from_f64(60.0);
// We avoid using %, since it's not always (or never?) supported in SIMD
let h_mod_two = h.clone() - Round::floor(h.clone() * T::from_f64(0.5)) * T::from_f64(2.0);
let x = c.clone() * (T::one() - (h_mod_two - T::one()).abs());
let m = hsl.lightness - c.clone() * T::from_f64(0.5);
let is_zone0 = h.gt_eq(&T::zero()) & h.lt(&T::one());
let is_zone1 = h.gt_eq(&T::one()) & h.lt(&T::from_f64(2.0));
let is_zone2 = h.gt_eq(&T::from_f64(2.0)) & h.lt(&T::from_f64(3.0));
let is_zone3 = h.gt_eq(&T::from_f64(3.0)) & h.lt(&T::from_f64(4.0));
let is_zone4 = h.gt_eq(&T::from_f64(4.0)) & h.lt(&T::from_f64(5.0));
let red = lazy_select! {
if is_zone1.clone() | &is_zone4 => x.clone(),
if is_zone2.clone() | &is_zone3 => T::zero(),
else => c.clone(),
};
let green = lazy_select! {
if is_zone0.clone() | &is_zone3 => x.clone(),
if is_zone1.clone() | &is_zone2 => c.clone(),
else => T::zero(),
};
let blue = lazy_select! {
if is_zone0 | is_zone1 => T::zero(),
if is_zone3 | is_zone4 => c,
else => x,
};
Rgb {
red: red + m.clone(),
green: green + m.clone(),
blue: blue + m,
standard: PhantomData,
}
}
}
impl<S, T> FromColorUnclamped<Hsv<S, T>> for Rgb<S, T>
where
T: Real
+ RealAngle
+ UnsignedAngle
+ Round
+ Zero
+ One
+ Abs
+ PartialCmp
+ Arithmetics
+ Clone,
T::Mask: LazySelect<T> + BitOps + Clone,
{
fn from_color_unclamped(hsv: Hsv<S, T>) -> Self {
let c = hsv.value.clone() * hsv.saturation;
let h = hsv.hue.into_positive_degrees() / T::from_f64(60.0);
// We avoid using %, since it's not always (or never?) supported in SIMD
let h_mod_two = h.clone() - Round::floor(h.clone() * T::from_f64(0.5)) * T::from_f64(2.0);
let x = c.clone() * (T::one() - (h_mod_two - T::one()).abs());
let m = hsv.value - c.clone();
let is_zone0 = h.gt_eq(&T::zero()) & h.lt(&T::one());
let is_zone1 = h.gt_eq(&T::one()) & h.lt(&T::from_f64(2.0));
let is_zone2 = h.gt_eq(&T::from_f64(2.0)) & h.lt(&T::from_f64(3.0));
let is_zone3 = h.gt_eq(&T::from_f64(3.0)) & h.lt(&T::from_f64(4.0));
let is_zone4 = h.gt_eq(&T::from_f64(4.0)) & h.lt(&T::from_f64(5.0));
let red = lazy_select! {
if is_zone1.clone() | &is_zone4 => x.clone(),
if is_zone2.clone() | &is_zone3 => T::zero(),
else => c.clone(),
};
let green = lazy_select! {
if is_zone0.clone() | &is_zone3 => x.clone(),
if is_zone1.clone() | &is_zone2 => c.clone(),
else => T::zero(),
};
let blue = lazy_select! {
if is_zone0 | is_zone1 => T::zero(),
if is_zone3 | is_zone4 => c,
else => x,
};
Rgb {
red: red + m.clone(),
green: green + m.clone(),
blue: blue + m,
standard: PhantomData,
}
}
}
impl<S, St, T> FromColorUnclamped<Luma<St, T>> for Rgb<S, T>
where
S: RgbStandard + 'static,
St: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint> + 'static,
S::TransferFn: FromLinear<T, T>,
St::TransferFn: IntoLinear<T, T>,
T: Clone,
{
#[inline]
fn from_color_unclamped(color: Luma<St, T>) -> Self {
if TypeId::of::<S::TransferFn>() == TypeId::of::<St::TransferFn>() {
Rgb {
red: color.luma.clone(),
green: color.luma.clone(),
blue: color.luma,
standard: PhantomData,
}
} else {
let luma = color.into_linear();
Self::from_linear(Rgb {
red: luma.luma.clone(),
green: luma.luma.clone(),
blue: luma.luma,
standard: PhantomData,
})
}
}
}
impl<S, T> FromColorUnclamped<Oklab<T>> for Rgb<S, T>
where
T: Real + Arithmetics + Copy,
S: RgbStandard,
S::TransferFn: FromLinear<T, T>,
S::Space: RgbSpace<WhitePoint = D65> + 'static,
Rgb<Linear<Srgb>, T>: IntoColorUnclamped<Self>,
Xyz<D65, T>: FromColorUnclamped<Oklab<T>> + IntoColorUnclamped<Self>,
{
fn from_color_unclamped(oklab: Oklab<T>) -> Self {
if TypeId::of::<<S as RgbStandard>::Space>() == TypeId::of::<Srgb>() {
// Use direct sRGB to Oklab conversion
// Rounding errors are likely a contributing factor to differences.
// Also the conversion via XYZ doesn't use pre-defined matrices (yet)
oklab_to_linear_srgb(oklab).into_color_unclamped()
} else {
// Convert via XYZ
Xyz::from_color_unclamped(oklab).into_color_unclamped()
}
}
}
impl_is_within_bounds! {
Rgb<S> {
red => [Self::min_red(), Self::max_red()],
green => [Self::min_green(), Self::max_green()],
blue => [Self::min_blue(), Self::max_blue()]
}
where T: Stimulus
}
impl_clamp! {
Rgb<S> {
red => [Self::min_red(), Self::max_red()],
green => [Self::min_green(), Self::max_green()],
blue => [Self::min_blue(), Self::max_blue()]
}
other {standard}
where T: Stimulus
}
impl_mix!(Rgb<S>);
impl_lighten! {
Rgb<S>
increase {
red => [Self::min_red(), Self::max_red()],
green => [Self::min_green(), Self::max_green()],
blue => [Self::min_blue(), Self::max_blue()]
}
other {}
phantom: standard
where T: Stimulus,
}
impl<S, T> GetHue for Rgb<S, T>
where
T: Real + RealAngle + Trigonometry + Arithmetics + Clone,
{
type Hue = RgbHue<T>;
fn get_hue(&self) -> RgbHue<T> {
let sqrt_3: T = T::from_f64(1.73205081);
RgbHue::from_cartesian(
self.red.clone() * T::from_f64(2.0) - self.green.clone() - self.blue.clone(),
sqrt_3 * (self.green.clone() - self.blue.clone()),
)
}
}
impl_premultiply!(Rgb<S> {red, green, blue} phantom: standard);
impl_euclidean_distance!(Rgb<S> {red, green, blue});
impl<S, T> StimulusColor for Rgb<S, T> where T: Stimulus {}
impl<S, T> HasBoolMask for Rgb<S, T>
where
T: HasBoolMask,
{
type Mask = T::Mask;
}
impl<S, T> Default for Rgb<S, T>
where
T: Stimulus,
{
fn default() -> Rgb<S, T> {
Rgb::new(Self::min_red(), Self::min_green(), Self::min_blue())
}
}
impl_color_add!(Rgb<S>, [red, green, blue], standard);
impl_color_sub!(Rgb<S>, [red, green, blue], standard);
impl_color_mul!(Rgb<S>, [red, green, blue], standard);
impl_color_div!(Rgb<S>, [red, green, blue], standard);
impl_tuple_conversion!(Rgb<S> as (T, T, T));
impl_array_casts!(Rgb<S, T>, [T; 3]);
impl_simd_array_conversion!(Rgb<S>, [red, green, blue], standard);
impl_struct_of_array_traits!(Rgb<S>, [red, green, blue], standard);
impl_eq!(Rgb<S>, [red, green, blue]);
impl_copy_clone!(Rgb<S>, [red, green, blue], standard);
impl<S, T> fmt::LowerHex for Rgb<S, T>
where
T: fmt::LowerHex,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let size = f.width().unwrap_or(::core::mem::size_of::<T>() * 2);
write!(
f,
"{:0width$x}{:0width$x}{:0width$x}",
self.red,
self.green,
self.blue,
width = size
)
}
}
impl<S, T> fmt::UpperHex for Rgb<S, T>
where
T: fmt::UpperHex,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let size = f.width().unwrap_or(::core::mem::size_of::<T>() * 2);
write!(
f,
"{:0width$X}{:0width$X}{:0width$X}",
self.red,
self.green,
self.blue,
width = size
)
}
}
/// Error type for parsing a string of hexadecimal characters to an `Rgb` color.
#[derive(Debug)]
pub enum FromHexError {
/// An error occurred while parsing the string into a valid integer.
ParseIntError(ParseIntError),
/// The hex value was not in a valid 3 or 6 character format.
HexFormatError(&'static str),
/// The hex value was not in a valid 4 or 8 character format.
RgbaHexFormatError(&'static str),
}
impl From<ParseIntError> for FromHexError {
fn from(err: ParseIntError) -> FromHexError {
FromHexError::ParseIntError(err)
}
}
impl From<&'static str> for FromHexError {
fn from(err: &'static str) -> FromHexError {
FromHexError::HexFormatError(err)
}
}
impl core::fmt::Display for FromHexError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
FromHexError::ParseIntError(e) => write!(f, "{}", e),
FromHexError::HexFormatError(s) => write!(
f,
"{}, please use format '#fff', 'fff', '#ffffff' or 'ffffff'.",
s
),
FromHexError::RgbaHexFormatError(s) => write!(
f,
"{}, please use format '#ffff', 'ffff', '#ffffffff' or 'ffffffff'.",
s
),
}
}
}
#[cfg(feature = "std")]
impl std::error::Error for FromHexError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
FromHexError::HexFormatError(_s) => None,
FromHexError::RgbaHexFormatError(_s) => None,
FromHexError::ParseIntError(e) => Some(e),
}
}
}
impl<S> FromStr for Rgb<S, u8> {
type Err = FromHexError;
/// Parses a color hex code of format '#ff00bb' or '#abc' (with or without the leading '#') into a
/// [`Rgb<S, u8>`] instance.
fn from_str(hex: &str) -> Result<Self, Self::Err> {
let hex_code = hex.strip_prefix('#').map_or(hex, |stripped| stripped);
match hex_code.len() {
3 => {
let red = u8::from_str_radix(&hex_code[..1], 16)?;
let green = u8::from_str_radix(&hex_code[1..2], 16)?;
let blue = u8::from_str_radix(&hex_code[2..3], 16)?;
let col: Rgb<S, u8> = Rgb::new(red * 17, green * 17, blue * 17);
Ok(col)
}
6 => {
let red = u8::from_str_radix(&hex_code[..2], 16)?;
let green = u8::from_str_radix(&hex_code[2..4], 16)?;
let blue = u8::from_str_radix(&hex_code[4..6], 16)?;
let col: Rgb<S, u8> = Rgb::new(red, green, blue);
Ok(col)
}
_ => Err(FromHexError::HexFormatError("invalid hex code format")),
}
}
}
impl<S> FromStr for Rgba<S, u8> {
type Err = FromHexError;
/// Parses a color hex code of format '#ff00bbff' or '#abcd' (with or without the leading '#') into a
/// [`Rgba<S, u8>`] instance.
fn from_str(hex: &str) -> Result<Self, Self::Err> {
let hex_code = hex.strip_prefix('#').map_or(hex, |stripped| stripped);
match hex_code.len() {
4 => {
let red = u8::from_str_radix(&hex_code[..1], 16)?;
let green = u8::from_str_radix(&hex_code[1..2], 16)?;
let blue = u8::from_str_radix(&hex_code[2..3], 16)?;
let alpha = u8::from_str_radix(&hex_code[3..4], 16)?;
let col: Rgba<S, u8> = Rgba::new(red * 17, green * 17, blue * 17, alpha * 17);
Ok(col)
}
8 => {
let red = u8::from_str_radix(&hex_code[..2], 16)?;
let green = u8::from_str_radix(&hex_code[2..4], 16)?;
let blue = u8::from_str_radix(&hex_code[4..6], 16)?;
let alpha = u8::from_str_radix(&hex_code[6..8], 16)?;
let col: Rgba<S, u8> = Rgba::new(red, green, blue, alpha);
Ok(col)
}
_ => Err(FromHexError::RgbaHexFormatError("invalid hex code format")),
}
}
}
impl<S, T, P, O> From<Rgb<S, T>> for Packed<O, P>
where
O: ComponentOrder<Rgba<S, T>, P>,
Rgba<S, T>: From<Rgb<S, T>>,
{
#[inline]
fn from(color: Rgb<S, T>) -> Self {
Self::from(Rgba::from(color))
}
}
impl<S, T, O, P> From<Rgba<S, T>> for Packed<O, P>
where
O: ComponentOrder<Rgba<S, T>, P>,
{
#[inline]
fn from(color: Rgba<S, T>) -> Self {
Packed::pack(color)
}
}
impl<S, O, P> From<Packed<O, P>> for Rgb<S, u8>
where
O: ComponentOrder<Rgba<S, u8>, P>,
{
#[inline]
fn from(packed: Packed<O, P>) -> Self {
Rgba::from(packed).color
}
}
impl<S, T, O, P> From<Packed<O, P>> for Rgba<S, T>
where
O: ComponentOrder<Rgba<S, T>, P>,
{
#[inline]
fn from(packed: Packed<O, P>) -> Self {
packed.unpack()
}
}
impl<S> From<u32> for Rgb<S, u8> {
#[inline]
fn from(color: u32) -> Self {
Self::from_u32::<super::channels::Argb>(color)
}
}
impl<S> From<u32> for Rgba<S, u8> {
#[inline]
fn from(color: u32) -> Self {
Self::from_u32::<super::channels::Rgba>(color)
}
}
impl<S> From<Rgb<S, u8>> for u32 {
#[inline]
fn from(color: Rgb<S, u8>) -> Self {
Rgb::into_u32::<super::channels::Argb>(color)
}
}
impl<S> From<Rgba<S, u8>> for u32 {
#[inline]
fn from(color: Rgba<S, u8>) -> Self {
Rgba::into_u32::<super::channels::Rgba>(color)
}
}
impl<S> From<Rgb<S, u8>> for Rgb<S, f32> {
#[inline]
fn from(color: Rgb<S, u8>) -> Self {
color.into_format()
}
}
impl<S> From<Rgba<S, u8>> for Rgba<S, f32> {
#[inline]
fn from(color: Rgba<S, u8>) -> Self {
color.into_format()
}
}
impl<S> From<Rgb<S, f32>> for Rgb<S, u8> {
#[inline]
fn from(color: Rgb<S, f32>) -> Self {
color.into_format()
}
}
impl<S> From<Rgba<S, f32>> for Rgba<S, u8> {
#[inline]
fn from(color: Rgba<S, f32>) -> Self {
color.into_format()
}
}
impl<S> From<Rgb<S, u8>> for Rgb<S, f64> {
#[inline]
fn from(color: Rgb<S, u8>) -> Self {
color.into_format()
}
}
impl<S> From<Rgba<S, u8>> for Rgba<S, f64> {
#[inline]
fn from(color: Rgba<S, u8>) -> Self {
color.into_format()
}
}
impl<S> From<Rgb<S, f64>> for Rgb<S, u8> {
#[inline]
fn from(color: Rgb<S, f64>) -> Self {
color.into_format()
}
}
impl<S> From<Rgba<S, f64>> for Rgba<S, u8> {
#[inline]
fn from(color: Rgba<S, f64>) -> Self {
color.into_format()
}
}
impl<S> From<Rgb<S, f32>> for Rgb<S, f64> {
#[inline]
fn from(color: Rgb<S, f32>) -> Self {
color.into_format()
}
}
impl<S> From<Rgba<S, f32>> for Rgba<S, f64> {
#[inline]
fn from(color: Rgba<S, f32>) -> Self {
color.into_format()
}
}
impl<S> From<Rgb<S, f64>> for Rgb<S, f32> {
#[inline]
fn from(color: Rgb<S, f64>) -> Self {
color.into_format()
}
}
impl<S> From<Rgba<S, f64>> for Rgba<S, f32> {
#[inline]
fn from(color: Rgba<S, f64>) -> Self {
color.into_format()
}
}
#[allow(deprecated)]
impl<S, T> crate::RelativeContrast for Rgb<S, T>
where
T: Real + Arithmetics + PartialCmp,
T::Mask: LazySelect<T>,
S: RgbStandard,
Xyz<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>: FromColor<Self>,
{
type Scalar = T;
#[inline]
fn get_contrast_ratio(self, other: Self) -> T {
let xyz1 = Xyz::from_color(self);
let xyz2 = Xyz::from_color(other);
crate::contrast_ratio(xyz1.y, xyz2.y)
}
}
impl<S, T> Wcag21RelativeContrast for Rgb<S, T>
where
Self: IntoColor<Luma<Linear<D65>, T>>,
S: RgbStandard<Space = crate::encoding::srgb::Srgb>,
T: Real + Add<T, Output = T> + Div<T, Output = T> + PartialCmp + MinMax,
{
type Scalar = T;
fn relative_luminance(self) -> Luma<Linear<D65>, Self::Scalar> {
self.into_color()
}
}
impl_rand_traits_cartesian!(UniformRgb, Rgb<S> {red, green, blue} phantom: standard: PhantomData<S>);
#[cfg(feature = "bytemuck")]
unsafe impl<S, T> bytemuck::Zeroable for Rgb<S, T> where T: bytemuck::Zeroable {}
#[cfg(feature = "bytemuck")]
unsafe impl<S: 'static, T> bytemuck::Pod for Rgb<S, T> where T: bytemuck::Pod {}
#[cfg(test)]
mod test {
use core::str::FromStr;
use crate::encoding::Srgb;
use crate::rgb::channels;
use super::{Rgb, Rgba};
test_convert_into_from_xyz!(Rgb);
#[test]
fn ranges() {
assert_ranges! {
Rgb<Srgb, f64>;
clamped {
red: 0.0 => 1.0,
green: 0.0 => 1.0,
blue: 0.0 => 1.0
}
clamped_min {}
unclamped {}
}
}
raw_pixel_conversion_tests!(Rgb<Srgb>: red, green, blue);
raw_pixel_conversion_fail_tests!(Rgb<Srgb>: red, green, blue);
#[test]
fn lower_hex() {
assert_eq!(
format!("{:x}", Rgb::<Srgb, u8>::new(171, 193, 35)),
"abc123"
);
}
#[test]
fn lower_hex_small_numbers() {
assert_eq!(format!("{:x}", Rgb::<Srgb, u8>::new(1, 2, 3)), "010203");
assert_eq!(
format!("{:x}", Rgb::<Srgb, u16>::new(1, 2, 3)),
"000100020003"
);
assert_eq!(
format!("{:x}", Rgb::<Srgb, u32>::new(1, 2, 3)),
"000000010000000200000003"
);
assert_eq!(
format!("{:x}", Rgb::<Srgb, u64>::new(1, 2, 3)),
"000000000000000100000000000000020000000000000003"
);
}
#[test]
fn lower_hex_custom_width() {
assert_eq!(
format!("{:03x}", Rgb::<Srgb, u8>::new(1, 2, 3)),
"001002003"
);
assert_eq!(
format!("{:03x}", Rgb::<Srgb, u16>::new(1, 2, 3)),
"001002003"
);
assert_eq!(
format!("{:03x}", Rgb::<Srgb, u32>::new(1, 2, 3)),
"001002003"
);
assert_eq!(
format!("{:03x}", Rgb::<Srgb, u64>::new(1, 2, 3)),
"001002003"
);
}
#[test]
fn upper_hex() {
assert_eq!(
format!("{:X}", Rgb::<Srgb, u8>::new(171, 193, 35)),
"ABC123"
);
}
#[test]
fn upper_hex_small_numbers() {
assert_eq!(format!("{:X}", Rgb::<Srgb, u8>::new(1, 2, 3)), "010203");
assert_eq!(
format!("{:X}", Rgb::<Srgb, u16>::new(1, 2, 3)),
"000100020003"
);
assert_eq!(
format!("{:X}", Rgb::<Srgb, u32>::new(1, 2, 3)),
"000000010000000200000003"
);
assert_eq!(
format!("{:X}", Rgb::<Srgb, u64>::new(1, 2, 3)),
"000000000000000100000000000000020000000000000003"
);
}
#[test]
fn upper_hex_custom_width() {
assert_eq!(
format!("{:03X}", Rgb::<Srgb, u8>::new(1, 2, 3)),
"001002003"
);
assert_eq!(
format!("{:03X}", Rgb::<Srgb, u16>::new(1, 2, 3)),
"001002003"
);
assert_eq!(
format!("{:03X}", Rgb::<Srgb, u32>::new(1, 2, 3)),
"001002003"
);
assert_eq!(
format!("{:03X}", Rgb::<Srgb, u64>::new(1, 2, 3)),
"001002003"
);
}
#[test]
fn rgb_hex_into_from() {
let c1 = Rgb::<Srgb, u8>::from_u32::<channels::Argb>(0x1100_7FFF);
let c2 = Rgb::<Srgb, u8>::new(0u8, 127, 255);
assert_eq!(c1, c2);
assert_eq!(Rgb::<Srgb, u8>::into_u32::<channels::Argb>(c1), 0xFF00_7FFF);
let c1 = Rgba::<Srgb, u8>::from_u32::<channels::Rgba>(0x007F_FF80);
let c2 = Rgba::<Srgb, u8>::new(0u8, 127, 255, 128);
assert_eq!(c1, c2);
assert_eq!(
Rgba::<Srgb, u8>::into_u32::<channels::Rgba>(c1),
0x007F_FF80
);
assert_eq!(
Rgb::<Srgb, u8>::from(0x7FFF_FF80),
Rgb::from((255u8, 255, 128))
);
assert_eq!(
Rgba::<Srgb, u8>::from(0x7FFF_FF80),
Rgba::from((127u8, 255, 255, 128))
);
}
#[cfg(feature = "serializing")]
#[test]
fn serialize() {
let serialized = ::serde_json::to_string(&Rgb::<Srgb>::new(0.3, 0.8, 0.1)).unwrap();
assert_eq!(serialized, r#"{"red":0.3,"green":0.8,"blue":0.1}"#);
}
#[cfg(feature = "serializing")]
#[test]
fn deserialize() {
let deserialized: Rgb<Srgb> =
::serde_json::from_str(r#"{"red":0.3,"green":0.8,"blue":0.1}"#).unwrap();
assert_eq!(deserialized, Rgb::<Srgb>::new(0.3, 0.8, 0.1));
}
#[test]
fn from_str() {
let c = Rgb::<Srgb, u8>::from_str("#ffffff");
assert!(c.is_ok());
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(255, 255, 255));
let c = Rgb::<Srgb, u8>::from_str("#gggggg");
assert!(c.is_err());
let c = Rgb::<Srgb, u8>::from_str("#fff");
assert!(c.is_ok());
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(255, 255, 255));
let c = Rgb::<Srgb, u8>::from_str("#000000");
assert!(c.is_ok());
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(0, 0, 0));
let c = Rgb::<Srgb, u8>::from_str("");
assert!(c.is_err());
let c = Rgb::<Srgb, u8>::from_str("#123456");
assert!(c.is_ok());
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(18, 52, 86));
let c = Rgb::<Srgb, u8>::from_str("#iii");
assert!(c.is_err());
assert_eq!(
format!("{}", c.err().unwrap()),
"invalid digit found in string"
);
let c = Rgb::<Srgb, u8>::from_str("#08f");
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(0, 136, 255));
let c = Rgb::<Srgb, u8>::from_str("08f");
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(0, 136, 255));
let c = Rgb::<Srgb, u8>::from_str("ffffff");
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(255, 255, 255));
let c = Rgb::<Srgb, u8>::from_str("#12");
assert!(c.is_err());
assert_eq!(
format!("{}", c.err().unwrap()),
"invalid hex code format, \
please use format \'#fff\', \'fff\', \'#ffffff\' or \'ffffff\'."
);
let c = Rgb::<Srgb, u8>::from_str("da0bce");
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(218, 11, 206));
let c = Rgb::<Srgb, u8>::from_str("f034e6");
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(240, 52, 230));
let c = Rgb::<Srgb, u8>::from_str("abc");
assert_eq!(c.unwrap(), Rgb::<Srgb, u8>::new(170, 187, 204));
let c = Rgba::<Srgb, u8>::from_str("#08ff");
assert_eq!(c.unwrap(), Rgba::<Srgb, u8>::new(0, 136, 255, 255));
let c = Rgba::<Srgb, u8>::from_str("08f0");
assert_eq!(c.unwrap(), Rgba::<Srgb, u8>::new(0, 136, 255, 0));
let c = Rgba::<Srgb, u8>::from_str("#da0bce80");
assert_eq!(c.unwrap(), Rgba::<Srgb, u8>::new(218, 11, 206, 128));
let c = Rgba::<Srgb, u8>::from_str("f034e680");
assert_eq!(c.unwrap(), Rgba::<Srgb, u8>::new(240, 52, 230, 128));
let c = Rgba::<Srgb, u8>::from_str("#ffffffff");
assert_eq!(c.unwrap(), Rgba::<Srgb, u8>::new(255, 255, 255, 255));
let c = Rgba::<Srgb, u8>::from_str("#ffff");
assert_eq!(c.unwrap(), Rgba::<Srgb, u8>::new(255, 255, 255, 255));
let c = Rgba::<Srgb, u8>::from_str("#gggggggg");
assert!(c.is_err());
assert_eq!(
format!("{}", c.err().unwrap()),
"invalid digit found in string"
);
let c = Rgba::<Srgb, u8>::from_str("#fff");
assert_eq!(
format!("{}", c.err().unwrap()),
"invalid hex code format, \
please use format '#ffff', 'ffff', '#ffffffff' or 'ffffffff'."
);
let c = Rgba::<Srgb, u8>::from_str("#ffffff");
assert_eq!(
format!("{}", c.err().unwrap()),
"invalid hex code format, \
please use format '#ffff', 'ffff', '#ffffffff' or 'ffffffff'."
);
}
#[test]
fn check_min_max_components() {
assert_eq!(Rgb::<Srgb, f32>::min_red(), 0.0);
assert_eq!(Rgb::<Srgb, f32>::min_green(), 0.0);
assert_eq!(Rgb::<Srgb, f32>::min_blue(), 0.0);
assert_eq!(Rgb::<Srgb, f32>::max_red(), 1.0);
assert_eq!(Rgb::<Srgb, f32>::max_green(), 1.0);
assert_eq!(Rgb::<Srgb, f32>::max_blue(), 1.0);
}
struct_of_arrays_tests!(
Rgb<Srgb>[red, green, blue] phantom: standard,
Rgba::new(0.1f32, 0.2, 0.3, 0.4),
Rgba::new(0.2, 0.3, 0.4, 0.5),
Rgba::new(0.3, 0.4, 0.5, 0.6)
);
test_uniform_distribution! {
Rgb<Srgb, f32> {
red: (0.0, 1.0),
green: (0.0, 1.0),
blue: (0.0, 1.0)
},
min: Rgb::new(0.0f32, 0.0, 0.0),
max: Rgb::new(1.0, 1.0, 1.0)
}
}