diff --git a/HslColor-object-API.md b/HslColor-object-API.md index 1ce47c9..6c4de3c 100644 --- a/HslColor-object-API.md +++ b/HslColor-object-API.md @@ -5,7 +5,7 @@ HslColor represents a color object that is represented by Hue, Saturation, Light ## Properties There are three properties that represent the component values Hue, Saturation, and Lightness. The values range from 0.0f to 1.0f. -H is the primary color component and represents a color wheel. Often you will see examples of this being between 0 and 360, but this library it is between 0.0f and 1.0f inclusive. +H is the primary color component and represents a color wheel. Often you will see examples of this being between 0 and 360, but this library is between 0.0f and 1.0f inclusive. L should be generally limited to between (0.0 - 0.5) ``` float H; @@ -17,9 +17,13 @@ float L; ### HslColor(float h, float s, float l) : Constructs a HslColor using Hue, Saturation, and Lightness color component values. +> * _h_ - value for Hue component (0.0f - 1.0f). +> * _s_ - value for Saturation component (0.0f - 1.0f). +> * _l_ - value for Lightness component (0.0f - 1.0f). ### HslColor(RgbColor color); Construct a HslColor using RgbColor, converting the Rgb to Hsl +> * _color_ - a RgbColor object. ### HslColor() Construct a HslColor that will have its values set in latter operations. @@ -29,9 +33,9 @@ CAUTION: The H,S,L members are not initialized and may not be consistent until ### template \ static HslColor LinearBlend(HslColor left, HslColor right, float progress) This will blend between two colors by the amount defined by the progress variable. T_NEOHUEBLEND - [a NeoHueBlend object](https://github.com/Makuna/NeoPixelBus/wiki/NeoHueBlend-objects), that will define how the colors are blended. -left - the color to start the blend at. -right - the color to end the blend at. -progress - (0.0f - 1.0f) value where 0.0f will return left and 1.0f will return right and a value between will blend the color weighted linearly between them. +> * _left_ - the color to start the blend at. +> * _right_ - the color to end the blend at. +> * _progress_ - (0.0f - 1.0f) value where 0.0f will return left and 1.0f will return right and a value between will blend the color weighted linearly between them. This is a static function, which means you need to call it scoped to the object class and not an instance like... ``` HslColor results = HslColor::LinearBlend(HslColor(0.88f,1.0f,0.5f), HslColor(0.12f,1.0f,0.5f), 0.33f);