X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_color.3x.html;h=4ebe0da04f4db20520b1216d40b66cfefe71c61b;hp=684605fe416cf5a746d73266a90d020806610f76;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=027ae42953e3186daed8f3882da73de48291b606
diff --git a/doc/html/man/curs_color.3x.html b/doc/html/man/curs_color.3x.html
index 684605fe..4ebe0da0 100644
--- a/doc/html/man/curs_color.3x.html
+++ b/doc/html/man/curs_color.3x.html
@@ -1,7 +1,7 @@
-
+
@@ -55,6 +55,7 @@
SYNOPSIS
# include <curses.h>
+
int start_color(void);
int init_pair(short pair, short f, short b);
int init_color(short color, short r, short g, short b);
@@ -108,44 +109,47 @@
pair to be changed, the foreground color number, and the
background color number. For portable applications:
- - The value of the first argument must be between 1 and
- COLOR_PAIRS-1.
+ o The value of the first argument must be between 1 and
+ COLOR_PAIRS-1, except that if default colors are used
+ (see use_default_colors) the upper limit is adjusted
+ to allow for extra pairs which use a default color in
+ foreground and/or background.
- - The value of the second and third arguments must be
- between 0 and COLORS. Color pair 0 is assumed to be
- white on black, but is actually whatever the terminal
- implements before color is initialized. It cannot be
- modified by the application.
+ o The value of the second and third arguments must be
+ between 0 and COLORS. Color pair 0 is assumed to be
+ white on black, but is actually whatever the terminal
+ implements before color is initialized. It cannot be
+ modified by the application.
- If the color-pair was previously initialized, the screen
- is refreshed and all occurrences of that color-pair are
+ If the color-pair was previously initialized, the screen
+ is refreshed and all occurrences of that color-pair are
changed to the new definition.
- As an extension, ncurses allows you to set color pair 0
- via the assume_default_colors routine, or to specify the
- use of default colors (color number -1) if you first in-
+ As an extension, ncurses allows you to set color pair 0
+ via the assume_default_colors routine, or to specify the
+ use of default colors (color number -1) if you first in-
voke the use_default_colors routine.
- The init_color routine changes the definition of a color.
- It takes four arguments: the number of the color to be
- changed followed by three RGB values (for the amounts of
- red, green, and blue components). The value of the first
- argument must be between 0 and COLORS. (See the section
- Colors for the default color index.) Each of the last
- three arguments must be a value between 0 and 1000. When
- init_color is used, all occurrences of that color on the
+ The init_color routine changes the definition of a color.
+ It takes four arguments: the number of the color to be
+ changed followed by three RGB values (for the amounts of
+ red, green, and blue components). The value of the first
+ argument must be between 0 and COLORS. (See the section
+ Colors for the default color index.) Each of the last
+ three arguments must be a value between 0 and 1000. When
+ init_color is used, all occurrences of that color on the
screen immediately change to the new definition.
- The has_colors routine requires no arguments. It returns
- TRUE if the terminal can manipulate colors; otherwise, it
+ The has_colors routine requires no arguments. It returns
+ TRUE if the terminal can manipulate colors; otherwise, it
returns FALSE. This routine facilitates writing terminal-
- independent programs. For example, a programmer can use
- it to decide whether to use color or some other video at-
+ independent programs. For example, a programmer can use
+ it to decide whether to use color or some other video at-
tribute.
- The can_change_color routine requires no arguments. It
- returns TRUE if the terminal supports colors and can
- change their definitions; other, it returns FALSE. This
+ The can_change_color routine requires no arguments. It
+ returns TRUE if the terminal supports colors and can
+ change their definitions; other, it returns FALSE. This
routine facilitates writing terminal-independent programs.
The color_content routine gives programmers a way to find
@@ -196,78 +200,77 @@
will return ERR on attempts to use color values outside
the range 0 to COLORS-1 (except for the default colors ex-
tension), or use color pairs outside the range 0 to COL-
- OR_PAIR-1. Color values used in init_color must be in the
- range 0 to 1000. An error is returned from all functions
- if the terminal has not been initialized. An error is re-
- turned from secondary functions such as init_pair if
+ OR_PAIRS-1. Color values used in init_color must be in
+ the range 0 to 1000. An error is returned from all func-
+ tions if the terminal has not been initialized. An error
+ is returned from secondary functions such as init_pair if
start_color was not called.
- init_color
- returns an error if the terminal does not sup-
- port this feature, e.g., if the initial-
- ize_color capability is absent from the termi-
- nal description.
+ init_color
+ returns an error if the terminal does not support
+ this feature, e.g., if the initialize_color capa-
+ bility is absent from the terminal description.
- start_color
- returns an error If the color table cannot be
- allocated.
+ start_color
+ returns an error if the color table cannot be al-
+ located.
NOTES
- In the ncurses implementation, there is a separate color
+ In the ncurses implementation, there is a separate color
activation flag, color palette, color pairs table, and as-
- sociated COLORS and COLOR_PAIRS counts for each screen;
- the start_color function only affects the current screen.
+ sociated COLORS and COLOR_PAIRS counts for each screen;
+ the start_color function only affects the current screen.
The SVr4/XSI interface is not really designed with this in
- mind, and historical implementations may use a single
+ mind, and historical implementations may use a single
shared color palette.
Note that setting an implicit background color via a color
- pair affects only character cells that a character write
- operation explicitly touches. To change the background
- color used when parts of a window are blanked by erasing
+ pair affects only character cells that a character write
+ operation explicitly touches. To change the background
+ color used when parts of a window are blanked by erasing
or scrolling operations, see curs_bkgd(3x).
- Several caveats apply on 386 and 486 machines with VGA-
+ Several caveats apply on 386 and 486 machines with VGA-
compatible graphics:
- - COLOR_YELLOW is actually brown. To get yellow, use
- COLOR_YELLOW combined with the A_BOLD attribute.
+ o COLOR_YELLOW is actually brown. To get yellow, use
+ COLOR_YELLOW combined with the A_BOLD attribute.
- - The A_BLINK attribute should in theory cause the
- background to go bright. This often fails to work,
- and even some cards for which it mostly works (such
- as the Paradise and compatibles) do the wrong thing
- when you try to set a bright "yellow" background (you
- get a blinking yellow foreground instead).
+ o The A_BLINK attribute should in theory cause the back-
+ ground to go bright. This often fails to work, and
+ even some cards for which it mostly works (such as the
+ Paradise and compatibles) do the wrong thing when you
+ try to set a bright "yellow" background (you get a
+ blinking yellow foreground instead).
- - Color RGB values are not settable.
+ o Color RGB values are not settable.
PORTABILITY
- This implementation satisfies XSI Curses's minimum maxi-
+ This implementation satisfies XSI Curses's minimum maxi-
mums for COLORS and COLOR_PAIRS.
- The init_pair routine accepts negative values of fore-
- ground and background color to support the use_de-
- fault_colors extension, but only if that routine has been
+ The init_pair routine accepts negative values of fore-
+ ground and background color to support the use_de-
+ fault_colors extension, but only if that routine has been
first invoked.
- The assumption that COLOR_BLACK is the default background
- color for all terminals can be modified using the as-
+ The assumption that COLOR_BLACK is the default background
+ color for all terminals can be modified using the as-
sume_default_colors extension.
- This implementation checks the pointers, e.g., for the
- values returned by color_content and pair_content, and
+ This implementation checks the pointers, e.g., for the
+ values returned by color_content and pair_content, and
will treat those as optional parameters when null.
SEE ALSO
- curses(3x), curs_initscr(3x), curs_attr(3x), default_col-
- ors(3x)
+ curses(3x), curs_initscr(3x), curs_attr(3x), curs_vari-
+ ables(3x), default_colors(3x)