<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Initializes color functionality</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-standout.html">ncurses_standout</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ncurses-termattrs.html">ncurses_termattrs</a></div> <div class="up"><a href="ref.ncurses.html">Ncurses Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.ncurses-start-color" class="refentry"> <div class="refnamediv"> <h1 class="refname">ncurses_start_color</h1> <p class="verinfo">(PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)</p><p class="refpurpose"><span class="refname">ncurses_start_color</span> — <span class="dc-title">Initializes color functionality</span></p> </div> <div class="refsect1 description" id="refsect1-function.ncurses-start-color-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><strong>ncurses_start_color</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Initializes color functionality in ncurses. This function must be called before any color manipulation functions are called and after <span class="function"><a href="function.ncurses-init.html" class="function">ncurses_init()</a></span> is called. It is good practice to call this function right after <span class="function"><a href="function.ncurses-init.html" class="function">ncurses_init()</a></span>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ncurses-start-color-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ncurses-start-color-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <em>0</em> on success, or <em>-1</em> if the color table could not be allocated or ncurses was not initialized. </p> </div> <div class="refsect1 examples" id="refsect1-function.ncurses-start-color-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-633"> <p><strong>Example #1 Writing a string with a specified color to the screen</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />ncurses_init</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// If the terminal supports colors, initialize and set active color<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">ncurses_has_colors</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">ncurses_start_color</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">ncurses_init_pair</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">NCURSES_COLOR_YELLOW</span><span style="color: #007700">, </span><span style="color: #0000BB">NCURSES_COLOR_BLUE</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">ncurses_color_set</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">// Write a string at specified location<br /></span><span style="color: #0000BB">ncurses_mvaddstr</span><span style="color: #007700">(</span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #DD0000">"Hello world! Yellow on blue text!"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Flush output to screen<br /></span><span style="color: #0000BB">ncurses_refresh</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">ncurses_end</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.ncurses-start-color-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.ncurses-can-change-color.html" class="function" rel="rdfs-seeAlso">ncurses_can_change_color()</a> - Checks if terminal color definitions can be changed</span></li> <li class="member"> <span class="function"><a href="function.ncurses-has-colors.html" class="function" rel="rdfs-seeAlso">ncurses_has_colors()</a> - Checks if terminal has color capabilities</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-standout.html">ncurses_standout</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ncurses-termattrs.html">ncurses_termattrs</a></div> <div class="up"><a href="ref.ncurses.html">Ncurses Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>