color.hpp

Go to the documentation of this file.

#pragma once
#include "../drawing_export.hpp"
#include "argb.hpp"
#include "cmyk.hpp"
#include "known_color.hpp"
#include "hsb.hpp"
#include "hsl.hpp"
#include "hsv.hpp"
#include "yuv.hpp"
#include <xtd/iequatable>
#include <xtd/object>
#include <xtd/string>

namespace xtd {
  namespace drawing {
    class image;
    
    class drawing_export_ color : public xtd::object, public xtd::iequatable<color> {
    public:
      
      static const xtd::drawing::color empty;
      
      static const xtd::drawing::color transparent;
      
      static const xtd::drawing::color alice_blue;
      
      static const xtd::drawing::color antique_white;
      
      static const xtd::drawing::color aqua;
      
      static const xtd::drawing::color aquamarine;
      
      static const xtd::drawing::color azure;
      
      static const xtd::drawing::color beige;
      
      static const xtd::drawing::color bisque;
      
      static const xtd::drawing::color black;
      
      static const xtd::drawing::color blanched_almond;
      
      static const xtd::drawing::color blue;
      
      static const xtd::drawing::color blue_violet;
      
      static const xtd::drawing::color brown;
      
      static const xtd::drawing::color burly_wood;
      
      static const xtd::drawing::color cadet_blue;
      
      static const xtd::drawing::color chartreuse;
      
      static const xtd::drawing::color chocolate;
      
      static const xtd::drawing::color coral;
      
      static const xtd::drawing::color cornflower_blue;
      
      static const xtd::drawing::color cornsilk;
      
      static const xtd::drawing::color crimson;
      
      static const xtd::drawing::color cyan;
      
      static const xtd::drawing::color dark_blue;
      
      static const xtd::drawing::color dark_cyan;
      
      static const xtd::drawing::color dark_goldenrod;
      
      static const xtd::drawing::color dark_gray;
      
      static const xtd::drawing::color dark_green;
      
      static const xtd::drawing::color dark_khaki;
      
      static const xtd::drawing::color dark_magenta;
      
      static const xtd::drawing::color dark_olive_green;
      
      static const xtd::drawing::color dark_orange;
      
      static const xtd::drawing::color dark_orchid;
      
      static const xtd::drawing::color dark_red;
      
      static const xtd::drawing::color dark_salmon;
      
      static const xtd::drawing::color dark_sea_green;
      
      static const xtd::drawing::color dark_slate_blue;
      
      static const xtd::drawing::color dark_slate_gray;
      
      static const xtd::drawing::color dark_turquoise;
      
      static const xtd::drawing::color dark_violet;
      
      static const xtd::drawing::color deep_pink;
      
      static const xtd::drawing::color deep_sky_blue;
      
      static const xtd::drawing::color dim_gray;
      
      static const xtd::drawing::color dodger_blue;
      
      static const xtd::drawing::color firebrick;
      
      static const xtd::drawing::color floral_white;
      
      static const xtd::drawing::color forest_green;
      
      static const xtd::drawing::color fuchsia;
      
      static const xtd::drawing::color gainsboro;
      
      static const xtd::drawing::color ghost_white;
      
      static const xtd::drawing::color gold;
      
      static const xtd::drawing::color goldenrod;
      
      static const xtd::drawing::color gray;
      
      static const xtd::drawing::color green;
      
      static const xtd::drawing::color green_yellow;
      
      static const xtd::drawing::color honeydew;
      
      static const xtd::drawing::color hot_pink;
      
      static const xtd::drawing::color indian_red;
      
      static const xtd::drawing::color indigo;
      
      static const xtd::drawing::color ivory;
      
      static const xtd::drawing::color khaki;
      
      static const xtd::drawing::color lavender;
      
      static const xtd::drawing::color lavender_blush;
      
      static const xtd::drawing::color lawn_green;
      
      static const xtd::drawing::color lemon_chiffon;
      
      static const xtd::drawing::color light_blue;
      
      static const xtd::drawing::color light_coral;
      
      static const xtd::drawing::color light_cyan;
      
      static const xtd::drawing::color light_goldenrod_yellow;
      
      static const xtd::drawing::color light_gray;
      
      static const xtd::drawing::color light_green;
      
      static const xtd::drawing::color light_pink;
      
      static const xtd::drawing::color light_salmon;
      
      static const xtd::drawing::color light_sea_green;
      
      static const xtd::drawing::color light_sky_blue;
      
      static const xtd::drawing::color light_slate_gray;
      
      static const xtd::drawing::color light_steel_blue;
      
      static const xtd::drawing::color light_yellow;
      
      static const xtd::drawing::color lime;
      
      static const xtd::drawing::color lime_green;
      
      static const xtd::drawing::color linen;
      
      static const xtd::drawing::color magenta;
      
      static const xtd::drawing::color maroon;
      
      static const xtd::drawing::color medium_aquamarine;
      
      static const xtd::drawing::color medium_blue;
      
      static const xtd::drawing::color medium_orchid;
      
