DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

111 lines
3.2KB

  1. /*
  2. * DISTRHO Plugin Framework (DPF)
  3. * Copyright (C) 2012-2019 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * Permission to use, copy, modify, and/or distribute this software for any purpose with
  6. * or without fee is hereby granted, provided that the above copyright notice and this
  7. * permission notice appear in all copies.
  8. *
  9. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
  10. * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
  11. * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  12. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
  13. * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15. */
  16. #ifndef DGL_COLOR_HPP_INCLUDED
  17. #define DGL_COLOR_HPP_INCLUDED
  18. #include "Base.hpp"
  19. struct NVGcolor;
  20. START_NAMESPACE_DGL
  21. // -----------------------------------------------------------------------
  22. /**
  23. A color made from red, green, blue and alpha floating-point values in [0..1] range.
  24. */
  25. struct Color {
  26. /**
  27. Direct access to the color values.
  28. */
  29. union {
  30. float rgba[4];
  31. struct { float red, green, blue, alpha; };
  32. };
  33. /**
  34. Create solid black color.
  35. */
  36. Color() noexcept;
  37. /**
  38. Create a color from red, green, blue and alpha numeric values.
  39. Values must be in [0..255] range.
  40. */
  41. Color(int red, int green, int blue, int alpha = 255) noexcept;
  42. /**
  43. Create a color from red, green, blue and alpha floating-point values.
  44. Values must in [0..1] range.
  45. */
  46. Color(float red, float green, float blue, float alpha = 1.0f) noexcept;
  47. /**
  48. Create a color by copying another color.
  49. */
  50. Color(const Color& color) noexcept;
  51. Color& operator=(const Color& color) noexcept;
  52. /**
  53. Create a color by linearly interpolating two other colors.
  54. */
  55. Color(const Color& color1, const Color& color2, float u) noexcept;
  56. /**
  57. Create a color specified by hue, saturation and lightness.
  58. Values must in [0..1] range.
  59. */
  60. static Color fromHSL(float hue, float saturation, float lightness, float alpha = 1.0f);
  61. /**
  62. Create a color from a HTML string like "#333" or "#112233".
  63. */
  64. static Color fromHTML(const char* rgb, float alpha = 1.0f);
  65. /**
  66. Linearly interpolate this color against another.
  67. */
  68. void interpolate(const Color& other, float u) noexcept;
  69. /**
  70. Check if this color matches another.
  71. @note Comparison is forced within 8-bit color values.
  72. */
  73. bool isEqual(const Color& color, bool withAlpha = true) noexcept;
  74. bool isNotEqual(const Color& color, bool withAlpha = true) noexcept;
  75. bool operator==(const Color& color) noexcept;
  76. bool operator!=(const Color& color) noexcept;
  77. /**
  78. Fix color bounds if needed.
  79. */
  80. void fixBounds() noexcept;
  81. /**
  82. @internal
  83. Needed for NanoVG compatibility.
  84. */
  85. Color(const NVGcolor&) noexcept;
  86. operator NVGcolor() const noexcept;
  87. };
  88. // -----------------------------------------------------------------------
  89. END_NAMESPACE_DGL
  90. #endif // DGL_COLOR_HPP_INCLUDED