defs/colors.h File Reference

#include <grass/gis.h>

Include dependency graph for defs/colors.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	G_num_standard_colors (void)
	Get number of named colors (RGB triplets) More...
struct color_rgb	G_standard_color_rgb (int)
	Get RGB triplet of given color. More...
int	G_num_standard_color_names (void)
	Get number of named colors (color names) More...
const struct color_name *	G_standard_color_name (int)
	Get color name. More...
int	G_str_to_color (const char *, int *, int *, int *)
	Parse color string and set red,green,blue. More...
void	G_rgb_to_hsv (int, int, int, float *, float *, float *)
	Converts RGB color values to HSV format. More...
void	G_color_to_str (int, int, int, ColorFormat, char *)
	Parse red,green,blue and set color string. More...
ColorFormat	G_option_to_color_format (const struct Option *)
	Get color format from the option. More...

Function Documentation

G_color_to_str()

void G_color_to_str	(	int	r,
		int	g,
		int	b,
		ColorFormat	clr_frmt,
		char *	str
	)

Parse red,green,blue and set color string.

Parameters

	r	red component of RGB color
	g	green component of RGB color
	b	blue component of RGB color
	clr_frmt	color format to be used (RGB, HEX, HSV, TRIPLET).
[out]	str	color string

Definition at line 210 of file color_str.c.

G_num_standard_color_names()

int G_num_standard_color_names

(

void

)

Get number of named colors (color names)

Returns

number of colors

Definition at line 76 of file color_str.c.

Referenced by G_str_to_color().

G_num_standard_colors()

int G_num_standard_colors

(

void

)

Get number of named colors (RGB triplets)

Returns

number of colors

Definition at line 56 of file color_str.c.

Referenced by COM_Standard_color(), and D_use_color().

G_option_to_color_format()

ColorFormat G_option_to_color_format

(

const struct Option *

option

)

Get color format from the option.

ColorFormat colorFormat;
struct Option *color_format;
 
color_format = G_define_standard_option(G_OPT_C_FORMAT);
 
if (G_parser(argc, argv))
exit(EXIT_FAILURE);
 
colorFormat = G_option_to_color_format(color_format);

Parameters

option

pointer to color format option

Returns

allocated ColorFormat

Definition at line 254 of file color_str.c.

References _, Option::answer, G_fatal_error(), HEX, HSV, RGB, and TRIPLET.

G_rgb_to_hsv()

void G_rgb_to_hsv	(	int	r,
		int	g,
		int	b,
		float *	h,
		float *	s,
		float *	v
	)

Converts RGB color values to HSV format.

Note

This implementation is experimental and may be subject to change.

Parameters

	r	red component of the RGB color
	g	green component of the RGB color
	b	blue component of the RGB color
[out]	h	pointer to store the calculated hue
[out]	s	pointer to store the calculated saturation
[out]	v	pointer to store the calculated value

Definition at line 168 of file color_str.c.

G_standard_color_name()

const struct color_name* G_standard_color_name

(

int

n

)

Get color name.

Parameters

n	color index

Definition at line 86 of file color_str.c.

G_standard_color_rgb()

struct color_rgb G_standard_color_rgb

(

int

n

)

Get RGB triplet of given color.

Parameters

n	color index

Definition at line 56 of file color_str.c.

Referenced by COM_Standard_color().

G_str_to_color()

int G_str_to_color	(	const char *	str,
		int *	red,
		int *	grn,
		int *	blu
	)

Parse color string and set red,green,blue.

Parameters

	str	color string
[out]	red	red value
[out]	grn	green value
[out]	blu	blue value

Returns

1 OK

2 NONE

0 on error

Definition at line 103 of file color_str.c.

References G_chop(), G_debug(), G_num_standard_color_names(), G_strcasecmp(), G_strlcpy(), and name.

Referenced by Cairo_Graph_set(), I_iclass_add_signature(), Nviz_color_from_str(), and PNG_Graph_set().