diff --git a/RgbColor-object-API.md b/RgbColor-object-API.md index 3604056..a532d09 100644 --- a/RgbColor-object-API.md +++ b/RgbColor-object-API.md @@ -72,6 +72,19 @@ Lighten will adjust the color by the given delta toward white. NOTE: This is a simple linear change. > * _delta_ - (0-255) the amount to lighten the color by. +### int16_t CompareTo(const RgbColor& other, uint8_t epsilon = 1) +Compares against another color with the given epsilon. +Returns the greatest difference of a set of elements, where 0 means the colors are equal within epsilon delta, negative means this is less than the other, positive means this is greater than the other. +> * _other_ - the color to compare against. +> * _epsilon_ - the max delta acceptable for them to be considered the same color. + +### static int16_t Compare(const RgbColor& left, const RgbColor& right, uint8_t epsilon = 1) +Compares two colors with the given epsilon. +Returns the greatest difference of a set of elements, where 0 means the colors are equal within epsilon delta, negative means left is less than the right, positive means left is greater than the right. +> * _left_ - the first color to compare. +> * _right_ - the other color to compare. +> * _epsilon_ - the max delta acceptable for them to be considered the same color. + ### static RgbColor LinearBlend(RgbColor left, RgbColor right, float progress); This will blend between two colors by the amount defined by the progress variable. > * _left_ - the color to start the blend at.