diff options
Diffstat (limited to 'libred.h')
| -rw-r--r-- | libred.h | 87 |
1 files changed, 83 insertions, 4 deletions
@@ -3,6 +3,9 @@ #define LIBRED_H +/* bug fix: */ +#define libred_solar_elevation libred_solar_elevation__int + /** * Approximate apparent size of the Sun in degrees @@ -92,7 +95,7 @@ * Test whether it is amateur astronomical twilight * * @param ELEV:double The current elevation - * @return 1 if is amatuer astronomical twilight, 0 otherwise + * @return 1 if is amateur astronomical twilight, 0 otherwise */ #define LIBRED_IS_AMATEUR_ASTRONOMICAL_TWILIGHT(ELEV) ((-18.0 <= (ELEV)) && ((ELEV) <= -15.0)) @@ -143,7 +146,7 @@ * @return 0 on success, -1 on failure * @throws Any error specified for clock_gettime(3) on error */ -double libred_solar_elevation(double, double, double *); +int libred_solar_elevation(double, double, double *); /** @@ -206,12 +209,88 @@ int libred_check_timetravel(void); * @param r Output parameter for the “red” value * @param g Output parameter for the green value * @param b Output parameter for the blue value - * @return 0 on succeess, -1 on error - * + * @return 0 on success, -1 on error + * * @throws EDOM The selected temperature is below 1000K */ int libred_get_colour(long int, double *, double *, double *); +/** + * Get the CIE xy values of a colour temperature + * + * libred has a table of colour temperature values, this + * function interpolates values that are missing. If you + * don't want any interpolation the `temp` parameter can + * be specified in one of the following ways: + * + * - floor: + * (temp - LIBRED_LOWEST_TEMPERATURE) / + * LIBRED_DELTA_TEMPERATURE * + * LIBRED_DELTA_TEMPERATURE + + * LIBRED_LOWEST_TEMPERATURE + * + * - ceiling: + * (temp - LIBRED_LOWEST_TEMPERATURE + + * LIBRED_DELTA_TEMPERATURE - 1) / + * LIBRED_DELTA_TEMPERATURE * + * LIBRED_DELTA_TEMPERATURE + + * LIBRED_LOWEST_TEMPERATURE + * + * - round to nearest: + * (temp - LIBRED_LOWEST_TEMPERATURE + + * LIBRED_DELTA_TEMPERATURE / 2) / + * LIBRED_DELTA_TEMPERATURE * + * LIBRED_DELTA_TEMPERATURE + + * LIBRED_LOWEST_TEMPERATURE + * + * @param temp The desired colour temperature + * @param x Output parameter for the x value + * @param y Output parameter for the y value + * @return 0 on success, -1 on error + * + * @throws EDOM The selected temperature is below 1000K + */ +int libred_get_colour_xy(long int, double *, double *); + +/** + * Calculate the colour temperature from its [0, 1] sRGB values + * + * @param r The sRGB “red” value for the colour temperature + * @param g The sRGB green value for the colour temperature + * @param b The sRGB blue value for the colour temperature + * @param y Output parameter for the CIE Y value for the + * provided sRGB colour, the sRGB error values must + * be multiplied by this value to correct them to + * match the brightness of the input sRGB colour; + * may be `NULL` + * @param r_error Output parameter for the absolute error in the + * “red” value of the returned colour temperature; + * may be `NULL` + * @param g_error Output parameter for the absolute error in the + * green value of the returned colour temperature; + * may be `NULL` + * @param b_error Output parameter for the absolute error in the + * blue value of the returned colour temperature; + * may be `NULL` + * @return The closest matching colour temperature + */ +double libred_get_temperature(double, double, double, double *, double *, double *, double *); + +/** + * Calculate the colour temperature from its CIE xy values + * + * @param x The CIE x value for the colour temperature + * @param y The CIE y value for the colour temperature + * @param x_error Output parameter for the absolute error in + * the CIE x value of the returned colour + * temperature; may be `NULL` + * @param y_error Output parameter for the absolute error in + * the CIE y value of the returned colour + * temperature; may be `NULL` + * @return The closest matching colour temperature + */ +double libred_get_temperature_xy(double, double, double *, double *); + #endif |