<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_color 3X</TITLE>
+<TITLE>curs_color 3x</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">curs_color 3X</H1>
+<H1 class="no-header">curs_color 3x</H1>
<PRE>
-<B><A HREF="curs_color.3X.html">curs_color(3X)</A></B> <B><A HREF="curs_color.3X.html">curs_color(3X)</A></B>
+<STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>start_color</B>, <B>has_colors</B>, <B>can_change_color</B>, <B>init_pair</B>, <B>init_color</B>,
- <B>init_extended_pair</B>, <B>init_extended_color</B>, <B>color_content</B>, <B>pair_content</B>,
- <B>extended_color_content</B>, <B>extended_pair_content</B>, <B>reset_color_pairs</B>,
- <B>COLOR_PAIR</B>, <B>PAIR_NUMBER</B> - <B>curses</B> color manipulation routines
+ <STRONG>start_color</STRONG>, <STRONG>has_colors</STRONG>, <STRONG>can_change_color</STRONG>, <STRONG>init_pair</STRONG>, <STRONG>init_color</STRONG>,
+ <STRONG>init_extended_pair</STRONG>, <STRONG>init_extended_color</STRONG>, <STRONG>color_content</STRONG>, <STRONG>pair_content</STRONG>,
+ <STRONG>extended_color_content</STRONG>, <STRONG>extended_pair_content</STRONG>, <STRONG>reset_color_pairs</STRONG>,
+ <STRONG>COLOR_PAIR</STRONG>, <STRONG>PAIR_NUMBER</STRONG> - <STRONG>curses</STRONG> color manipulation routines
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><curses.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <B>int</B> <B>start_color(void);</B>
+ <STRONG>int</STRONG> <STRONG>start_color(void);</STRONG>
- <B>bool</B> <B>has_colors(void);</B>
- <B>bool</B> <B>can_change_color(void);</B>
+ <STRONG>bool</STRONG> <STRONG>has_colors(void);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>can_change_color(void);</STRONG>
- <B>int</B> <B>init_pair(short</B> <I>pair</I><B>,</B> <B>short</B> <I>f</I><B>,</B> <B>short</B> <I>b</I><B>);</B>
- <B>int</B> <B>init_color(short</B> <I>color</I><B>,</B> <B>short</B> <I>r</I><B>,</B> <B>short</B> <I>g</I><B>,</B> <B>short</B> <I>b</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>init_pair(short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>f</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>b</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>init_color(short</STRONG> <EM>color</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>r</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>g</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>b</EM><STRONG>);</STRONG>
/* extensions */
- <B>int</B> <B>init_extended_pair(int</B> <I>pair</I><B>,</B> <B>int</B> <I>f</I><B>,</B> <B>int</B> <I>b</I><B>);</B>
- <B>int</B> <B>init_extended_color(int</B> <I>color</I><B>,</B> <B>int</B> <I>r</I><B>,</B> <B>int</B> <I>g</I><B>,</B> <B>int</B> <I>b</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>init_extended_pair(int</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>f</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>b</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>init_extended_color(int</STRONG> <EM>color</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>r</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>g</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>b</EM><STRONG>);</STRONG>
- <B>int</B> <B>color_content(short</B> <I>color</I><B>,</B> <B>short</B> <B>*</B><I>r</I><B>,</B> <B>short</B> <B>*</B><I>g</I><B>,</B> <B>short</B> <B>*</B><I>b</I><B>);</B>
- <B>int</B> <B>pair_content(short</B> <I>pair</I><B>,</B> <B>short</B> <B>*</B><I>f</I><B>,</B> <B>short</B> <B>*</B><I>b</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>color_content(short</STRONG> <EM>color</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>r</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>g</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>b</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>pair_content(short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>f</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>b</EM><STRONG>);</STRONG>
/* extensions */
- <B>int</B> <B>extended_color_content(int</B> <I>color</I><B>,</B> <B>int</B> <B>*</B><I>r</I><B>,</B> <B>int</B> <B>*</B><I>g</I><B>,</B> <B>int</B> <B>*</B><I>b</I><B>);</B>
- <B>int</B> <B>extended_pair_content(int</B> <I>pair</I><B>,</B> <B>int</B> <B>*</B><I>f</I><B>,</B> <B>int</B> <B>*</B><I>b</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>extended_color_content(int</STRONG> <EM>color</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>r</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>g</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>b</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>extended_pair_content(int</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>f</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>b</EM><STRONG>);</STRONG>
/* extensions */
- <B>void</B> <B>reset_color_pairs(void);</B>
+ <STRONG>void</STRONG> <STRONG>reset_color_pairs(void);</STRONG>
- <B>int</B> <B>COLOR_PAIR(int</B> <I>n</I><B>);</B>
- <B>PAIR_NUMBER(</B><I>attrs</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>COLOR_PAIR(int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
</PRE><H3><a name="h3-Overview">Overview</a></H3><PRE>
- <B>curses</B> supports color attributes on terminals with that capability. To
- use these routines <B>start_color</B> must be called, usually right after
- <B>initscr</B>. Colors are always used in pairs (referred to as color-pairs).
+ <STRONG>curses</STRONG> supports color attributes on terminals with that capability. To
+ use these routines <STRONG>start_color</STRONG> must be called, usually right after
+ <STRONG>initscr</STRONG>. Colors are always used in pairs (referred to as color-pairs).
A color-pair consists of a foreground color (for characters) and a
background color (for the blank field on which the characters are dis-
played). A programmer initializes a color-pair with the routine
- <B>init_pair</B>. After it has been initialized, <B>COLOR_PAIR</B>(<I>n</I>) can be used to
+ <STRONG>init_pair</STRONG>. After it has been initialized, <STRONG>COLOR_PAIR</STRONG>(<EM>n</EM>) can be used to
convert the pair to a video attribute.
If a terminal is capable of redefining colors, the programmer can use
- the routine <B>init_color</B> to change the definition of a color. The rou-
- tines <B>has_colors</B> and <B>can_change_color</B> return <B>TRUE</B> or <B>FALSE</B>, depending
+ the routine <STRONG>init_color</STRONG> to change the definition of a color. The rou-
+ tines <STRONG>has_colors</STRONG> and <STRONG>can_change_color</STRONG> return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>, depending
on whether the terminal has color capabilities and whether the program-
- mer can change the colors. The routine <B>color_content</B> allows a program-
+ mer can change the colors. The routine <STRONG>color_content</STRONG> allows a program-
mer to extract the amounts of red, green, and blue components in an
- initialized color. The routine <B>pair_content</B> allows a programmer to
+ initialized color. The routine <STRONG>pair_content</STRONG> allows a programmer to
find out how a given color-pair is currently defined.
</PRE><H3><a name="h3-Color-Rendering">Color Rendering</a></H3><PRE>
- The <B>curses</B> library combines these inputs to produce the actual fore-
+ The <STRONG>curses</STRONG> library combines these inputs to produce the actual fore-
ground and background colors shown on the screen:
- <B>o</B> per-character video attributes (e.g., via <B>waddch</B>),
+ <STRONG>o</STRONG> per-character video attributes (e.g., via <STRONG>waddch</STRONG>),
- <B>o</B> the window attribute (e.g., by <B>wattrset</B>), and
+ <STRONG>o</STRONG> the window attribute (e.g., by <STRONG>wattrset</STRONG>), and
- <B>o</B> the background character (e.g., <B>wbkgdset</B>).
+ <STRONG>o</STRONG> the background character (e.g., <STRONG>wbkgdset</STRONG>).
Per-character and window attributes are usually set by a parameter con-
taining video attributes including a color pair value. Some functions
- such as <B>wattr_set</B> use a separate parameter which is the color pair num-
+ such as <STRONG>wattr_set</STRONG> use a separate parameter which is the color pair num-
ber.
The background character is a special case: it includes a character
- value, just as if it were passed to <B>waddch</B>.
+ value, just as if it were passed to <STRONG>waddch</STRONG>.
- The <B>curses</B> library does the actual work of combining these color pairs
- in an internal function called from <B>waddch</B>:
+ The <STRONG>curses</STRONG> library does the actual work of combining these color pairs
+ in an internal function called from <STRONG>waddch</STRONG>:
- <B>o</B> If the parameter passed to <B>waddch</B> is <I>blank</I>, and it uses the special
+ <STRONG>o</STRONG> If the parameter passed to <STRONG>waddch</STRONG> is <EM>blank</EM>, and it uses the special
color pair 0,
- <B>o</B> <B>curses</B> next checks the window attribute.
+ <STRONG>o</STRONG> <STRONG>curses</STRONG> next checks the window attribute.
- <B>o</B> If the window attribute does not use color pair 0, <B>curses</B> uses
+ <STRONG>o</STRONG> If the window attribute does not use color pair 0, <STRONG>curses</STRONG> uses
the color pair from the window attribute.
- <B>o</B> Otherwise, <B>curses</B> uses the background character.
+ <STRONG>o</STRONG> Otherwise, <STRONG>curses</STRONG> uses the background character.
- <B>o</B> If the parameter passed to <B>waddch</B> is <I>not</I> <I>blank</I>, or it does not use
- the special color pair 0, <B>curses</B> prefers the color pair from the
+ <STRONG>o</STRONG> If the parameter passed to <STRONG>waddch</STRONG> is <EM>not</EM> <EM>blank</EM>, or it does not use
+ the special color pair 0, <STRONG>curses</STRONG> prefers the color pair from the
parameter, if it is nonzero. Otherwise, it tries the window attri-
bute next, and finally the background character.
- Some <B>curses</B> functions such as <B>wprintw</B> call <B>waddch</B>. Those do not com-
+ Some <STRONG>curses</STRONG> functions such as <STRONG>wprintw</STRONG> call <STRONG>waddch</STRONG>. Those do not com-
bine its parameter with a color pair. Consequently those calls use on-
ly the window attribute or the background character.
</PRE><H2><a name="h2-CONSTANTS">CONSTANTS</a></H2><PRE>
- In <B><curses.h></B> the following macros are defined. These are the standard
- colors (ISO-6429). <B>curses</B> also assumes that <B>COLOR_BLACK</B> is the default
+ In <STRONG><curses.h></STRONG> the following macros are defined. These are the standard
+ colors (ISO-6429). <STRONG>curses</STRONG> also assumes that <STRONG>COLOR_BLACK</STRONG> is the default
background color for all terminals.
- <B>COLOR_BLACK</B>
- <B>COLOR_RED</B>
- <B>COLOR_GREEN</B>
- <B>COLOR_YELLOW</B>
- <B>COLOR_BLUE</B>
- <B>COLOR_MAGENTA</B>
- <B>COLOR_CYAN</B>
- <B>COLOR_WHITE</B>
+ <STRONG>COLOR_BLACK</STRONG>
+ <STRONG>COLOR_RED</STRONG>
+ <STRONG>COLOR_GREEN</STRONG>
+ <STRONG>COLOR_YELLOW</STRONG>
+ <STRONG>COLOR_BLUE</STRONG>
+ <STRONG>COLOR_MAGENTA</STRONG>
+ <STRONG>COLOR_CYAN</STRONG>
+ <STRONG>COLOR_WHITE</STRONG>
Some terminals support more than the eight (8) "ANSI" colors. There
are no standard names for those additional colors.
</PRE><H2><a name="h2-VARIABLES">VARIABLES</a></H2><PRE>
</PRE><H3><a name="h3-COLORS">COLORS</a></H3><PRE>
- is initialized by <B>start_color</B> to the maximum number of colors the ter-
+ is initialized by <STRONG>start_color</STRONG> to the maximum number of colors the ter-
minal can support.
</PRE><H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
- is initialized by <B>start_color</B> to the maximum number of color pairs the
+ is initialized by <STRONG>start_color</STRONG> to the maximum number of color pairs the
terminal can support.
</PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
</PRE><H3><a name="h3-start_color">start_color</a></H3><PRE>
- The <B>start_color</B> routine requires no arguments. It must be called if
+ The <STRONG>start_color</STRONG> routine requires no arguments. It must be called if
the programmer wants to use colors, and before any other color manipu-
lation routine is called. It is good practice to call this routine
- right after <B>initscr</B>. <B>start_color</B> does this:
+ right after <STRONG>initscr</STRONG>. <STRONG>start_color</STRONG> does this:
- <B>o</B> It initializes two global variables, <B>COLORS</B> and <B>COLOR_PAIRS</B> (re-
+ <STRONG>o</STRONG> It initializes two global variables, <STRONG>COLORS</STRONG> and <STRONG>COLOR_PAIRS</STRONG> (re-
spectively defining the maximum number of colors and color-pairs
the terminal can support).
- <B>o</B> It initializes the special color pair <B>0</B> to the default foreground
+ <STRONG>o</STRONG> It initializes the special color pair <STRONG>0</STRONG> to the default foreground
and background colors. No other color pairs are initialized.
- <B>o</B> It restores the colors on the terminal to the values they had when
+ <STRONG>o</STRONG> It restores the colors on the terminal to the values they had when
the terminal was just turned on.
- <B>o</B> If the terminal supports the <B>initc</B> (<B>initialize_color</B>) capability,
- <B>start_color</B> initializes its internal table representing the red,
+ <STRONG>o</STRONG> If the terminal supports the <STRONG>initc</STRONG> (<STRONG>initialize_color</STRONG>) capability,
+ <STRONG>start_color</STRONG> initializes its internal table representing the red,
green, and blue components of the color palette.
The components depend on whether the terminal uses CGA (aka "ANSI")
- or HLS (i.e., the <B>hls</B> (<B>hue_lightness_saturation</B>) capability is
+ or HLS (i.e., the <STRONG>hls</STRONG> (<STRONG>hue_lightness_saturation</STRONG>) capability is
set). The table is initialized first for eight basic colors
(black, red, green, yellow, blue, magenta, cyan, and white), using
weights that depend upon the CGA/HLS choice. For "ANSI" colors the
- weights are <B>680</B> or <B>0</B> depending on whether the corresponding red,
- green, or blue component is used or not. That permits using <B>1000</B>
+ weights are <STRONG>680</STRONG> or <STRONG>0</STRONG> depending on whether the corresponding red,
+ green, or blue component is used or not. That permits using <STRONG>1000</STRONG>
to represent bold/bright colors. After the initial eight colors
(if the terminal supports more than eight colors) the components
- are initialized using the same pattern, but with weights of <B>1000</B>.
- SVr4 uses a similar scheme, but uses <B>1000</B> for the components of the
+ are initialized using the same pattern, but with weights of <STRONG>1000</STRONG>.
+ SVr4 uses a similar scheme, but uses <STRONG>1000</STRONG> for the components of the
initial eight colors.
- <B>start_color</B> does not attempt to set the terminal's color palette to
- match its built-in table. An application may use <B>init_color</B> to al-
+ <STRONG>start_color</STRONG> does not attempt to set the terminal's color palette to
+ match its built-in table. An application may use <STRONG>init_color</STRONG> to al-
ter the internal table along with the terminal's color.
These limits apply to color values and color pairs. Values outside
these limits are not legal, and may result in a runtime error:
- <B>o</B> <B>COLORS</B> corresponds to the terminal database's <B>max_colors</B> capabili-
- ty, (see <B><A HREF="terminfo.5.html">terminfo(5)</A></B>).
+ <STRONG>o</STRONG> <STRONG>COLORS</STRONG> corresponds to the terminal database's <STRONG>max_colors</STRONG> capabili-
+ ty, (see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>).
- <B>o</B> color values are expected to be in the range <B>0</B> to <B>COLORS-1</B>, inclu-
- sive (including <B>0</B> and <B>COLORS-1</B>).
+ <STRONG>o</STRONG> color values are expected to be in the range <STRONG>0</STRONG> to <STRONG>COLORS-1</STRONG>, inclu-
+ sive (including <STRONG>0</STRONG> and <STRONG>COLORS-1</STRONG>).
- <B>o</B> a special color value <B>-1</B> is used in certain extended functions to
- denote the <I>default</I> <I>color</I> (see <B><A HREF="default_colors.3X.html">use_default_colors(3X)</A></B>).
+ <STRONG>o</STRONG> a special color value <STRONG>-1</STRONG> is used in certain extended functions to
+ denote the <EM>default</EM> <EM>color</EM> (see <STRONG><A HREF="default_colors.3x.html">use_default_colors(3x)</A></STRONG>).
- <B>o</B> <B>COLOR_PAIRS</B> corresponds to the terminal database's <B>max_pairs</B> capa-
- bility, (see <B><A HREF="terminfo.5.html">terminfo(5)</A></B>).
+ <STRONG>o</STRONG> <STRONG>COLOR_PAIRS</STRONG> corresponds to the terminal database's <STRONG>max_pairs</STRONG> capa-
+ bility, (see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>).
- <B>o</B> legal color pair values are in the range <B>1</B> to <B>COLOR_PAIRS-1</B>, inclu-
+ <STRONG>o</STRONG> legal color pair values are in the range <STRONG>1</STRONG> to <STRONG>COLOR_PAIRS-1</STRONG>, inclu-
sive.
- <B>o</B> color pair <B>0</B> is special; it denotes "no color".
+ <STRONG>o</STRONG> color pair <STRONG>0</STRONG> is special; it denotes "no color".
- Color pair <B>0</B> is assumed to be white on black, but is actually what-
+ Color pair <STRONG>0</STRONG> is assumed to be white on black, but is actually what-
ever the terminal implements before color is initialized. It can-
not be modified by the application.
</PRE><H3><a name="h3-has_colors">has_colors</a></H3><PRE>
- The <B>has_colors</B> routine requires no arguments. It returns <B>TRUE</B> if the
- terminal can manipulate colors; otherwise, it returns <B>FALSE</B>. This rou-
+ The <STRONG>has_colors</STRONG> routine requires no arguments. It returns <STRONG>TRUE</STRONG> if the
+ terminal can manipulate colors; otherwise, it returns <STRONG>FALSE</STRONG>. This rou-
tine facilitates writing terminal-independent programs. For example, a
programmer can use it to decide whether to use color or some other
video attribute.
</PRE><H3><a name="h3-can_change_color">can_change_color</a></H3><PRE>
- The <B>can_change_color</B> routine requires no arguments. It returns <B>TRUE</B> if
+ The <STRONG>can_change_color</STRONG> routine requires no arguments. It returns <STRONG>TRUE</STRONG> if
the terminal supports colors and can change their definitions; other,
- it returns <B>FALSE</B>. This routine facilitates writing terminal-indepen-
+ it returns <STRONG>FALSE</STRONG>. This routine facilitates writing terminal-indepen-
dent programs.
</PRE><H3><a name="h3-init_pair">init_pair</a></H3><PRE>
- The <B>init_pair</B> routine changes the definition of a color-pair. It takes
+ The <STRONG>init_pair</STRONG> routine changes the definition of a color-pair. It takes
three arguments: the number of the color-pair to be changed, the fore-
ground color number, and the background color number. For portable ap-
plications:
- <B>o</B> The first argument must be a legal color pair value. If default
- colors are used (see <B><A HREF="default_colors.3X.html">use_default_colors(3X)</A></B>) the upper limit is ad-
+ <STRONG>o</STRONG> The first argument must be a legal color pair value. If default
+ colors are used (see <STRONG><A HREF="default_colors.3x.html">use_default_colors(3x)</A></STRONG>) the upper limit is ad-
justed to allow for extra pairs which use a default color in fore-
ground and/or background.
- <B>o</B> The second and third arguments must be legal color values.
+ <STRONG>o</STRONG> The second and third arguments must be legal color values.
If the color-pair was previously initialized, the screen is refreshed
and all occurrences of that color-pair are changed to the new defini-
tion.
- As an extension, ncurses allows you to set color pair <B>0</B> via the <B>as-</B>
- <B><A HREF="assume_default_colors.3X.html">sume_default_colors(3X)</A></B> routine, or to specify the use of default col-
- ors (color number <B>-1</B>) if you first invoke the <B><A HREF="default_colors.3X.html">use_default_colors(3X)</A></B>
+ As an extension, ncurses allows you to set color pair <STRONG>0</STRONG> via the <STRONG>as-</STRONG>
+ <STRONG><A HREF="assume_default_colors.3x.html">sume_default_colors(3x)</A></STRONG> routine, or to specify the use of default col-
+ ors (color number <STRONG>-1</STRONG>) if you first invoke the <STRONG><A HREF="default_colors.3x.html">use_default_colors(3x)</A></STRONG>
routine.
</PRE><H3><a name="h3-init_extended_pair">init_extended_pair</a></H3><PRE>
- Because <B>init_pair</B> uses signed <B>short</B>s for its parameters, that limits
+ Because <STRONG>init_pair</STRONG> uses signed <STRONG>short</STRONG>s for its parameters, that limits
color-pairs and color-values to 32767 on modern hardware. The exten-
- sion <B>init_extended_pair</B> uses <B>int</B>s for the color-pair and color-value,
+ sion <STRONG>init_extended_pair</STRONG> uses <STRONG>int</STRONG>s for the color-pair and color-value,
allowing a larger number of colors to be supported.
</PRE><H3><a name="h3-init_color">init_color</a></H3><PRE>
- The <B>init_color</B> routine changes the definition of a color. It takes
+ The <STRONG>init_color</STRONG> 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).
- <B>o</B> The first argument must be a legal color value; default colors are
- not allowed here. (See the section <B>Colors</B> for the default color
+ <STRONG>o</STRONG> The first argument must be a legal color value; default colors are
+ not allowed here. (See the section <STRONG>Colors</STRONG> for the default color
index.)
- <B>o</B> Each of the last three arguments must be a value in the range <B>0</B>
- through <B>1000</B>.
+ <STRONG>o</STRONG> Each of the last three arguments must be a value in the range <STRONG>0</STRONG>
+ through <STRONG>1000</STRONG>.
- When <B>init_color</B> is used, all occurrences of that color on the screen
+ When <STRONG>init_color</STRONG> is used, all occurrences of that color on the screen
immediately change to the new definition.
</PRE><H3><a name="h3-init_extended_color">init_extended_color</a></H3><PRE>
- Because <B>init_color</B> uses signed <B>short</B>s for its parameters, that limits
+ Because <STRONG>init_color</STRONG> uses signed <STRONG>short</STRONG>s for its parameters, that limits
color-values and their red, green, and blue components to 32767 on mod-
- ern hardware. The extension <B>init_extended_color</B> uses <B>int</B>s for the col-
+ ern hardware. The extension <STRONG>init_extended_color</STRONG> uses <STRONG>int</STRONG>s for the col-
or value and for setting the red, green, and blue components, allowing
a larger number of colors to be supported.
</PRE><H3><a name="h3-color_content">color_content</a></H3><PRE>
- The <B>color_content</B> routine gives programmers a way to find the intensity
+ The <STRONG>color_content</STRONG> routine gives programmers a way to find the intensity
of the red, green, and blue (RGB) components in a color. It requires
- four arguments: the color number, and three addresses of <B>short</B>s for
+ four arguments: the color number, and three addresses of <STRONG>short</STRONG>s for
storing the information about the amounts of red, green, and blue com-
ponents in the given color.
- <B>o</B> The first argument must be a legal color value, i.e., <B>0</B> through
- <B>COLORS-1</B>, inclusive.
+ <STRONG>o</STRONG> The first argument must be a legal color value, i.e., <STRONG>0</STRONG> through
+ <STRONG>COLORS-1</STRONG>, inclusive.
- <B>o</B> The values that are stored at the addresses pointed to by the last
- three arguments are in the range <B>0</B> (no component) through <B>1000</B>
+ <STRONG>o</STRONG> The values that are stored at the addresses pointed to by the last
+ three arguments are in the range <STRONG>0</STRONG> (no component) through <STRONG>1000</STRONG>
(maximum amount of component), inclusive.
</PRE><H3><a name="h3-extended_color_content">extended_color_content</a></H3><PRE>
- Because <B>color_content</B> uses signed <B>short</B>s for its parameters, that lim-
+ Because <STRONG>color_content</STRONG> uses signed <STRONG>short</STRONG>s for its parameters, that lim-
its color-values and their red, green, and blue components to 32767 on
- modern hardware. The extension <B>extended_color_content</B> uses <B>int</B>s for
+ modern hardware. The extension <STRONG>extended_color_content</STRONG> uses <STRONG>int</STRONG>s for
the color value and for returning the red, green, and blue components,
allowing a larger number of colors to be supported.
</PRE><H3><a name="h3-pair_content">pair_content</a></H3><PRE>
- The <B>pair_content</B> routine allows programmers to find out what colors a
+ The <STRONG>pair_content</STRONG> routine allows programmers to find out what colors a
given color-pair consists of. It requires three arguments: the color-
- pair number, and two addresses of <B>short</B>s for storing the foreground and
+ pair number, and two addresses of <STRONG>short</STRONG>s for storing the foreground and
the background color numbers.
- <B>o</B> The first argument must be a legal color value, i.e., in the range
- <B>1</B> through <B>COLOR_PAIRS-1</B>, inclusive.
+ <STRONG>o</STRONG> The first argument must be a legal color value, i.e., in the range
+ <STRONG>1</STRONG> through <STRONG>COLOR_PAIRS-1</STRONG>, inclusive.
- <B>o</B> The values that are stored at the addresses pointed to by the sec-
- ond and third arguments are in the range <B>0</B> through <B>COLORS</B>, inclu-
+ <STRONG>o</STRONG> The values that are stored at the addresses pointed to by the sec-
+ ond and third arguments are in the range <STRONG>0</STRONG> through <STRONG>COLORS</STRONG>, inclu-
sive.
</PRE><H3><a name="h3-extended_pair_content">extended_pair_content</a></H3><PRE>
- Because <B>pair_content</B> uses signed <B>short</B>s for its parameters, that limits
+ Because <STRONG>pair_content</STRONG> uses signed <STRONG>short</STRONG>s for its parameters, that limits
color-pair and color-values to 32767 on modern hardware. The extension
- <B>extended_pair_content</B> uses <B>int</B>s for the color pair and for returning
+ <STRONG>extended_pair_content</STRONG> uses <STRONG>int</STRONG>s for the color pair and for returning
the foreground and background colors, allowing a larger number of col-
ors to be supported.
</PRE><H3><a name="h3-reset_color_pairs">reset_color_pairs</a></H3><PRE>
- The extension <B>reset_color_pairs</B> tells ncurses to discard all of the
- color-pair information which was set with <B>init_pair</B>. It also touches
+ The extension <STRONG>reset_color_pairs</STRONG> tells ncurses to discard all of the
+ color-pair information which was set with <STRONG>init_pair</STRONG>. It also touches
the current- and standard-screens, allowing an application to switch
color palettes rapidly.
</PRE><H3><a name="h3-PAIR_NUMBER">PAIR_NUMBER</a></H3><PRE>
- <B>PAIR_NUMBER(</B><I>attrs</I>) extracts the color value from its <I>attrs</I> parameter
+ <STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM>) extracts the color value from its <EM>attrs</EM> parameter
and returns it as a color pair number.
</PRE><H3><a name="h3-COLOR_PAIR">COLOR_PAIR</a></H3><PRE>
- Its inverse <B>COLOR_PAIR(</B><I>n</I><B>)</B> converts a color pair number to an attribute.
+ Its inverse <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> converts a color pair number to an attribute.
Attributes can hold color pairs in the range 0 to 255. If you need a
- color pair larger than that, you must use functions such as <B>attr_set</B>
+ color pair larger than that, you must use functions such as <STRONG>attr_set</STRONG>
(which pass the color pair as a separate parameter) rather than the
- legacy functions such as <B>attrset</B>.
+ legacy functions such as <STRONG>attrset</STRONG>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The routines <B>can_change_color</B> and <B>has_colors</B> return <B>TRUE</B> or <B>FALSE</B>.
+ The routines <STRONG>can_change_color</STRONG> and <STRONG>has_colors</STRONG> return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
- All other routines return the integer <B>ERR</B> upon failure and an <B>OK</B> (SVr4
- specifies only "an integer value other than <B>ERR</B>") upon successful com-
+ All other routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> (SVr4
+ specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful com-
pletion.
X/Open defines no error conditions. SVr4 does document some error con-
ditions which apply in general:
- <B>o</B> This implementation will return <B>ERR</B> on attempts to use color values
- outside the range <B>0</B> to <B>COLORS</B>-1 (except for the default colors ex-
- tension), or use color pairs outside the range <B>0</B> to <B>COLOR_PAIRS-1</B>.
+ <STRONG>o</STRONG> This implementation will return <STRONG>ERR</STRONG> on attempts to use color values
+ outside the range <STRONG>0</STRONG> to <STRONG>COLORS</STRONG>-1 (except for the default colors ex-
+ tension), or use color pairs outside the range <STRONG>0</STRONG> to <STRONG>COLOR_PAIRS-1</STRONG>.
- Color values used in <B>init_color</B> must be in the range <B>0</B> to <B>1000</B>.
+ Color values used in <STRONG>init_color</STRONG> must be in the range <STRONG>0</STRONG> to <STRONG>1000</STRONG>.
An error is returned from all functions if the terminal has not
been initialized.
- An error is returned from secondary functions such as <B>init_pair</B> if
- <B>start_color</B> was not called.
+ An error is returned from secondary functions such as <STRONG>init_pair</STRONG> if
+ <STRONG>start_color</STRONG> was not called.
- <B>o</B> SVr4 does much the same, except that it returns <B>ERR</B> from <B>pair_con-</B>
- <B>tent</B> if the pair was not initialized using <B>init_pairs</B> and it re-
- turns <B>ERR</B> from <B>color_content</B> if the terminal does not support
+ <STRONG>o</STRONG> SVr4 does much the same, except that it returns <STRONG>ERR</STRONG> from <STRONG>pair_con-</STRONG>
+ <STRONG>tent</STRONG> if the pair was not initialized using <STRONG>init_pairs</STRONG> and it re-
+ turns <STRONG>ERR</STRONG> from <STRONG>color_content</STRONG> if the terminal does not support
changing colors.
- This implementation does not return <B>ERR</B> for either case.
+ This implementation does not return <STRONG>ERR</STRONG> for either case.
Specific functions make additional checks:
- <B>init_color</B>
+ <STRONG>init_color</STRONG>
returns an error if the terminal does not support this feature,
- e.g., if the <B>initialize_color</B> capability is absent from the
+ e.g., if the <STRONG>initialize_color</STRONG> capability is absent from the
terminal description.
- <B>start_color</B>
+ <STRONG>start_color</STRONG>
returns an error if the color table cannot be allocated.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- In the <B>ncurses</B> implementation, there is a separate color activation
- flag, color palette, color pairs table, and associated <B>COLORS</B> and <B>COL-</B>
- <B>OR_PAIRS</B> counts for each screen; the <B>start_color</B> function only affects
+ In the <STRONG>ncurses</STRONG> implementation, there is a separate color activation
+ flag, color palette, color pairs table, and associated <STRONG>COLORS</STRONG> and <STRONG>COL-</STRONG>
+ <STRONG>OR_PAIRS</STRONG> counts for each screen; the <STRONG>start_color</STRONG> 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 shared
color palette.
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 or scrolling operations, see <B><A HREF="curs_bkgd.3X.html">curs_bkgd(3X)</A></B>.
+ by erasing or scrolling operations, see <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>.
Several caveats apply on older x86 machines (e.g., i386, i486) with
VGA-compatible graphics:
- <B>o</B> COLOR_YELLOW is actually brown. To get yellow, use COLOR_YELLOW
- combined with the <B>A_BOLD</B> attribute.
+ <STRONG>o</STRONG> COLOR_YELLOW is actually brown. To get yellow, use COLOR_YELLOW
+ combined with the <STRONG>A_BOLD</STRONG> attribute.
- <B>o</B> The A_BLINK attribute should in theory cause the background to go
+ <STRONG>o</STRONG> 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).
- <B>o</B> Color RGB values are not settable.
+ <STRONG>o</STRONG> Color RGB values are not settable.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- This implementation satisfies XSI Curses's minimum maximums for <B>COLORS</B>
- and <B>COLOR_PAIRS</B>.
+ This implementation satisfies XSI Curses's minimum maximums for <STRONG>COLORS</STRONG>
+ and <STRONG>COLOR_PAIRS</STRONG>.
- The <B>init_pair</B> routine accepts negative values of foreground and back-
- ground color to support the <B><A HREF="default_colors.3X.html">use_default_colors(3X)</A></B> extension, but only
+ The <STRONG>init_pair</STRONG> routine accepts negative values of foreground and back-
+ ground color to support the <STRONG><A HREF="default_colors.3x.html">use_default_colors(3x)</A></STRONG> extension, but only
if that routine has been first invoked.
- The assumption that <B>COLOR_BLACK</B> is the default background color for all
- terminals can be modified using the <B><A HREF="default_colors.3X.html">assume_default_colors(3X)</A></B> exten-
+ The assumption that <STRONG>COLOR_BLACK</STRONG> is the default background color for all
+ terminals can be modified using the <STRONG><A HREF="default_colors.3x.html">assume_default_colors(3x)</A></STRONG> exten-
sion.
This implementation checks the pointers, e.g., for the values returned
- by <B>color_content</B> and <B>pair_content</B>, and will treat those as optional pa-
+ by <STRONG>color_content</STRONG> and <STRONG>pair_content</STRONG>, and will treat those as optional pa-
rameters when null.
X/Open Curses does not specify a limit for the number of colors and
- color pairs which a terminal can support. However, in its use of <B>short</B>
+ color pairs which a terminal can support. However, in its use of <STRONG>short</STRONG>
for the parameters, it carries over SVr4's implementation detail for
the compiled terminfo database, which uses signed 16-bit numbers. This
implementation provides extended versions of those functions which use
- <B>short</B> parameters, allowing applications to use larger color- and pair-
+ <STRONG>short</STRONG> parameters, allowing applications to use larger color- and pair-
numbers.
- The <B>reset_color_pairs</B> function is an extension of ncurses.
+ The <STRONG>reset_color_pairs</STRONG> function is an extension of ncurses.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_initscr.3X.html">curs_initscr(3X)</A></B>, <B><A HREF="curs_attr.3X.html">curs_attr(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>, <B>de-</B>
- <B><A HREF="default_colors.3X.html">fault_colors(3X)</A></B>
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG>de-</STRONG>
+ <STRONG><A HREF="default_colors.3x.html">fault_colors(3x)</A></STRONG>
- <B><A HREF="curs_color.3X.html">curs_color(3X)</A></B>
+ <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff