colrcv  v0.5.0
C Library for converting Colours between different Colour Models
Data Structures | Functions | Variables
rgb.h File Reference

This header file defines the data types for representing colours in the RGB model, and functions for manipulating it. More...

#include <stdbool.h>
#include "types.h"
Include dependency graph for rgb.h:

Go to the source code of this file.

Data Structures

struct  colrcv_rgb_t
 Used to represent an RGB colour. More...
 

Functions

bool colrcv_rgb_r_is_valid (colrcv_rgb_t rgb)
 Checks that red component of a given colrcv_rgb_t struct is valid. More...
 
bool colrcv_rgb_g_is_valid (colrcv_rgb_t rgb)
 Checks that green component of a given colrcv_rgb_t struct is valid. More...
 
bool colrcv_rgb_b_is_valid (colrcv_rgb_t rgb)
 Checks that blue component of a given colrcv_rgb_t struct is valid. More...
 
bool colrcv_rgb_is_valid (colrcv_rgb_t rgb)
 Checks that the components of a given colrcv_rgb_t struct are valid. More...
 
colrcv_rgb_t colrcv_rgb_clamp (colrcv_rgb_t rgb)
 Makes all of the channels of a given colrcv_rgb_t struct fit within the 'standard' range for that channel. More...
 
colrcv_rgb_t colrcv_rgb_clamp_r (colrcv_rgb_t rgb)
 Makes the red channel of a given colrcv_rgb_t struct fit within the 'standard' range for that channel. More...
 
colrcv_rgb_t colrcv_rgb_clamp_g (colrcv_rgb_t rgb)
 Makes the green channel of a given colrcv_rgb_t struct fit within the 'standard' range for that channel. More...
 
colrcv_rgb_t colrcv_rgb_clamp_b (colrcv_rgb_t rgb)
 Makes the blue channel of a given colrcv_rgb_t struct fit within the 'standard' range for that channel. More...
 
colrcv_hsv_t colrcv_rgb_to_hsv (colrcv_rgb_t rgb)
 Converts an RGB colour to a HSV colour. More...
 
colrcv_hsl_t colrcv_rgb_to_hsl (colrcv_rgb_t rgb)
 Converts an RGB colour to a HSL colour. More...
 
colrcv_lab_t colrcv_rgb_to_lab (colrcv_rgb_t rgb)
 Converts an RGB colour to a LAB colour. More...
 
colrcv_xyz_t colrcv_rgb_to_xyz (colrcv_rgb_t rgb)
 Converts an RGB colour to an XYZ colour. More...
 

Variables

const double COLRCV_RGB_MIN_VALUE
 
const double COLRCV_RGB_MAX_VALUE
 

Detailed Description

This header file defines the data types for representing colours in the RGB model, and functions for manipulating it.

Author
Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==@gmail.com>
Date
2018
Copyright
Copyright (C) Joshua Saxby 2017, 2018
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Since
v0.1.0

Function Documentation

bool colrcv_rgb_b_is_valid ( colrcv_rgb_t  rgb)

Checks that blue component of a given colrcv_rgb_t struct is valid.

Returns
true if it is valid
false if it is not valid
Since
v0.1.0
colrcv_rgb_t colrcv_rgb_clamp ( colrcv_rgb_t  rgb)

Makes all of the channels of a given colrcv_rgb_t struct fit within the 'standard' range for that channel.

Returns
A copy of the given struct with all channels guaranteed to be within range.
Since
v0.4.0
colrcv_rgb_t colrcv_rgb_clamp_b ( colrcv_rgb_t  rgb)

Makes the blue channel of a given colrcv_rgb_t struct fit within the 'standard' range for that channel.

Returns
A copy of the given struct with the blue channel guaranteed to be within range.
Since
v0.4.0
colrcv_rgb_t colrcv_rgb_clamp_g ( colrcv_rgb_t  rgb)

Makes the green channel of a given colrcv_rgb_t struct fit within the 'standard' range for that channel.

Returns
A copy of the given struct with the green channel guaranteed to be within range.
Since
v0.4.0
colrcv_rgb_t colrcv_rgb_clamp_r ( colrcv_rgb_t  rgb)

Makes the red channel of a given colrcv_rgb_t struct fit within the 'standard' range for that channel.

Returns
A copy of the given struct with the red channel guaranteed to be within range.
Since
v0.4.0
bool colrcv_rgb_g_is_valid ( colrcv_rgb_t  rgb)

Checks that green component of a given colrcv_rgb_t struct is valid.

Returns
true if it is valid
false if it is not valid
Since
v0.1.0
bool colrcv_rgb_is_valid ( colrcv_rgb_t  rgb)

Checks that the components of a given colrcv_rgb_t struct are valid.

Returns
true if it is valid
false if it is not valid
Since
v0.1.0
bool colrcv_rgb_r_is_valid ( colrcv_rgb_t  rgb)

Checks that red component of a given colrcv_rgb_t struct is valid.

Returns
true if it is valid
false if it is not valid
Since
v0.1.0
colrcv_hsl_t colrcv_rgb_to_hsl ( colrcv_rgb_t  rgb)

Converts an RGB colour to a HSL colour.

Parameters
rgbAn RGB colour to be converted
Returns
The HSL colour that the RGB colour was converted to
Since
v0.1.0
colrcv_hsv_t colrcv_rgb_to_hsv ( colrcv_rgb_t  rgb)

Converts an RGB colour to a HSV colour.

Parameters
rgbAn RGB colour to be converted
Returns
The HSV colour that the RGB colour was converted to
Since
v0.1.0
colrcv_lab_t colrcv_rgb_to_lab ( colrcv_rgb_t  rgb)

Converts an RGB colour to a LAB colour.

Parameters
rgbAn RGB colour to be converted
Returns
The LAB colour that the RGB colour was converted to
Since
v0.1.0
colrcv_xyz_t colrcv_rgb_to_xyz ( colrcv_rgb_t  rgb)

Converts an RGB colour to an XYZ colour.

Parameters
rgbAn RGB colour to be converted
Returns
The XYZ colour that the RGB colour was converted to
Since
v0.1.0

Variable Documentation

const double COLRCV_RGB_MAX_VALUE

The maximum value that any of the components should have

Since
v0.1.0
const double COLRCV_RGB_MIN_VALUE

The minimum value that any of the components should have

Since
v0.1.0
Generated by   doxygen 1.8.11