colrcv  v0.5.0
C Library for converting Colours between different Colour Models
xyz.h
Go to the documentation of this file.
1 /*
2  * This source file forms part of colrcv
3  * colrcv is a C Library for converting Colours between different Colour Models.
4  */
5 
24 #ifndef SAXBOPHONE_COLRCV_MODELS_XYZ_H
25 #define SAXBOPHONE_COLRCV_MODELS_XYZ_H
26 
27 #include <stdbool.h>
28 
29 #include "../colrcv.h"
30 #include "types.h"
31 
32 
33 #ifdef __cplusplus
34 extern "C"{
35 #endif
36 
43 struct colrcv_xyz_t {
45  double x;
47  double y;
49  double z;
50 };
51 
56 extern const double COLRCV_XYZ_MIN_VALUE;
57 
62 extern const double COLRCV_XYZ_X_MAX_VALUE;
67 extern const double COLRCV_XYZ_Y_MAX_VALUE;
72 extern const double COLRCV_XYZ_Z_MAX_VALUE;
73 
78 extern const double COLRCV_XYZ_X_REF_VALUE;
83 extern const double COLRCV_XYZ_Y_REF_VALUE;
88 extern const double COLRCV_XYZ_Z_REF_VALUE;
89 
96 bool colrcv_xyz_x_is_valid(colrcv_xyz_t xyz);
97 
105 bool colrcv_xyz_y_is_valid(colrcv_xyz_t xyz);
106 
113 bool colrcv_xyz_z_is_valid(colrcv_xyz_t xyz);
114 
121 bool colrcv_xyz_is_valid(colrcv_xyz_t xyz);
122 
130 colrcv_xyz_t colrcv_xyz_clamp(colrcv_xyz_t xyz);
131 
139 colrcv_xyz_t colrcv_xyz_clamp_x(colrcv_xyz_t xyz);
140 
148 colrcv_xyz_t colrcv_xyz_clamp_y(colrcv_xyz_t xyz);
149 
157 colrcv_xyz_t colrcv_xyz_clamp_z(colrcv_xyz_t xyz);
158 
165 colrcv_rgb_t colrcv_xyz_to_rgb(colrcv_xyz_t xyz);
166 
173 colrcv_hsv_t colrcv_xyz_to_hsv(colrcv_xyz_t xyz);
174 
181 colrcv_hsl_t colrcv_xyz_to_hsl(colrcv_xyz_t xyz);
182 
189 colrcv_lab_t colrcv_xyz_to_lab(colrcv_xyz_t xyz);
190 
191 #ifdef __cplusplus
192 } // extern "C"
193 #endif
194 
195 // end of header file
196 #endif
colrcv_xyz_t::y
double y
The y component. Should be in range 0 -> 100.
Definition: xyz.h:47
COLRCV_XYZ_Z_MAX_VALUE
const double COLRCV_XYZ_Z_MAX_VALUE
Definition: xyz.c:30
colrcv_xyz_to_rgb
colrcv_rgb_t colrcv_xyz_to_rgb(colrcv_xyz_t xyz)
Converts an XYZ colour to an RGB colour.
Definition: xyz.c:106
colrcv_xyz_to_lab
colrcv_lab_t colrcv_xyz_to_lab(colrcv_xyz_t xyz)
Converts an XYZ colour to a LAB colour.
Definition: xyz.c:143
colrcv_xyz_t
Used to represent an XYZ colour.
Definition: xyz.h:43
types.h
This header file forward-declares (via typedef) all the data types used to represent colours in diffe...
colrcv_xyz_clamp_z
colrcv_xyz_t colrcv_xyz_clamp_z(colrcv_xyz_t xyz)
Makes the z component of a given colrcv_xyz_t struct fit within the &#39;standard&#39; range for that channel...
Definition: xyz.c:80
colrcv_xyz_x_is_valid
bool colrcv_xyz_x_is_valid(colrcv_xyz_t xyz)
Checks that x component of a given colrcv_xyz_t struct is valid.
Definition: xyz.c:36
colrcv_xyz_clamp_y
colrcv_xyz_t colrcv_xyz_clamp_y(colrcv_xyz_t xyz)
Makes the y component of a given colrcv_xyz_t struct fit within the &#39;standard&#39; range for that channel...
Definition: xyz.c:74
colrcv_xyz_to_hsv
colrcv_hsv_t colrcv_xyz_to_hsv(colrcv_xyz_t xyz)
Converts an XYZ colour to a HSV colour.
Definition: xyz.c:126
COLRCV_XYZ_Y_MAX_VALUE
const double COLRCV_XYZ_Y_MAX_VALUE
Definition: xyz.c:29
colrcv_hsv_t
Used to represent a HSV colour.
Definition: hsv.h:41
colrcv_xyz_clamp
colrcv_xyz_t colrcv_xyz_clamp(colrcv_xyz_t xyz)
Makes all of the channels of a given colrcv_xyz_t struct fit within the &#39;standard&#39; range for that cha...
Definition: xyz.c:63
COLRCV_XYZ_Z_REF_VALUE
const double COLRCV_XYZ_Z_REF_VALUE
Definition: xyz.c:34
colrcv_xyz_clamp_x
colrcv_xyz_t colrcv_xyz_clamp_x(colrcv_xyz_t xyz)
Makes the x component of a given colrcv_xyz_t struct fit within the &#39;standard&#39; range for that channel...
Definition: xyz.c:68
colrcv_xyz_t::x
double x
The x component. Should be in range 0 -> 112.
Definition: xyz.h:45
colrcv_xyz_z_is_valid
bool colrcv_xyz_z_is_valid(colrcv_xyz_t xyz)
Checks that z component of a given colrcv_xyz_t struct is valid.
Definition: xyz.c:48
COLRCV_XYZ_MIN_VALUE
const double COLRCV_XYZ_MIN_VALUE
Definition: xyz.c:26
COLRCV_XYZ_X_REF_VALUE
const double COLRCV_XYZ_X_REF_VALUE
Definition: xyz.c:32
colrcv_xyz_t::z
double z
The z component. Should be in range 0 -> 123.
Definition: xyz.h:49
colrcv_xyz_to_hsl
colrcv_hsl_t colrcv_xyz_to_hsl(colrcv_xyz_t xyz)
Converts an XYZ colour to a HSL colour.
Definition: xyz.c:131
colrcv_hsl_t
Used to represent a HSL colour.
Definition: hsl.h:41
COLRCV_XYZ_Y_REF_VALUE
const double COLRCV_XYZ_Y_REF_VALUE
Definition: xyz.c:33
colrcv_lab_t
Used to represent a LAB colour.
Definition: lab.h:41
colrcv_xyz_is_valid
bool colrcv_xyz_is_valid(colrcv_xyz_t xyz)
Checks that the components of a given colrcv_xyz_t struct are valid.
Definition: xyz.c:54
COLRCV_XYZ_X_MAX_VALUE
const double COLRCV_XYZ_X_MAX_VALUE
Definition: xyz.c:28
colrcv_xyz_y_is_valid
bool colrcv_xyz_y_is_valid(colrcv_xyz_t xyz)
Checks that y component of a given colrcv_xyz_t struct is valid.
Definition: xyz.c:42
colrcv_rgb_t
Used to represent an RGB colour.
Definition: rgb.h:42
Generated by   doxygen 1.8.11