colour.c File Reference

#include <curses.h>

Go to the source code of this file.

Data Structures
struct	colour_pair

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	colour_content (short colour, short *red, short *green, short *blue)
	Identify the RGB components of a given colour value. More...
int	init_pair (short pair, short fcol, short bcol)
	Initialise colour pair. More...
int	pair_content (short pair, short *fcol, short *bcol)
	Get colours of colour pair. More...

Variables
static struct colour_pair	cpairs [COLOUR_PAIRS]

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

colour_content()

int colour_content	(	short	colour,
		short *	red,
		short *	green,
		short *	blue
	)

Identify the RGB components of a given colour value.

Parameters

colour	colour value
*red	address to store red component
*green	address to store green component
*blue	address to store blue component

Return values

rc	return status code

Definition at line 23 of file colour.c.

                                                                           {
        *red = ( ( colour & COLOUR_RED ) ? 1 : 0 );
        *green = ( ( colour & COLOUR_GREEN ) ? 1 : 0 );
        *blue = ( ( colour & COLOUR_BLUE ) ? 1 : 0 );
        return OK;
}

References colour, COLOUR_BLUE, COLOUR_GREEN, COLOUR_RED, and OK.

init_pair()

int init_pair	(	short	pair,
		short	fcol,
		short	bcol
	)

Initialise colour pair.

Parameters

pair	colour pair number
fcol	foreground colour
bcol	background colour

Definition at line 37 of file colour.c.

                                                     {
        struct colour_pair *cpair;

        if ( ( pair < 1 ) || ( pair >= COLOUR_PAIRS ) )
                return ERR;
        
        cpair = &cpairs[pair];
        cpair->fcol = fcol;
        cpair->bcol = bcol;
        return OK;
}

References colour_pair::bcol, COLOUR_PAIRS, cpairs, ERR, colour_pair::fcol, and OK.

pair_content()

int pair_content	(	short	pair,
		short *	fcol,
		short *	bcol
	)

Get colours of colour pair.

Parameters

pair	colour pair number

Return values

fcol	foreground colour
bcol	background colour

Definition at line 56 of file colour.c.

                                                          {
        struct colour_pair *cpair;

        if ( ( pair < 0 ) || ( pair >= COLOUR_PAIRS ) )
                return ERR;
        
        cpair = &cpairs[pair];
        *fcol = cpair->fcol;
        *bcol = cpair->bcol;
        return OK;
}

References colour_pair::bcol, COLOUR_PAIRS, cpairs, ERR, colour_pair::fcol, and OK.

Variable Documentation

cpairs

struct colour_pair cpairs[COLOUR_PAIRS]

static

Initial value:

= {
        [0] = { COLOUR_WHITE, COLOUR_BLACK },
}

Definition at line 10 of file colour.c.

Referenced by init_pair(), and pair_content().