a752c7ab
 elopes
add first test an...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* Copyright (C) 2014 - 2016 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License v2.1. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup sys_color Color
* @ingroup sys
* @brief The color sys module supports handling RGB and HSV color
* @{
*
* @file
* @brief Headers for the color handling module
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Cenk Gündoğan <mail@cgundogan.de>
* @author Simon Brummer <brummer.simon@googlemail.com>
*/
#ifndef COLOR_H
#define COLOR_H
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Data-structure describing a RGB color
*/
typedef struct {
uint8_t r; /**< red value [0 - 255] */
uint8_t g; /**< green value [0 - 255] */
uint8_t b; /**< blue value [0 - 255] */
} color_rgb_t;
/**
* @brief RGBA color value
*/
typedef struct {
color_rgb_t color; /**< RGB value */
uint8_t alpha; /**< alpha value [0 - 255] */
} color_rgba_t;
/**
* @brief Data-structure for holding HSV colors
*/
typedef struct {
float h; /**< hue value [0.0 - 360.0] */
float s; /**< saturation value [0.0 - 1.0] */
float v; /**< value [0.0 - 1.0] */
} color_hsv_t;
/**
* @brief Convert RGB color to HSV color
*
* @param[in] rgb Input color encoded in RGB space
* @param[out] hsv Output color encoded in HSV space
*/
void color_rgb2hsv(color_rgb_t *rgb, color_hsv_t *hsv);
/**
* @brief Convert HSV color to RGB color
*
* @param[in] hsv Input color encoded in HSV space
* @param[out] rgb Output color encoded in RGB space
*/
void color_hsv2rgb(color_hsv_t *hsv, color_rgb_t *rgb);
/**
* @brief Convert a @p hex value of the form 0x00RRGGBB to an RGB color struct
*
* @note the two most significant bytes of @p hex will be ignored
*
* @param[in] hex Input color encoded in hex
* @param[out] rgb Output color encoded in RGB space
*/
void color_hex2rgb(const uint32_t hex, color_rgb_t *rgb);
/**
* @brief Convert a @p rgb struct to a @p hex value of the form 0x00RRGGBB
*
* @note the two most significant bytes of @p hex will be 0
*
* @param[in] rgb Input color encoded in RGB space
* @param[out] hex Output color encoded in hex
*/
void color_rgb2hex(const color_rgb_t *rgb, uint32_t *hex);
/**
* @brief Convert a hex color string of the form 'RRGGBB' to a color_rgb_t struct
*
* @note @p str MUST contain only hexadecimal digits.
* Expect unexpected behaviour, otherwise.
*
* @param[in] str Input color encoded as string of the form 'RRGGBB'
* @param[out] color Output color encoded in RGB space
*/
void color_str2rgb(const char *str, color_rgb_t *color);
/**
* @brief Convert a color_rgb_t struct to a hex color string of the form 'RRGGBB'
*
* @note @p str MUST be big enough to hold 6 characters
*
* @param[in] rgb Input color encoded in RGB space
* @param[out] str Output color encoded as string of the form 'RRGGBB'
*/
void color_rgb2str(const color_rgb_t *rgb, char *str);
/**
* @brief Invert a given rgb color
*
* @pre ((rgb != NULL) && (inv_rgb != NULL))
*
* @param[in] rgb Input rgb color, that should be converted. Must be NOT NULL
* @param[out] inv_rgb Output rgb color, result of the conversion. Must be NOT NULL
*/
static inline void color_rgb_invert(const color_rgb_t *rgb, color_rgb_t *inv_rgb)
{
inv_rgb->r = rgb->r ^ 0xFF;
inv_rgb->g = rgb->g ^ 0xFF;
inv_rgb->b = rgb->b ^ 0xFF;
}
/**
* @brief Calculate the complementary color of a given rgb color.
*
* @note Complementary color calculation according to adobe illustator calculations.
* See https://helpx.adobe.com/illustrator/using/adjusting-colors.html
*
* @pre ((rgb != NULL) && (comp_rgb != NULL))
*
* @param[in] rgb Input rgb color. Must be NOT NULL
* @param[out] comp_rgb Output rgb color, result of the complementary color calculation. Must be NOT NULL
*/
void color_rgb_complementary(const color_rgb_t *rgb, color_rgb_t *comp_rgb);
#ifdef __cplusplus
}
#endif
#endif /* COLOR_H */
/** @} */
|