61f49231985c8b10e4a76a05857058fbaba1301d
[WebKit-https.git] / Source / WebCore / platform / graphics / ColorUtilities.h
1 /*
2  * Copyright (C) 2017, 2020 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <algorithm>
29 #include <math.h>
30
31 namespace WebCore {
32
33 template<typename T> struct ColorComponents;
34
35 // 0-1 components, result is clamped.
36 float linearToRGBColorComponent(float);
37 float rgbToLinearColorComponent(float);
38
39 ColorComponents<float> rgbToLinearComponents(const ColorComponents<float>&);
40 ColorComponents<float> linearToRGBComponents(const ColorComponents<float>&);
41
42 ColorComponents<float> p3ToSRGB(const ColorComponents<float>&);
43 ColorComponents<float> sRGBToP3(const ColorComponents<float>&);
44
45 WEBCORE_EXPORT ColorComponents<float> sRGBToHSL(const ColorComponents<float>&);
46 WEBCORE_EXPORT ColorComponents<float> hslToSRGB(const ColorComponents<float>&);
47
48 float lightness(const ColorComponents<float>& sRGBCompontents);
49 float luminance(const ColorComponents<float>& sRGBCompontents);
50 float contrastRatio(const ColorComponents<float>& sRGBCompontentsA, const ColorComponents<float>& sRGBCompontentsB);
51
52 ColorComponents<float> premultiplied(const ColorComponents<float>& sRGBCompontents);
53
54 bool areEssentiallyEqual(const ColorComponents<float>&, const ColorComponents<float>&);
55
56 inline uint8_t roundAndClampColorChannel(int value)
57 {
58     return std::clamp(value, 0, 255);
59 }
60
61 inline uint8_t roundAndClampColorChannel(float value)
62 {
63     return std::clamp(std::round(value), 0.f, 255.f);
64 }
65
66 inline uint16_t fastMultiplyBy255(uint16_t value)
67 {
68     return (value << 8) - value;
69 }
70
71 inline uint16_t fastDivideBy255(uint16_t value)
72 {
73     // While this is an approximate algorithm for division by 255, it gives perfectly accurate results for 16-bit values.
74     // FIXME: Since this gives accurate results for 16-bit values, we should get this optimization into compilers like clang.
75     uint16_t approximation = value >> 8;
76     uint16_t remainder = value - (approximation * 255) + 1;
77     return approximation + (remainder >> 8);
78 }
79
80 inline uint8_t colorFloatToSimpleColorByte(float f)
81 {
82     return std::clamp(static_cast<int>(lroundf(255.0f * f)), 0, 255);
83 }
84
85 } // namespace WebCore