redgreenblue 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f836ad38758f98dc7f9d677e9bf97dcfd878a09e994622b16b4854d1bff01277
-  data.tar.gz: 938a0a5efefa5c4f181bccdb996be922ad51d8dfd7cfe623209d4582aa19d4e5
+  metadata.gz: 2359fa39f6387727f76770372b1f798ae60fdf34dce8bd481b06d58e5a128c4b
+  data.tar.gz: 6194f07e51ce46a4c9bdd3fd7d2fd895eebcb8e6f34e76c37b3c078d3ea58fb9
 SHA512:
-  metadata.gz: c40b54efa01653b785065707a57841fd156ba6238a4eccbc09454f969b1cfd08439bbb70431de985874606fe88115e7688dc2e8819c83335bbfd17a0c339a557
-  data.tar.gz: 4a7cdf6351af6e718ac857aaf87c052f1fc85110aca42eb049a22e18f63c25188a5e0189713ff46fa9ee7573e5a4d7729979fdf892a6c1a1f992fd127045618c
+  metadata.gz: e76a1651bfac0b0f197cae93a9fa3139e798a3a2ab0ae00950d08eb5e724834f9ccce7fe06beb98b083988fd4d7b672431aee5c23a66c24cce2782669606b517
+  data.tar.gz: 688367a83417deb0a812e96982f9c44ec369a1ee6984836338c25b07bd11843ced02053341044cebcaf2e4e71ce5ef26316799850831e446b85ece5766d31ddf

data/lib/redgreenblue/24bit.rb

@@ -44,7 +44,7 @@ class RGB::Color
     self.r, self.g, self.b = rgb.flatten
   end
 
-  # Creates a new Color object from red, green, and blue components as integers in the range 0..255 (three 8-bit values).
+  # Creates a new RGB::Color from red, green, and blue components as integers in the range 0..255 (three 8-bit values).
   def self.rgb(*rgb)
     c = self.new
     c.rgb = rgb
@@ -57,22 +57,19 @@ class RGB::Color
     self
   end
 
-  # Creates a new RGB object containing the nearest 24-bit color.
+  # Creates a new RGB::Color containing the nearest 24-bit color.
   def snap
     RGB.rgb rgb
   end
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new Color object from red, green, and blue components as integers in the range 0..255 (three 8-bit values).
+    # Creates a new RGB::Color from red, green, and blue components as integers in the range 0..255 (three 8-bit values).
     def rgb(*rgb)
       Color.rgb(*rgb)
     end

data/lib/redgreenblue/48bit.rb

@@ -44,7 +44,7 @@ class RGB::Color
     self.rr, self.gg, self.bb = rrggbb.flatten
   end
 
-  # Creates a new Color object from red, green, and blue components as integers in the range 0..65535 (three 16-bit values).
+  # Creates a new RGB::Color from red, green, and blue components as integers in the range 0..65535 (three 16-bit values).
   def self.rrggbb(*rrggbb)
     c = self.new
     c.rrggbb = rrggbb
@@ -53,15 +53,12 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new Color object from red, green, and blue components as integers in the range 0..65535 (three 16-bit values).
+    # Creates a new RGB::Color from red, green, and blue components as integers in the range 0..65535 (three 16-bit values).
     def rrggbb(*rrggbb)
       Color.rrggbb(*rrggbb)
     end

data/lib/redgreenblue/base.rb

@@ -88,7 +88,7 @@ module RGB
 
   class << self
 
-    # Creates a new Color object from red, green, and blue components as three values between 0 and 1.
+    # Creates a new RGB::Color from red, green, and blue components as three values between 0 and 1.
     def new(*a)
       Color.new(*a)
     end

data/lib/redgreenblue/bgr24bit.rb

@@ -10,7 +10,7 @@ class RGB::Color
     self.b, self.g, self.r = bgr_string.unpack('C3')
   end
 
-  # Creates a new RGB::Color object from BGR24 data (a 3-byte string).
+  # Creates a new RGB::Color from BGR24 data (a 3-byte string).
   def self.bgr24(bgr)
     c = self.new
     c.bgr24 = bgr
@@ -19,15 +19,12 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new RGB::Color object from BGR24 data (a 3-byte string).
+    # Creates a new RGB::Color from BGR24 data (a 3-byte string).
     def bgr24(bgr)
       Color.bgr24(bgr)
     end

