Documenting code

This commit is contained in:
Paul Peavyhouse
2019-10-22 13:07:01 -07:00
parent 6aff9f65ed
commit 69d7d53768
2 changed files with 21 additions and 11 deletions

View File

@@ -105,11 +105,11 @@ lv_color_t lv_color_hsv_to_rgb(uint16_t h, uint8_t s, uint8_t v)
} }
/** /**
* Convert an 32-bit RGB color to HSV * Convert a 32-bit RGB color to HSV
* @param r red * @param r8 8-bit red
* @param g green * @param g8 8-bit green
* @param b blue * @param b8 8-bit blue
* @return the given RGB color n HSV * @return the given RGB color in HSV
*/ */
lv_color_hsv_t lv_color_rgb_to_hsv(uint8_t r8, uint8_t g8, uint8_t b8) lv_color_hsv_t lv_color_rgb_to_hsv(uint8_t r8, uint8_t g8, uint8_t b8)
{ {
@@ -152,6 +152,11 @@ lv_color_hsv_t lv_color_rgb_to_hsv(uint8_t r8, uint8_t g8, uint8_t b8)
return hsv; return hsv;
} }
/**
* Convert a color to HSV
* @param color color
* @return the given color in HSV
*/
lv_color_hsv_t lv_color_to_hsv(lv_color_t color) lv_color_hsv_t lv_color_to_hsv(lv_color_t color)
{ {
lv_color32_t color32; lv_color32_t color32;

View File

@@ -463,14 +463,19 @@ static inline lv_color_t lv_color_hex3(uint32_t c)
lv_color_t lv_color_hsv_to_rgb(uint16_t h, uint8_t s, uint8_t v); lv_color_t lv_color_hsv_to_rgb(uint16_t h, uint8_t s, uint8_t v);
/** /**
* Convert an RGB color to HSV * Convert a 32-bit RGB color to HSV
* @param r red * @param r8 8-bit red
* @param g green * @param g8 8-bit green
* @param b blue * @param b8 8-bit blue
* @return the given RGB color n HSV * @return the given RGB color in HSV
*/ */
lv_color_hsv_t lv_color_rgb_to_hsv(uint8_t r, uint8_t g, uint8_t b); lv_color_hsv_t lv_color_rgb_to_hsv(uint8_t r8, uint8_t g8, uint8_t b8);
/**
* Convert a color to HSV
* @param color color
* @return the given color in HSV
*/
lv_color_hsv_t lv_color_to_hsv(lv_color_t color); lv_color_hsv_t lv_color_to_hsv(lv_color_t color);
/********************** /**********************