NCURSES_INIT_PAIR(3) 1 NCURSES_INIT_PAIR(3)
ncurses_init_pair - Define a color pair
SYNOPSIS
int ncurses_init_pair (int $pair, int $fg, int $bg)
DESCRIPTION
Defines or redefines the given color pair to have the given foreground and background colors. If the color pair was previously initial-
ized, the screen is refreshed and all occurrences of it are changed to reflect the new definition.
Color capabilities must be initialized using ncurses_start_color(3) before calling this function. The first color pair (color pair 0) is
assumed to be white on black by default, but can be changed using ncurses_assume_default_colors(3).
PARAMETERS
o $pair
- The number of the color pair to define.
o $fg
- The foreground color for the color pair. May be one of the pre-defined colors or one defined by ncurses_init_color(3) if the
terminal has color changing capabilities.
o $bg
- The background color for the color pair. May be one of the pre-defined colors or one defined by ncurses_init_color(3) if the
terminal has color changing capabilities.
RETURN VALUES
Returns -1 if the function was successful, and 0 if ncurses or color support were not initialized.
NOTES
Note that color changing capabilities are not required for defining color pairs of pre-existing colors, but only for changing definitions
(red, green, and blue components) of colors themselves per ncurses_init_color(3).
EXAMPLES
Example #1
Writing a string with a specified color to the screen
<?php
ncurses_init();
// If the terminal supports colors, initialize and set active color
if (ncurses_has_colors()) {
ncurses_start_color();
ncurses_init_pair(1, NCURSES_COLOR_YELLOW, NCURSES_COLOR_BLUE);
ncurses_color_set(1);
}
// Write a string at specified location
ncurses_mvaddstr(10, 10, "Hello world! Yellow on blue text!");
// Flush output to screen
ncurses_refresh();
ncurses_end();
?>
SEE ALSO
ncurses_pair_content(3), ncurses_start_color(3).
PHP Documentation Group NCURSES_INIT_PAIR(3)