data/lib/redgreenblue/cie_1931.rb

@@ -1,5 +1,20 @@
 class RGB::Color
 
+  class << self
+
+    # Creates a new RGB::Color from CIE 1931 XYZ values.
+    #
+    # Assumes the XYZ values are relative to D65 reference white, the same as used in sRGB.
+    def cie_xyz(*a)
+      c = self.new
+      c.cie_xyz = a
+      c
+    end
+
+    alias xyz cie_xyz
+
+  end
+
   # Returns CIE 1931 XYZ values for the RGB::Color object.
   #
   # Based on:
@@ -11,41 +26,74 @@ class RGB::Color
     r, g, b = linear_values
 
     [
-
       r * 0.4124_5643_9090 + g * 0.3575_7607_7644 + b * 0.1804_3748_3266,
       r * 0.2126_7285_1406 + g * 0.7151_5215_5288 + b * 0.0721_7499_3307,
       r * 0.0193_3389_5582 + g * 0.1191_9202_5881 + b * 0.9503_0407_8536
-
     ].map { |v| round ? v.round(8) : v }
   end
 
   alias xyz cie_xyz
 
+  # Sets the red, green, and blue values by converting the given CIE 1931 XYZ values to RGB.
+  #
+  # Assumes the XYZ values are relative to D65 reference white, the same as used in sRGB.
+  #
+  # Based on:
+  # - http://www.brucelindbloom.com/index.html?Eqn_XYZ_to_RGB.html
+  # XYZ to sRGB matrix for D65 reference white calculated with Javascript by Bruce Lindbloom:
+  # - http://www.brucelindbloom.com/ColorCalculator.html
+  def cie_xyz=(*a)
+    x, y, z = a.flatten
+    self.linear_values = [
+      x *  3.2404_5416_2114 + y * -1.5371_3851_2798 + z * -0.498_5314_09556,
+      x * -0.9692_6603_0505 + y *  1.8760_1084_5447 + z *  0.0415_5601_7530,
+      x *  0.0556_4343_0959 + y * -0.2040_2591_3517 + z *  1.0572_2518_8223
+    ]
+  end
+
+  alias xyz= cie_xyz=
+
   # Returns CIE 1931 xyY values for the RGB::Color object.
   #
   # Based on:
   # - https://en.wikipedia.org/wiki/CIE_1931_color_space
   # - http://www.brucelindbloom.com/index.html?Eqn_XYZ_to_xyY.html
   # - https://ninedegreesbelow.com/photography/xyz-rgb.html
-  def cie_xyy
+  def cie_xyy(round: true)
     x, y, z = cie_xyz(round: false)
 
     [
-
       x / ( x + y + z ),
       y / ( x + y + z ),
       y
-
-    ].map { |v| v.round(8) }
+    ].map { |v| round ? v.round(8) : v }
   end
 
   alias xyy cie_xyy
 
   # Returns CIE 1931 xy values for the RGB::Color object.
-  def cie_xy
-    cie_xyy[0..1]
+  def cie_xy(round: true)
+    cie_xyy(round: round)[0..1]
   end
 
   alias xy cie_xy
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a new RGB::Color from CIE 1931 XYZ values.
+    #
+    # Assumes the XYZ values are relative to D65 reference white, the same as used in sRGB.
+    def cie_xyz(*a)
+      RGB::Color.cie_xyz(a)
+    end
+
+    alias xyz cie_xyz
+
+  end
+
+end

data/lib/redgreenblue/gpl.rb

@@ -1,12 +1,8 @@
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
-
   class << self
 
-    # Creates a new RGB::Color object from a line of gpl (Gimp color palette) input. Returns nil if not successful.
+    # Creates a new RGB::Color from a line of gpl (Gimp color palette) input. Returns nil if not successful.
     #
     # @example
     #  RGB::Color.gpl "255 153 204\tpink"
@@ -22,9 +18,6 @@ class RGB::Color
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
 
   # Returns the color in the format used in .gpl files (Gimp color palettes), including its name (if present).
   #
@@ -41,7 +34,7 @@ module RGB
 
   class << self
 
-    # Creates a new RGB::Color object from a line of gpl (Gimp color palette) input. Returns nil if not successful.
+    # Creates a new RGB::Color from a line of gpl (Gimp color palette) input. Returns nil if not successful.
     #
     # @example
     #  RGB.gpl "255 153 204\tpink"

data/lib/redgreenblue/hex.rb

@@ -28,11 +28,8 @@ class RGB::Color
     '%02x%02x%02x' % [ r, g, b ]
   end
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
 
-  # Creates a new Color object from a 6- or 3-digit hexadecimal string representing red, green, and blue.
+  # Creates a new RGB::Color from a 6- or 3-digit hexadecimal string representing red, green, and blue.
   #
   # The string may include a '#' prefix.
   def self.hex(hex_string)
@@ -49,7 +46,7 @@ module RGB
 
   class << self
 
-    # Creates a new Color object from a 6- or 3-digit hexadecimal string representing red, green, and blue.
+    # Creates a new RGB::Color from a 6- or 3-digit hexadecimal string representing red, green, and blue.
     #
     # The string may include a '#' prefix.
     def hex(hex_string)

data/lib/redgreenblue/hsb.rb

@@ -2,21 +2,13 @@ require 'redgreenblue/hsv'
 
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
-
   class << self
 
-    # Creates a new RGB::Color object from HSB values: hue (0..360), saturation (0..1), and brightness (0..1).
+    # Creates a new RGB::Color from HSB values: hue (0..360), saturation (0..1), and brightness (0..1).
     alias hsb hsv
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   # Returns color as HSB:
   # hue (0..360), saturation (0..1), brightness (0..1).
   # When saturation is 0, hue is nil.
@@ -60,15 +52,12 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new RGB::Color object from HSB values: hue (0..360), saturation (0..1), and brightness (0..1).
+    # Creates a new RGB::Color from HSB values: hue (0..360), saturation (0..1), and brightness (0..1).
     alias hsb hsv
 
   end

data/lib/redgreenblue/hsl.rb

@@ -3,13 +3,9 @@ require 'redgreenblue/math'
 
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
-
   class << self
 
-    # Creates a new RGB::Color object from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
+    # Creates a new RGB::Color from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
     def hsl(*a)
       new hsl_to_values(*a)
     end
@@ -23,10 +19,6 @@ class RGB::Color
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   # Returns color as HSL:
   # hue (0..360), saturation (0..1), lightness (0..1).
   # When saturation is 0, hue is nil.
@@ -95,15 +87,12 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new RGB::Color object from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
+    # Creates a new RGB::Color from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
     def hsl(*a)
       Color.hsl(*a)
     end

data/lib/redgreenblue/hsv.rb

@@ -3,13 +3,9 @@ require 'redgreenblue/math'
 
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
-
   class << self
 
-    # Creates a new RGB::Color object from HSV values: hue (0..360), saturation (0..1), and value (0..1).
+    # Creates a new RGB::Color from HSV values: hue (0..360), saturation (0..1), and value (0..1).
     def hsv(*a)
       new hsv_to_values(*a)
     end
@@ -23,10 +19,6 @@ class RGB::Color
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   # Returns color as HSV:
   # hue (0..360), saturation (0..1), value (0..1).
   # When saturation is 0, hue is nil.
@@ -95,15 +87,12 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new RGB::Color object from HSV values: hue (0..360), saturation (0..1), and value (0..1).
+    # Creates a new RGB::Color from HSV values: hue (0..360), saturation (0..1), and value (0..1).
     def hsv(*a)
       Color.hsv(*a)
     end

data/lib/redgreenblue/hsx_shared.rb

@@ -1,9 +1,5 @@
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
-
   class << self
 
     private
@@ -48,10 +44,6 @@ class RGB::Color
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   private
 
   # Compute HSL, HSV, and chroma.

data/lib/redgreenblue/inspect.rb

@@ -42,9 +42,6 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 

data/lib/redgreenblue/int.rb

@@ -5,7 +5,7 @@ class RGB::Color
     ( r << 16 ) + ( g << 8 ) + b
   end
 
-  # Creates a new RGB::Color object from a 24-bit integer in the range 0..16777215.
+  # Creates a new RGB::Color from a 24-bit integer in the range 0..16777215.
   def self.at(number)
     n = number.to_i
     if (0..16777215) === n
@@ -21,15 +21,12 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a new RGB::Color object from a 24-bit integer in the range 0..16777215.
+    # Creates a new RGB::Color from a 24-bit integer in the range 0..16777215.
     def at(number)
       Color.at(number)
     end

data/lib/redgreenblue/lazy.rb

@@ -1,22 +1,19 @@
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
 
   class << self
 
-    # Creates a white RGB::Color object.
+    # Creates a white RGB::Color.
     def white
       new(1,1,1)
     end
 
-    # Creates a black RGB::Color object.
+    # Creates a black RGB::Color.
     def black
       new(0,0,0)
     end
 
-    # Creates a grey RGB::Color object. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
+    # Creates a grey RGB::Color. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
     #
     # ::gray is an alias for ::grey.
     def grey(lightness=0.5)
@@ -26,32 +23,32 @@ class RGB::Color
     # Alias gray for grey.
     alias gray grey
 
-    # Creates a pure red RGB::Color object.
+    # Creates a pure red RGB::Color.
     def red
       new(1,0,0)
     end
 
-    # Creates a pure green RGB::Color object.
+    # Creates a pure green RGB::Color.
     def green
       new(0,1,0)
     end
 
-    # Creates a pure blue RGB::Color object.
+    # Creates a pure blue RGB::Color.
     def blue
       new(0,0,1)
     end
 
-    # Creates a yellow RGB::Color object.
+    # Creates a yellow RGB::Color.
     def yellow
       new(1,1,0)
     end
 
-    # Creates a cyan RGB::Color object.
+    # Creates a cyan RGB::Color.
     def cyan
       new(0,1,1)
     end
 
-    # Creates a magenta RGB::Color object.
+    # Creates a magenta RGB::Color.
     def magenta
       new(1,0,1)
     end
@@ -72,25 +69,22 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 
   class << self
 
-    # Creates a white RGB::Color object.
+    # Creates a white RGB::Color.
     def white
       Color.white
     end
 
-    # Creates a black RGB::Color object.
+    # Creates a black RGB::Color.
     def black
       Color.black
     end
 
-    # Creates a grey RGB::Color object. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
+    # Creates a grey RGB::Color. Defaults to lightness 0.5, a middle grey. Black equals grey(0), white equals grey(1).
     #
     # ::gray is an alias for ::grey.
     def grey(lightness=0.5)
@@ -100,32 +94,32 @@ module RGB
     # Alias gray for grey.
     alias gray grey
 
-    # Creates a pure red RGB::Color object.
+    # Creates a pure red RGB::Color.
     def red
       Color.red
     end
 
-    # Creates a pure green RGB::Color object.
+    # Creates a pure green RGB::Color.
     def green
       Color.green
     end
 
-    # Creates a pure blue RGB::Color object.
+    # Creates a pure blue RGB::Color.
     def blue
       Color.blue
     end
 
-    # Creates a yellow RGB::Color object.
+    # Creates a yellow RGB::Color.
     def yellow
       Color.yellow
     end
 
-    # Creates a cyan RGB::Color object.
+    # Creates a cyan RGB::Color.
     def cyan
       Color.cyan
     end
 
-    # Creates a magenta RGB::Color object.
+    # Creates a magenta RGB::Color.
     def magenta
       Color.magenta
     end

data/lib/redgreenblue/misc.rb

@@ -51,9 +51,6 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 

data/lib/redgreenblue/ostwald.rb

@@ -1,6 +1,6 @@
 class RGB::Color
 
-  # Returns a new RGB::Color object with this color's Ostwald full-color,
+  # Returns a new RGB::Color with this color's Ostwald full-color,
   # or nil for achromatic colors (white, greys, and black).
   #
   # The resulting color contains no white or black,

data/lib/redgreenblue/random.rb

@@ -24,9 +24,6 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 

data/lib/redgreenblue/rgb565.rb

@@ -24,9 +24,6 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 

data/lib/redgreenblue/version.rb

@@ -1,7 +1,7 @@
 module RGB
 
   # redgreenblue version.
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 
   # Returns RGB::VERSION.
   def self.version

data/lib/redgreenblue/web.rb

@@ -1,9 +1,5 @@
 class RGB::Color
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
   # Returns the object's RGB value in hexadecimal notation as used in CSS.
   #
   # Shortens to 3 digits when possible.
@@ -62,9 +58,6 @@ class RGB::Color
 
 end
 
-#----------------------------------------------------------------------#
-#                            Module Methods                            #
-#----------------------------------------------------------------------#
 
 module RGB
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redgreenblue
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies: []
 description:
 email: