<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgutenprint API Reference: color</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>color</h1>The color data type is responsible for providing colour conversion features.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__colorfuncs__t.html">stp_colorfuncs_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__color.html">stp_color</a></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="structstp__color.html">stp_color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#gd1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g23392fc53078d51fcd14d6d565d56423">stp_color_init</a> (<a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image, size_t steps)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g0cf28c3c9638987df4b1740deadba0cb">stp_color_get_row</a> (<a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image, int row, unsigned *zero_mask)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#g40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga282220724877a57738b047140835141">stp_color_list_parameters</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g83bc80c9fd84d741099bc20285a1b655">stp_color_describe_parameter</a> (const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const char *name, <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *description)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g47d6a8163ef21a6e700b1371228b851d">stp_color_register</a> (const <a class="el" href="structstp__color.html">stp_color_t</a> *color)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g2b62ec8e0afe1b6297bc71466f8a334c">stp_color_unregister</a> (const <a class="el" href="structstp__color.html">stp_color_t</a> *color)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g68c13c36d723e5604507bf33fe629f8b">stp_color_count</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available color modules. <a href="#g68c13c36d723e5604507bf33fe629f8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g3b8f62108f3604480e7b89b253527f4a">stp_get_color_by_name</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a color module by its name. <a href="#g3b8f62108f3604480e7b89b253527f4a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g68ba525119da39ae854645ae649557d3">stp_get_color_by_index</a> (int idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a color module by its index number. <a href="#g68ba525119da39ae854645ae649557d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g578f80b2bc3937df38ce7e803f5f472c">stp_get_color_by_colorfuncs</a> (<a class="el" href="structstp__colorfuncs__t.html">stp_colorfuncs_t</a> *colorfuncs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g5a4a4da67cb5c3f1c0a2a9618e46ed50">stp_color_get_name</a> (const <a class="el" href="structstp__color.html">stp_color_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the short (untranslated) name of a color module. <a href="#g5a4a4da67cb5c3f1c0a2a9618e46ed50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#g612389b45f09358f6bad0e376c91b057">stp_color_get_long_name</a> (const <a class="el" href="structstp__color.html">stp_color_t</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the long (translated) name of a color module. <a href="#g612389b45f09358f6bad0e376c91b057"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The color data type is responsible for providing colour conversion features.
<p>
Color modules provide the actual functionality, so different colour management modules may provide the application with different services (for example, colour profiles). <hr><h2>Typedef Documentation</h2>
<a class="anchor" name="gd1408f9835b72f266ec7c7e1e1202a74"></a><!-- doxytag: member="color.h::stp_color_t" ref="gd1408f9835b72f266ec7c7e1e1202a74" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structstp__color.html">stp_color</a> <a class="el" href="structstp__color.html">stp_color_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g68c13c36d723e5604507bf33fe629f8b"></a><!-- doxytag: member="color.h::stp_color_count" ref="g68c13c36d723e5604507bf33fe629f8b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_color_count </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of available color modules.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of color modules. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g83bc80c9fd84d741099bc20285a1b655"></a><!-- doxytag: member="color.h::stp_color_describe_parameter" ref="g83bc80c9fd84d741099bc20285a1b655" args="(const stp_vars_t *v, const char *name, stp_parameter_t *description)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_color_describe_parameter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"> <em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td>
<td class="paramname"> <em>description</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g612389b45f09358f6bad0e376c91b057"></a><!-- doxytag: member="color.h::stp_color_get_long_name" ref="g612389b45f09358f6bad0e376c91b057" args="(const stp_color_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_color_get_long_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the long (translated) name of a color module.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the color module to use. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the long name. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g5a4a4da67cb5c3f1c0a2a9618e46ed50"></a><!-- doxytag: member="color.h::stp_color_get_name" ref="g5a4a4da67cb5c3f1c0a2a9618e46ed50" args="(const stp_color_t *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_color_get_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the short (untranslated) name of a color module.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the color module to use. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the short name. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g0cf28c3c9638987df4b1740deadba0cb"></a><!-- doxytag: member="color.h::stp_color_get_row" ref="g0cf28c3c9638987df4b1740deadba0cb" args="(stp_vars_t *v, stp_image_t *image, int row, unsigned *zero_mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_color_get_row </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"> <em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__image.html">stp_image_t</a> * </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned * </td>
<td class="paramname"> <em>zero_mask</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g23392fc53078d51fcd14d6d565d56423"></a><!-- doxytag: member="color.h::stp_color_init" ref="g23392fc53078d51fcd14d6d565d56423" args="(stp_vars_t *v, stp_image_t *image, size_t steps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_color_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"> <em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__image.html">stp_image_t</a> * </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>steps</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ga282220724877a57738b047140835141"></a><!-- doxytag: member="color.h::stp_color_list_parameters" ref="ga282220724877a57738b047140835141" args="(const stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vars.html#g40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> stp_color_list_parameters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#g2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"> <em>v</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g47d6a8163ef21a6e700b1371228b851d"></a><!-- doxytag: member="color.h::stp_color_register" ref="g47d6a8163ef21a6e700b1371228b851d" args="(const stp_color_t *color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_color_register </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td>
<td class="paramname"> <em>color</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g2b62ec8e0afe1b6297bc71466f8a334c"></a><!-- doxytag: member="color.h::stp_color_unregister" ref="g2b62ec8e0afe1b6297bc71466f8a334c" args="(const stp_color_t *color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_color_unregister </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structstp__color.html">stp_color_t</a> * </td>
<td class="paramname"> <em>color</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g578f80b2bc3937df38ce7e803f5f472c"></a><!-- doxytag: member="color.h::stp_get_color_by_colorfuncs" ref="g578f80b2bc3937df38ce7e803f5f472c" args="(stp_colorfuncs_t *colorfuncs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__color.html">stp_color_t</a>* stp_get_color_by_colorfuncs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structstp__colorfuncs__t.html">stp_colorfuncs_t</a> * </td>
<td class="paramname"> <em>colorfuncs</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g68ba525119da39ae854645ae649557d3"></a><!-- doxytag: member="color.h::stp_get_color_by_index" ref="g68ba525119da39ae854645ae649557d3" args="(int idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__color.html">stp_color_t</a>* stp_get_color_by_index </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a color module by its index number.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>idx</em> </td><td>the index number. This must not be greater than (total number of papers - 1). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to the color module, or NULL on failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3b8f62108f3604480e7b89b253527f4a"></a><!-- doxytag: member="color.h::stp_get_color_by_name" ref="g3b8f62108f3604480e7b89b253527f4a" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__color.html">stp_color_t</a>* stp_get_color_by_name </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a color module by its name.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the short unique name. number of papers - 1). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to the color module, or NULL on failure. </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Aug 10 20:32:51 2010 for libgutenprint API Reference by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