      static const xtd::drawing::color medium_purple;
      
      static const xtd::drawing::color medium_sea_green;
      
      static const xtd::drawing::color medium_slate_blue;
      
      static const xtd::drawing::color medium_spring_green;
      
      static const xtd::drawing::color medium_turquoise;
      
      static const xtd::drawing::color medium_violet_red;
      
      static const xtd::drawing::color midnight_blue;
      
      static const xtd::drawing::color mint_cream;
      
      static const xtd::drawing::color misty_rose;
      
      static const xtd::drawing::color moccasin;
      
      static const xtd::drawing::color navajo_white;
      
      static const xtd::drawing::color navy;
      
      static const xtd::drawing::color old_lace;
      
      static const xtd::drawing::color olive;
      
      static const xtd::drawing::color olive_drab;
      
      static const xtd::drawing::color orange;
      
      static const xtd::drawing::color orange_red;
      
      static const xtd::drawing::color orchid;
      
      static const xtd::drawing::color pale_goldenrod;
      
      static const xtd::drawing::color pale_green;
      
      static const xtd::drawing::color pale_turquoise;
      
      static const xtd::drawing::color pale_violet_red;
      
      static const xtd::drawing::color papaya_whip;
      
      static const xtd::drawing::color peach_puff;
      
      static const xtd::drawing::color peru;
      
      static const xtd::drawing::color pink;
      
      static const xtd::drawing::color plum;
      
      static const xtd::drawing::color powder_blue;
      
      static const xtd::drawing::color purple;
      
      static const xtd::drawing::color rebecca_purple;
      
      static const xtd::drawing::color red;
      
      static const xtd::drawing::color rosy_brown;
      
      static const xtd::drawing::color royal_blue;
      
      static const xtd::drawing::color saddle_brown;
      
      static const xtd::drawing::color salmon;
      
      static const xtd::drawing::color sandy_brown;
      
      static const xtd::drawing::color sea_green;
      
      static const xtd::drawing::color sea_shell;
      
      static const xtd::drawing::color sienna;
      
      static const xtd::drawing::color silver;
      
      static const xtd::drawing::color sky_blue;
      
      static const xtd::drawing::color slate_blue;
      
      static const xtd::drawing::color slate_gray;
      
      static const xtd::drawing::color snow;
      
      static const xtd::drawing::color spring_green;
      
      static const xtd::drawing::color steel_blue;
      
      static const xtd::drawing::color tan;
      
      static const xtd::drawing::color teal;
      
      static const xtd::drawing::color thistle;
      
      static const xtd::drawing::color tomato;
      
      static const xtd::drawing::color turquoise;
      
      static const xtd::drawing::color violet;
      
      static const xtd::drawing::color wheat;
      
      static const xtd::drawing::color white;
      
      static const xtd::drawing::color white_smoke;
      
      static const xtd::drawing::color yellow;
      
      static const xtd::drawing::color yellow_green;
      
      static constexpr double lightness_threshold = 0.5;
      
      
      color() = default;
      
      color(const color& color) = default;
      color& operator =(const color& color) = default;
      
      
      [[nodiscard]] auto a() const noexcept -> xtd::byte;
      
      [[nodiscard]] auto b() const noexcept -> xtd::byte;
      
      [[nodiscard]] auto g() const noexcept -> xtd::byte;
      
      [[nodiscard]] auto handle() const noexcept -> xtd::intptr;
      
      [[nodiscard]] auto is_dark() const noexcept -> bool;
      
      [[nodiscard]] auto is_empty() const noexcept -> bool;
      
      [[nodiscard]] auto is_known_color() const noexcept -> bool;
      
      [[nodiscard]] auto is_light() const noexcept -> bool;
      
      [[nodiscard]] auto is_named_color() const noexcept -> bool;
      
      [[nodiscard]] bool is_system_color() const noexcept;
      
      [[nodiscard]] auto name() const noexcept -> xtd::string;
      
      [[nodiscard]] auto r() const noexcept -> xtd::byte;
      
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const color& other) const noexcept -> bool override;
      
      [[nodiscard]] auto get_brightness() const noexcept -> float;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;
      
      [[nodiscard]] auto get_hue() const noexcept -> float;
      
      [[nodiscard]] auto get_saturation() const noexcept -> float;
      
      [[nodiscard]] auto to_argb() const noexcept -> xtd::drawing::argb;
      
      [[nodiscard]] auto to_cmyk() const noexcept -> xtd::drawing::cmyk;

      [[nodiscard]] auto to_known_color() const noexcept -> xtd::drawing::known_color;
      
      [[nodiscard]] auto to_hsb() const noexcept -> xtd::drawing::hsb;
      
      [[nodiscard]] auto to_hsl() const noexcept -> xtd::drawing::hsl;
      
      [[nodiscard]] auto to_hsv() const noexcept -> xtd::drawing::hsv;

      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
      
      [[nodiscard]] auto to_uint32() const noexcept -> xtd::uint32;
      
