X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fnew_pair.3x.html;h=12214bec7c0a5aa7c600823cf07b7ead4b63b32d;hp=0f93e659a7b03770ae3a1c559d799e90397eb986;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/new_pair.3x.html b/doc/html/man/new_pair.3x.html index 0f93e659..12214bec 100644 --- a/doc/html/man/new_pair.3x.html +++ b/doc/html/man/new_pair.3x.html @@ -1,6 +1,7 @@ - @@ -35,7 +36,7 @@ new_pair 3x - + @@ -53,33 +54,33 @@

## SYNOPSIS

```        #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);

```

## DESCRIPTION

```        These functions are an extension to the curses library.  They permit an
-       application to dynamically  allocate  a  color  pair  using  the  fore-
-       ground/background  colors rather than assign a fixed color pair number,
-       and return an unused pair to the pool.
+       application  to  dynamically  allocate   a   color   pair   using   the
+       foreground/background  colors  rather  than  assign  a fixed color pair
+       number, and return an unused pair to the pool.

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 inde-
-           pendently, 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
+       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 pal-
-           ette on a terminal.  If the library does not keep track of the com-
-           binations of colors which are displayed, it will be inefficient.
+       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.

-       o   For  simple terminal emulators with only a few dozen color combina-
-           tions, it is convenient to use the maximum number  of  combinations
-           as the limit on color pairs:
+       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

@@ -92,8 +93,8 @@
a predefined color scheme.

Beyond  that lies in the realm of programs using the foreground and
-           background colors for "ASCII art" (or some other non-textual appli-
-           cation).
+           background colors  for  "ASCII  art"  (or  some  other  non-textual
+           application).

Also beyond those few dozen pairs, the required size for a table to
represent the combinations grows rapidly with an increasing  number
@@ -104,9 +105,9 @@

```

### alloc_pair

```-       The alloc_pair function accepts parameters  for  foreground  and  back-
-       ground  color,  and checks if that color combination is already associ-
-       ated with a color pair.
+       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
pair.
@@ -114,21 +115,21 @@
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 allo-
-           cated 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 capa-
-       bility.   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.
+       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.

```

### find_pair

```        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.  Oth-
-       erwise it returns -1.
+       a  color  pair,  returning  the  pair  number if it has been allocated.
+       Otherwise it returns -1.

```

### free_pair

```@@ -155,7 +156,7 @@

```

```-       init_pair(3x).