X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fnew_pair.3x.html;h=12214bec7c0a5aa7c600823cf07b7ead4b63b32d;hp=6702b9026291ee5360ee1dd4f3d8071ea241c6f6;hb=3d46d7e9d3e210417f34acf3b469378558398d07;hpb=9f479192e3ca3413d235c66bf058f8cc63764898 diff --git a/doc/html/man/new_pair.3x.html b/doc/html/man/new_pair.3x.html index 6702b902..12214bec 100644 --- a/doc/html/man/new_pair.3x.html +++ b/doc/html/man/new_pair.3x.html @@ -35,28 +35,28 @@
--new_pair(3X) new_pair(3X) +new_pair(3x) new_pair(3x)
- alloc_pair, find_pair, free_pair - new curses color-pair functions + alloc_pair, find_pair, free_pair - new curses color-pair functions
- #include <curses.h> + #include <curses.h> - int alloc_pair(int fg, int bg); - int find_pair(int fg, int bg); - int free_pair(int pair); + int alloc_pair(int fg, int bg); + int find_pair(int fg, int bg); + int free_pair(int pair);
@@ -68,28 +68,28 @@ The number of colors may be related to the number of possible color pairs for a given terminal, or it may not: - o While almost all terminals allow setting the color attributes + o While almost all terminals allow setting the color attributes independently, it is unlikely that your terminal allows you to modify the attributes of a given character cell without rewriting it. That is, the foreground and background colors are applied as a pair. - o Color pairs are the curses library's way of managing a color + o Color pairs are the curses library's way of managing a color palette on a terminal. If the library does not keep track of the - combinations of colors which are displayed, it will be inefficient. + combinations of colors which are displayed, it will be inefficient. - o For simple terminal emulators with only a few dozen color + o For simple terminal emulators with only a few dozen color combinations, it is convenient to use the maximum number of combinations as the limit on color pairs: - COLORS * COLORS + COLORS * COLORS - o Terminals which support default colors distinct from "ANSI colors" + o Terminals which support default colors distinct from "ANSI colors" add to the possible combinations, producing this total: - ( COLORS + 1 ) * ( COLORS + 1 ) + ( COLORS + 1 ) * ( COLORS + 1 ) - o An application might use up to a few dozen color pairs to implement + o An application might use up to a few dozen color pairs to implement a predefined color scheme. Beyond that lies in the realm of programs using the foreground and @@ -105,28 +105,28 @@
- The alloc_pair function accepts parameters for foreground and + The alloc_pair function accepts parameters for foreground and background color, and checks if that color combination is already associated with a color pair. - o If the combination already exists, alloc_pair returns the existing + o If the combination already exists, alloc_pair returns the existing pair. - o If the combination does not exist, alloc_pair allocates a new color + o If the combination does not exist, alloc_pair allocates a new color pair and returns that. - o If the table fills up, alloc_pair discards the least-recently - allocated entry using free_pair and allocates a new color pair. + o If the table fills up, alloc_pair discards the least-recently + allocated entry using free_pair and allocates a new color pair. All of the color pairs are allocated from a table of possible color - pairs. The size of the table is determined by the terminfo pairs - capability. The table is shared with init_pair; in fact alloc_pair - calls init_pair after updating the ncurses library's fast index to the + pairs. The size of the table is determined by the terminfo pairs + capability. The table is shared with init_pair; in fact alloc_pair + calls init_pair after updating the ncurses library's fast index to the colors versus color pairs.
- The find_pair function accepts parameters for foreground and background + The find_pair function accepts parameters for foreground and background color, and checks if that color combination is already associated with a color pair, returning the pair number if it has been allocated. Otherwise it returns -1. @@ -137,15 +137,15 @@
- The alloc_pair function returns a color pair number in the range 1 - through COLOR_PAIRS-1, unless it encounters an error updating its fast + The alloc_pair function returns a color pair number in the range 1 + through COLOR_PAIRS-1, unless it encounters an error updating its fast index to the color pair values, preventing it from allocating a color pair. In that case, it returns -1. - The find_pair function returns a color pair number if the given color + The find_pair function returns a color pair number if the given color combination has been associated with a color pair, or -1 if not. - Likewise, free_pair returns OK unless it encounters an error updating + Likewise, free_pair returns OK unless it encounters an error updating the fast index or if no such color pair is in use. @@ -156,7 +156,7 @@
- curs_color(3X). + curs_color(3x).
@@ -164,7 +164,7 @@ - new_pair(3X) + new_pair(3x)