      [[nodiscard]] auto to_yuv() const noexcept -> xtd::drawing::yuv;

      
      [[nodiscard]] operator xtd::drawing::argb() const noexcept;
      [[nodiscard]] operator xtd::drawing::cmyk() const noexcept;
      [[nodiscard]] operator xtd::drawing::hsb() const noexcept;
      [[nodiscard]] operator xtd::drawing::hsl() const noexcept;
      [[nodiscard]] operator xtd::drawing::hsv() const noexcept;
      [[nodiscard]] operator xtd::drawing::yuv() const noexcept;
      [[nodiscard]] operator xtd::uint32() const noexcept;

      
      [[nodiscard]] static auto dark(const color& color, double percent) noexcept -> xtd::drawing::color;
      
     
      [[nodiscard]] static auto from_argb(uint32 argb) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_argb(xtd::byte alpha, const xtd::drawing::color& base_color) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_argb(xtd::byte alpha, xtd::byte red, xtd::byte green, xtd::byte blue) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_argb(xtd::byte red, xtd::byte green, xtd::byte blue) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_argb(const xtd::drawing::argb& argb) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto from_cmyk(float cyan, float magenta, float yellow, float black) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_cmyk(const xtd::drawing::cmyk& cmyk) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto from_handle(intptr handle) noexcept -> xtd::drawing::color;
      
      [[nodiscard]] static auto from_hsb(float hue, float saturation, float brightness) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_hsb(const xtd::drawing::hsb& hsb) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto from_hsl(float hue, float saturation, float lightness) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_hsl(const xtd::drawing::hsl& hsl) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto from_hsv(float hue, float saturation, float value) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_hsv(const xtd::drawing::hsv& hsv) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto from_known_color(xtd::drawing::known_color color) -> xtd::drawing::color;
      
      [[nodiscard]] static auto from_name(const xtd::string& name) noexcept -> xtd::drawing::color;
      
      [[nodiscard]] static auto from_uint32(xtd::uint32 argb) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto from_yuv(float y, float u, float v) noexcept -> xtd::drawing::color;
      [[nodiscard]] static auto from_yuv(const xtd::drawing::yuv& yuv) noexcept -> xtd::drawing::color;

      [[nodiscard]] static auto parse(const xtd::string& color) noexcept -> xtd::drawing::color;
      
      
      [[deprecated("Replaced by xtd::drawing::color::to_hsl - Will be removed in version 1.2.0.")]]
      [[nodiscard]] auto get_lightness() const noexcept -> float;

      [[deprecated("Replaced by xtd::drawing::color::to_yuv - Will be removed in version 1.2.0.")]]
      [[nodiscard]] auto get_u() const noexcept -> float;
      
      [[deprecated("Replaced by xtd::drawing::color::to_hsv - Will be removed in version 1.2.0.")]]
      [[nodiscard]] auto get_value() const noexcept -> float;

      [[deprecated("Replaced by xtd::drawing::color::to_yuv - Will be removed in version 1.2.0.")]]
      [[nodiscard]] auto get_v() const noexcept -> float;
      
      [[deprecated("Replaced by xtd::drawing::color::to_yuv - Will be removed in version 1.2.0.")]]
      [[nodiscard]] auto get_y() const noexcept -> float;

      
      [[deprecated("Replaced by xtd::drawing::color_converter::average - Will be removed in version 1.2.0.")]]
      [[nodiscard]] static auto average(const color& color1, const color& color2, double weight) noexcept -> xtd::drawing::color;
      [[deprecated("Replaced by xtd::drawing::color_converter::average - Will be removed in version 1.2.0.")]]
      [[nodiscard]] static auto average(const color& color1, const color& color2, double weight, bool average_alpha) noexcept -> xtd::drawing::color;
      
      [[deprecated("Replaced by xtd::drawing::color_converter::dark - Will be removed in version 1.2.0.")]]
      [[nodiscard]] static auto dark(const color& color) noexcept -> xtd::drawing::color;
      [[deprecated("Replaced by xtd::drawing::color_converter::light - Will be removed in version 1.2.0.")]]
      [[nodiscard]] static auto light(const color& color) noexcept -> xtd::drawing::color;
      [[deprecated("Replaced by xtd::drawing::color_converter::light - Will be removed in version 1.2.0.")]]
      [[nodiscard]] static auto light(const color& color, double percent) noexcept -> xtd::drawing::color;
      
    private:
      static constexpr xtd::drawing::known_color start_know_system_colors_range = static_cast<xtd::drawing::known_color>(0xFF01);
      explicit color(uint32 argb);
      explicit color(intptr handle);
      color(const color& color, const xtd::drawing::known_color& know_color);
      
      uint32 argb_ = 0;
      bool empty_ = true;
      intptr handle_ = 0;
      xtd::drawing::known_color known_color_ = static_cast<xtd::drawing::known_color>(0);
      xtd::string name_;
    };
  }
  
  template<>
  inline drawing::color parse<drawing::color>(const std::string& str) {
    return drawing::color::parse(str);
  }
}
 
#include "../literals/color.hpp"