From c3a0226012f73319f347f723de51720b8d07208f Mon Sep 17 00:00:00 2001 From: Nick Benik Date: Fri, 21 Dec 2018 17:51:09 -0500 Subject: [PATCH] Normalize API doc styling --- HsbColor-object-API.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/HsbColor-object-API.md b/HsbColor-object-API.md index d2bf52f..7fefd22 100644 --- a/HsbColor-object-API.md +++ b/HsbColor-object-API.md @@ -16,9 +16,13 @@ float B; ### HsbColor(float h, float s, float b) : Constructs a HsbColor using Hue, Saturation, and Brightness color component values. +> * _h_ - value for Hue component (0.0f - 1.0f). +> * _s_ - value for Saturation component (0.0f - 1.0f). +> * _b_ - value for Brightness (0.0f - 1.0f). ### HsbColor(RgbColor color); Construct a HsbColor using RgbColor, converting the Rgb to Hsb +> * _color_ - a RgbColor object. ### HsbColor() Construct a HsbColor that will have its values set in latter operations. @@ -28,9 +32,9 @@ CAUTION: The H,S,B members are not initialized and may not be consistent until ### template \ static HsbColor LinearBlend(HsbColor left, HsbColor 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... ``` HsbColor results = HsbColor::LinearBlend(HsbColor(0.88f,1.0f,1.0f), HsbColor(0.12f,1.0f,1.0f), 0.33f);