/* * Copyright 2006 The Android Open Source Project * * Use of this source code is governed by a BSD-style license that can be * found in the LICENSE file. */ #ifndef SkColor_DEFINED #define SkColor_DEFINED #include "include/core/SkAlphaType.h" #include "include/core/SkScalar.h" #include "include/core/SkTypes.h" #include "include/private/base/SkCPUTypes.h" #include <array> #include <cstdint> /** \file SkColor.h Types, consts, functions, and macros for colors. */ /** 8-bit type for an alpha value. 255 is 100% opaque, zero is 100% transparent. */ SkAlpha; /** 32-bit ARGB color value, unpremultiplied. Color components are always in a known order. This is different from SkPMColor, which has its bytes in a configuration dependent order, to match the format of kBGRA_8888_SkColorType bitmaps. SkColor is the type used to specify colors in SkPaint and in gradients. Color that is premultiplied has the same component values as color that is unpremultiplied if alpha is 255, fully opaque, although may have the component values in a different order. */ SkColor; /** Returns color value from 8-bit component values. Asserts if SK_DEBUG is defined if a, r, g, or b exceed 255. Since color is unpremultiplied, a may be smaller than the largest of r, g, and b. @param a amount of alpha, from fully transparent (0) to fully opaque (255) @param r amount of red, from no red (0) to full red (255) @param g amount of green, from no green (0) to full green (255) @param b amount of blue, from no blue (0) to full blue (255) @return color and alpha, unpremultiplied */ static constexpr inline SkColor SkColorSetARGB(U8CPU a, U8CPU r, U8CPU g, U8CPU b) { … } /** Returns color value from 8-bit component values, with alpha set fully opaque to 255. */ #define SkColorSetRGB(r, g, b) … /** Returns alpha byte from color value. */ #define SkColorGetA(color) … /** Returns red component of color, from zero to 255. */ #define SkColorGetR(color) … /** Returns green component of color, from zero to 255. */ #define SkColorGetG(color) … /** Returns blue component of color, from zero to 255. */ #define SkColorGetB(color) … /** Returns unpremultiplied color with red, blue, and green set from c; and alpha set from a. Alpha component of c is ignored and is replaced by a in result. @param c packed RGB, eight bits per component @param a alpha: transparent at zero, fully opaque at 255 @return color with transparency */ [[nodiscard]] static constexpr inline SkColor SkColorSetA(SkColor c, U8CPU a) { … } /** Represents fully transparent SkAlpha value. SkAlpha ranges from zero, fully transparent; to 255, fully opaque. */ constexpr SkAlpha SK_AlphaTRANSPARENT = …; /** Represents fully opaque SkAlpha value. SkAlpha ranges from zero, fully transparent; to 255, fully opaque. */ constexpr SkAlpha SK_AlphaOPAQUE = …; /** Represents fully transparent SkColor. May be used to initialize a destination containing a mask or a non-rectangular image. */ constexpr SkColor SK_ColorTRANSPARENT = …; /** Represents fully opaque black. */ constexpr SkColor SK_ColorBLACK = …; /** Represents fully opaque dark gray. Note that SVG dark gray is equivalent to 0xFFA9A9A9. */ constexpr SkColor SK_ColorDKGRAY = …; /** Represents fully opaque gray. Note that HTML gray is equivalent to 0xFF808080. */ constexpr SkColor SK_ColorGRAY = …; /** Represents fully opaque light gray. HTML silver is equivalent to 0xFFC0C0C0. Note that SVG light gray is equivalent to 0xFFD3D3D3. */ constexpr SkColor SK_ColorLTGRAY = …; /** Represents fully opaque white. */ constexpr SkColor SK_ColorWHITE = …; /** Represents fully opaque red. */ constexpr SkColor SK_ColorRED = …; /** Represents fully opaque green. HTML lime is equivalent. Note that HTML green is equivalent to 0xFF008000. */ constexpr SkColor SK_ColorGREEN = …; /** Represents fully opaque blue. */ constexpr SkColor SK_ColorBLUE = …; /** Represents fully opaque yellow. */ constexpr SkColor SK_ColorYELLOW = …; /** Represents fully opaque cyan. HTML aqua is equivalent. */ constexpr SkColor SK_ColorCYAN = …; /** Represents fully opaque magenta. HTML fuchsia is equivalent. */ constexpr SkColor SK_ColorMAGENTA = …; /** Converts RGB to its HSV components. hsv[0] contains hsv hue, a value from zero to less than 360. hsv[1] contains hsv saturation, a value from zero to one. hsv[2] contains hsv value, a value from zero to one. @param red red component value from zero to 255 @param green green component value from zero to 255 @param blue blue component value from zero to 255 @param hsv three element array which holds the resulting HSV components */ SK_API void SkRGBToHSV(U8CPU red, U8CPU green, U8CPU blue, SkScalar hsv[3]); /** Converts ARGB to its HSV components. Alpha in ARGB is ignored. hsv[0] contains hsv hue, and is assigned a value from zero to less than 360. hsv[1] contains hsv saturation, a value from zero to one. hsv[2] contains hsv value, a value from zero to one. @param color ARGB color to convert @param hsv three element array which holds the resulting HSV components */ static inline void SkColorToHSV(SkColor color, SkScalar hsv[3]) { … } /** Converts HSV components to an ARGB color. Alpha is passed through unchanged. hsv[0] represents hsv hue, an angle from zero to less than 360. hsv[1] represents hsv saturation, and varies from zero to one. hsv[2] represents hsv value, and varies from zero to one. Out of range hsv values are pinned. @param alpha alpha component of the returned ARGB color @param hsv three element array which holds the input HSV components @return ARGB equivalent to HSV */ SK_API SkColor SkHSVToColor(U8CPU alpha, const SkScalar hsv[3]); /** Converts HSV components to an ARGB color. Alpha is set to 255. hsv[0] represents hsv hue, an angle from zero to less than 360. hsv[1] represents hsv saturation, and varies from zero to one. hsv[2] represents hsv value, and varies from zero to one. Out of range hsv values are pinned. @param hsv three element array which holds the input HSV components @return RGB equivalent to HSV */ static inline SkColor SkHSVToColor(const SkScalar hsv[3]) { … } /** 32-bit ARGB color value, premultiplied. The byte order for this value is configuration dependent, matching the format of kBGRA_8888_SkColorType bitmaps. This is different from SkColor, which is unpremultiplied, and is always in the same byte order. */ SkPMColor; /** Returns a SkPMColor value from unpremultiplied 8-bit component values. @param a amount of alpha, from fully transparent (0) to fully opaque (255) @param r amount of red, from no red (0) to full red (255) @param g amount of green, from no green (0) to full green (255) @param b amount of blue, from no blue (0) to full blue (255) @return premultiplied color */ SK_API SkPMColor SkPreMultiplyARGB(U8CPU a, U8CPU r, U8CPU g, U8CPU b); /** Returns pmcolor closest to color c. Multiplies c RGB components by the c alpha, and arranges the bytes to match the format of kN32_SkColorType. @param c unpremultiplied ARGB color @return premultiplied color */ SK_API SkPMColor SkPreMultiplyColor(SkColor c); /** \enum SkColorChannel Describes different color channels one can manipulate */ enum class SkColorChannel { … }; /** Used to represent the channels available in a color type or texture format as a mask. */ enum SkColorChannelFlag : uint32_t { … }; static_assert …; /** \struct SkRGBA4f RGBA color value, holding four floating point components. Color components are always in a known order. kAT determines if the SkRGBA4f's R, G, and B components are premultiplied by alpha or not. Skia's public API always uses unpremultiplied colors, which can be stored as SkRGBA4f<kUnpremul_SkAlphaType>. For convenience, this type can also be referred to as SkColor4f. */ template <SkAlphaType kAT> struct SkRGBA4f { … }; /** \struct SkColor4f RGBA color value, holding four floating point components. Color components are always in a known order, and are unpremultiplied. This is a specialization of SkRGBA4f. For details, @see SkRGBA4f. */ SkColor4f; template <> SK_API SkColor4f SkColor4f::FromColor(SkColor); template <> SK_API SkColor SkColor4f::toSkColor() const; template <> SK_API uint32_t SkColor4f::toBytes_RGBA() const; template <> SK_API SkColor4f SkColor4f::FromBytes_RGBA(uint32_t color); namespace SkColors { constexpr SkColor4f kTransparent = …; constexpr SkColor4f kBlack = …; constexpr SkColor4f kDkGray = …; constexpr SkColor4f kGray = …; constexpr SkColor4f kLtGray = …; constexpr SkColor4f kWhite = …; constexpr SkColor4f kRed = …; constexpr SkColor4f kGreen = …; constexpr SkColor4f kBlue = …; constexpr SkColor4f kYellow = …; constexpr SkColor4f kCyan = …; constexpr SkColor4f kMagenta = …; } // namespace SkColors #endif
Codebase Browser
chromium