4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
6
<title>libgutenprint API Reference: color</title>
8
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
9
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
15
<div id="top"><!-- do not remove this div! -->
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
18
14
<div id="titlearea">
19
15
<table cellspacing="0" cellpadding="0">
21
17
<tr style="height: 56px;">
24
18
<td style="padding-left: 0.5em;">
25
19
<div id="projectname">libgutenprint API Reference
26
 <span id="projectnumber">5.2.8-pre1</span>
20
 <span id="projectnumber">5.2.8</span>
38
<!-- Generated by Doxygen 1.7.6.1 -->
27
<!-- end header part -->
28
<!-- Generated by Doxygen 1.8.1 -->
39
29
<div id="navrow1" class="tabs">
40
30
<ul class="tablist">
41
31
<li><a href="index.html"><span>Main Page</span></a></li>
59
49
<p>The color data type is responsible for providing colour conversion features.
60
50
<a href="#details">More...</a></p>
61
51
<table class="memberdecls">
62
<tr><td colspan="2"><h2><a name="nested-classes"></a>
52
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
63
53
Data Structures</h2></td></tr>
64
<tr><td class="memItemLeft" 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>
65
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__color.html">stp_color</a></td></tr>
66
<tr><td colspan="2"><h2><a name="typedef-members"></a>
54
<tr class="memitem:"><td class="memItemLeft" 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>
55
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__color.html">stp_color</a></td></tr>
56
</table><table class="memberdecls">
57
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
67
58
Typedefs</h2></td></tr>
68
<tr><td class="memItemLeft" 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#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a></td></tr>
69
<tr><td colspan="2"><h2><a name="func-members"></a>
59
<tr class="memitem:gad1408f9835b72f266ec7c7e1e1202a74"><td class="memItemLeft" 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#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a></td></tr>
60
</table><table class="memberdecls">
61
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
70
62
Functions</h2></td></tr>
71
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga23392fc53078d51fcd14d6d565d56423">stp_color_init</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image, size_t steps)</td></tr>
72
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga0cf28c3c9638987df4b1740deadba0cb">stp_color_get_row</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image, int row, unsigned *zero_mask)</td></tr>
73
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vars.html#ga40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#gaa282220724877a57738b047140835141">stp_color_list_parameters</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
74
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga83bc80c9fd84d741099bc20285a1b655">stp_color_describe_parameter</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const char *name, <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *description)</td></tr>
75
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga47d6a8163ef21a6e700b1371228b851d">stp_color_register</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *color)</td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga2b62ec8e0afe1b6297bc71466f8a334c">stp_color_unregister</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *color)</td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga68c13c36d723e5604507bf33fe629f8b">stp_color_count</a> (void)</td></tr>
78
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available color modules. <a href="#ga68c13c36d723e5604507bf33fe629f8b"></a><br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga3b8f62108f3604480e7b89b253527f4a">stp_get_color_by_name</a> (const char *name)</td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a color module by its name. <a href="#ga3b8f62108f3604480e7b89b253527f4a"></a><br/></td></tr>
81
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga68ba525119da39ae854645ae649557d3">stp_get_color_by_index</a> (int idx)</td></tr>
82
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a color module by its index number. <a href="#ga68ba525119da39ae854645ae649557d3"></a><br/></td></tr>
83
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga578f80b2bc3937df38ce7e803f5f472c">stp_get_color_by_colorfuncs</a> (<a class="el" href="structstp__colorfuncs__t.html">stp_colorfuncs_t</a> *colorfuncs)</td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga5a4a4da67cb5c3f1c0a2a9618e46ed50">stp_color_get_name</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *c)</td></tr>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the short (untranslated) name of a color module. <a href="#ga5a4a4da67cb5c3f1c0a2a9618e46ed50"></a><br/></td></tr>
86
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga612389b45f09358f6bad0e376c91b057">stp_color_get_long_name</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *c)</td></tr>
87
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the long (translated) name of a color module. <a href="#ga612389b45f09358f6bad0e376c91b057"></a><br/></td></tr>
63
<tr class="memitem:ga23392fc53078d51fcd14d6d565d56423"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga23392fc53078d51fcd14d6d565d56423">stp_color_init</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image, size_t steps)</td></tr>
64
<tr class="memitem:ga0cf28c3c9638987df4b1740deadba0cb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga0cf28c3c9638987df4b1740deadba0cb">stp_color_get_row</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image, int row, unsigned *zero_mask)</td></tr>
65
<tr class="memitem:gaa282220724877a57738b047140835141"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vars.html#ga40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#gaa282220724877a57738b047140835141">stp_color_list_parameters</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
66
<tr class="memitem:ga83bc80c9fd84d741099bc20285a1b655"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga83bc80c9fd84d741099bc20285a1b655">stp_color_describe_parameter</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const char *name, <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *description)</td></tr>
67
<tr class="memitem:ga47d6a8163ef21a6e700b1371228b851d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga47d6a8163ef21a6e700b1371228b851d">stp_color_register</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *color)</td></tr>
68
<tr class="memitem:ga2b62ec8e0afe1b6297bc71466f8a334c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga2b62ec8e0afe1b6297bc71466f8a334c">stp_color_unregister</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *color)</td></tr>
69
<tr class="memitem:ga68c13c36d723e5604507bf33fe629f8b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga68c13c36d723e5604507bf33fe629f8b">stp_color_count</a> (void)</td></tr>
70
<tr class="memdesc:ga68c13c36d723e5604507bf33fe629f8b"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available color modules. <a href="#ga68c13c36d723e5604507bf33fe629f8b"></a><br/></td></tr>
71
<tr class="memitem:ga3b8f62108f3604480e7b89b253527f4a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga3b8f62108f3604480e7b89b253527f4a">stp_get_color_by_name</a> (const char *name)</td></tr>
72
<tr class="memdesc:ga3b8f62108f3604480e7b89b253527f4a"><td class="mdescLeft"> </td><td class="mdescRight">Get a color module by its name. <a href="#ga3b8f62108f3604480e7b89b253527f4a"></a><br/></td></tr>
73
<tr class="memitem:ga68ba525119da39ae854645ae649557d3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga68ba525119da39ae854645ae649557d3">stp_get_color_by_index</a> (int idx)</td></tr>
74
<tr class="memdesc:ga68ba525119da39ae854645ae649557d3"><td class="mdescLeft"> </td><td class="mdescRight">Get a color module by its index number. <a href="#ga68ba525119da39ae854645ae649557d3"></a><br/></td></tr>
75
<tr class="memitem:ga578f80b2bc3937df38ce7e803f5f472c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga578f80b2bc3937df38ce7e803f5f472c">stp_get_color_by_colorfuncs</a> (<a class="el" href="structstp__colorfuncs__t.html">stp_colorfuncs_t</a> *colorfuncs)</td></tr>
76
<tr class="memitem:ga5a4a4da67cb5c3f1c0a2a9618e46ed50"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga5a4a4da67cb5c3f1c0a2a9618e46ed50">stp_color_get_name</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *c)</td></tr>
77
<tr class="memdesc:ga5a4a4da67cb5c3f1c0a2a9618e46ed50"><td class="mdescLeft"> </td><td class="mdescRight">Get the short (untranslated) name of a color module. <a href="#ga5a4a4da67cb5c3f1c0a2a9618e46ed50"></a><br/></td></tr>
78
<tr class="memitem:ga612389b45f09358f6bad0e376c91b057"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__color.html#ga612389b45f09358f6bad0e376c91b057">stp_color_get_long_name</a> (const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> *c)</td></tr>
79
<tr class="memdesc:ga612389b45f09358f6bad0e376c91b057"><td class="mdescLeft"> </td><td class="mdescRight">Get the long (translated) name of a color module. <a href="#ga612389b45f09358f6bad0e376c91b057"></a><br/></td></tr>
89
81
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
90
82
<p>The color data type is responsible for providing colour conversion features. </p>
91
83
<p>Color modules provide the actual functionality, so different colour management modules may provide the application with different services (for example, colour profiles). </p>
92
84
<hr/><h2>Typedef Documentation</h2>
93
<a class="anchor" id="gad1408f9835b72f266ec7c7e1e1202a74"></a><!-- doxytag: member="color.h::stp_color_t" ref="gad1408f9835b72f266ec7c7e1e1202a74" args="" -->
85
<a class="anchor" id="gad1408f9835b72f266ec7c7e1e1202a74"></a>
94
86
<div class="memitem">
95
87
<div class="memproto">
96
88
<table class="memname">
98
90
<td class="memname">typedef struct <a class="el" href="structstp__color.html">stp_color</a> <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a></td>
93
</div><div class="memdoc">
106
97
<hr/><h2>Function Documentation</h2>
107
<a class="anchor" id="ga68c13c36d723e5604507bf33fe629f8b"></a><!-- doxytag: member="color.h::stp_color_count" ref="ga68c13c36d723e5604507bf33fe629f8b" args="(void)" -->
98
<a class="anchor" id="ga68c13c36d723e5604507bf33fe629f8b"></a>
108
99
<div class="memitem">
109
100
<div class="memproto">
110
101
<table class="memname">
112
<td class="memname">int <a class="el" href="group__color.html#ga68c13c36d723e5604507bf33fe629f8b">stp_color_count</a> </td>
103
<td class="memname">int stp_color_count </td>
114
105
<td class="paramtype">void </td>
115
106
<td class="paramname"></td><td>)</td>
110
</div><div class="memdoc">
122
112
<p>Get the number of available color modules. </p>
123
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of color modules. </dd></dl>
113
<dl class="section return"><dt>Returns:</dt><dd>the number of color modules. </dd></dl>
127
<a class="anchor" id="ga83bc80c9fd84d741099bc20285a1b655"></a><!-- doxytag: member="color.h::stp_color_describe_parameter" ref="ga83bc80c9fd84d741099bc20285a1b655" args="(const stp_vars_t *v, const char *name, stp_parameter_t *description)" -->
117
<a class="anchor" id="ga83bc80c9fd84d741099bc20285a1b655"></a>
128
118
<div class="memitem">
129
119
<div class="memproto">
130
120
<table class="memname">
132
<td class="memname">void <a class="el" href="group__color.html#ga83bc80c9fd84d741099bc20285a1b655">stp_color_describe_parameter</a> </td>
122
<td class="memname">void stp_color_describe_parameter </td>
134
124
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
135
125
<td class="paramname"><em>v</em>, </td>
152
142
<td></td><td></td>
145
</div><div class="memdoc">
160
<a class="anchor" id="ga612389b45f09358f6bad0e376c91b057"></a><!-- doxytag: member="color.h::stp_color_get_long_name" ref="ga612389b45f09358f6bad0e376c91b057" args="(const stp_color_t *c)" -->
149
<a class="anchor" id="ga612389b45f09358f6bad0e376c91b057"></a>
161
150
<div class="memitem">
162
151
<div class="memproto">
163
152
<table class="memname">
165
<td class="memname">const char* <a class="el" href="group__color.html#ga612389b45f09358f6bad0e376c91b057">stp_color_get_long_name</a> </td>
154
<td class="memname">const char* stp_color_get_long_name </td>
167
156
<td class="paramtype">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td>
168
157
<td class="paramname"><em>c</em></td><td>)</td>
161
</div><div class="memdoc">
175
163
<p>Get the long (translated) name of a color module. </p>
176
<dl class="params"><dt><b>Parameters:</b></dt><dd>
164
<dl class="params"><dt>Parameters:</dt><dd>
177
165
<table class="params">
178
166
<tr><td class="paramname">c</td><td>the color module to use. </td></tr>
182
<dl class="return"><dt><b>Returns:</b></dt><dd>the long name. </dd></dl>
170
<dl class="section return"><dt>Returns:</dt><dd>the long name. </dd></dl>
186
<a class="anchor" id="ga5a4a4da67cb5c3f1c0a2a9618e46ed50"></a><!-- doxytag: member="color.h::stp_color_get_name" ref="ga5a4a4da67cb5c3f1c0a2a9618e46ed50" args="(const stp_color_t *c)" -->
174
<a class="anchor" id="ga5a4a4da67cb5c3f1c0a2a9618e46ed50"></a>
187
175
<div class="memitem">
188
176
<div class="memproto">
189
177
<table class="memname">
191
<td class="memname">const char* <a class="el" href="group__color.html#ga5a4a4da67cb5c3f1c0a2a9618e46ed50">stp_color_get_name</a> </td>
179
<td class="memname">const char* stp_color_get_name </td>
193
181
<td class="paramtype">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td>
194
182
<td class="paramname"><em>c</em></td><td>)</td>
186
</div><div class="memdoc">
201
188
<p>Get the short (untranslated) name of a color module. </p>
202
<dl class="params"><dt><b>Parameters:</b></dt><dd>
189
<dl class="params"><dt>Parameters:</dt><dd>
203
190
<table class="params">
204
191
<tr><td class="paramname">c</td><td>the color module to use. </td></tr>
208
<dl class="return"><dt><b>Returns:</b></dt><dd>the short name. </dd></dl>
195
<dl class="section return"><dt>Returns:</dt><dd>the short name. </dd></dl>
212
<a class="anchor" id="ga0cf28c3c9638987df4b1740deadba0cb"></a><!-- doxytag: member="color.h::stp_color_get_row" ref="ga0cf28c3c9638987df4b1740deadba0cb" args="(stp_vars_t *v, stp_image_t *image, int row, unsigned *zero_mask)" -->
199
<a class="anchor" id="ga0cf28c3c9638987df4b1740deadba0cb"></a>
213
200
<div class="memitem">
214
201
<div class="memproto">
215
202
<table class="memname">
217
<td class="memname">int <a class="el" href="group__color.html#ga0cf28c3c9638987df4b1740deadba0cb">stp_color_get_row</a> </td>
204
<td class="memname">int stp_color_get_row </td>
219
206
<td class="paramtype"><a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
220
207
<td class="paramname"><em>v</em>, </td>
276
262
<td></td><td></td>
265
</div><div class="memdoc">
284
<a class="anchor" id="gaa282220724877a57738b047140835141"></a><!-- doxytag: member="color.h::stp_color_list_parameters" ref="gaa282220724877a57738b047140835141" args="(const stp_vars_t *v)" -->
269
<a class="anchor" id="gaa282220724877a57738b047140835141"></a>
285
270
<div class="memitem">
286
271
<div class="memproto">
287
272
<table class="memname">
289
<td class="memname"><a class="el" href="group__vars.html#ga40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> <a class="el" href="group__color.html#gaa282220724877a57738b047140835141">stp_color_list_parameters</a> </td>
274
<td class="memname"><a class="el" href="group__vars.html#ga40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> stp_color_list_parameters </td>
291
276
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
292
277
<td class="paramname"><em>v</em></td><td>)</td>
301
<a class="anchor" id="ga47d6a8163ef21a6e700b1371228b851d"></a><!-- doxytag: member="color.h::stp_color_register" ref="ga47d6a8163ef21a6e700b1371228b851d" args="(const stp_color_t *color)" -->
302
<div class="memitem">
303
<div class="memproto">
304
<table class="memname">
306
<td class="memname">int <a class="el" href="group__color.html#ga47d6a8163ef21a6e700b1371228b851d">stp_color_register</a> </td>
308
<td class="paramtype">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td>
309
<td class="paramname"><em>color</em></td><td>)</td>
318
<a class="anchor" id="ga2b62ec8e0afe1b6297bc71466f8a334c"></a><!-- doxytag: member="color.h::stp_color_unregister" ref="ga2b62ec8e0afe1b6297bc71466f8a334c" args="(const stp_color_t *color)" -->
319
<div class="memitem">
320
<div class="memproto">
321
<table class="memname">
323
<td class="memname">int <a class="el" href="group__color.html#ga2b62ec8e0afe1b6297bc71466f8a334c">stp_color_unregister</a> </td>
325
<td class="paramtype">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td>
326
<td class="paramname"><em>color</em></td><td>)</td>
335
<a class="anchor" id="ga578f80b2bc3937df38ce7e803f5f472c"></a><!-- doxytag: member="color.h::stp_get_color_by_colorfuncs" ref="ga578f80b2bc3937df38ce7e803f5f472c" args="(stp_colorfuncs_t *colorfuncs)" -->
336
<div class="memitem">
337
<div class="memproto">
338
<table class="memname">
340
<td class="memname">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a>* <a class="el" href="group__color.html#ga578f80b2bc3937df38ce7e803f5f472c">stp_get_color_by_colorfuncs</a> </td>
281
</div><div class="memdoc">
285
<a class="anchor" id="ga47d6a8163ef21a6e700b1371228b851d"></a>
286
<div class="memitem">
287
<div class="memproto">
288
<table class="memname">
290
<td class="memname">int stp_color_register </td>
292
<td class="paramtype">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td>
293
<td class="paramname"><em>color</em></td><td>)</td>
297
</div><div class="memdoc">
301
<a class="anchor" id="ga2b62ec8e0afe1b6297bc71466f8a334c"></a>
302
<div class="memitem">
303
<div class="memproto">
304
<table class="memname">
306
<td class="memname">int stp_color_unregister </td>
308
<td class="paramtype">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a> * </td>
309
<td class="paramname"><em>color</em></td><td>)</td>
313
</div><div class="memdoc">
317
<a class="anchor" id="ga578f80b2bc3937df38ce7e803f5f472c"></a>
318
<div class="memitem">
319
<div class="memproto">
320
<table class="memname">
322
<td class="memname">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a>* stp_get_color_by_colorfuncs </td>
342
324
<td class="paramtype"><a class="el" href="structstp__colorfuncs__t.html">stp_colorfuncs_t</a> * </td>
343
325
<td class="paramname"><em>colorfuncs</em></td><td>)</td>
329
</div><div class="memdoc">
352
<a class="anchor" id="ga68ba525119da39ae854645ae649557d3"></a><!-- doxytag: member="color.h::stp_get_color_by_index" ref="ga68ba525119da39ae854645ae649557d3" args="(int idx)" -->
333
<a class="anchor" id="ga68ba525119da39ae854645ae649557d3"></a>
353
334
<div class="memitem">
354
335
<div class="memproto">
355
336
<table class="memname">
357
<td class="memname">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a>* <a class="el" href="group__color.html#ga68ba525119da39ae854645ae649557d3">stp_get_color_by_index</a> </td>
338
<td class="memname">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a>* stp_get_color_by_index </td>
359
340
<td class="paramtype">int </td>
360
341
<td class="paramname"><em>idx</em></td><td>)</td>
345
</div><div class="memdoc">
367
347
<p>Get a color module by its index number. </p>
368
<dl class="params"><dt><b>Parameters:</b></dt><dd>
348
<dl class="params"><dt>Parameters:</dt><dd>
369
349
<table class="params">
370
350
<tr><td class="paramname">idx</td><td>the index number. This must not be greater than (total number of papers - 1). </td></tr>
374
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the color module, or NULL on failure. </dd></dl>
354
<dl class="section return"><dt>Returns:</dt><dd>a pointer to the color module, or NULL on failure. </dd></dl>
378
<a class="anchor" id="ga3b8f62108f3604480e7b89b253527f4a"></a><!-- doxytag: member="color.h::stp_get_color_by_name" ref="ga3b8f62108f3604480e7b89b253527f4a" args="(const char *name)" -->
358
<a class="anchor" id="ga3b8f62108f3604480e7b89b253527f4a"></a>
379
359
<div class="memitem">
380
360
<div class="memproto">
381
361
<table class="memname">
383
<td class="memname">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a>* <a class="el" href="group__color.html#ga3b8f62108f3604480e7b89b253527f4a">stp_get_color_by_name</a> </td>
363
<td class="memname">const <a class="el" href="group__color.html#gad1408f9835b72f266ec7c7e1e1202a74">stp_color_t</a>* stp_get_color_by_name </td>
385
365
<td class="paramtype">const char * </td>
386
366
<td class="paramname"><em>name</em></td><td>)</td>
370
</div><div class="memdoc">
393
372
<p>Get a color module by its name. </p>
394
<dl class="params"><dt><b>Parameters:</b></dt><dd>
373
<dl class="params"><dt>Parameters:</dt><dd>
395
374
<table class="params">
396
375
<tr><td class="paramname">name</td><td>the short unique name. number of papers - 1). </td></tr>
400
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the color module, or NULL on failure. </dd></dl>
379
<dl class="section return"><dt>Returns:</dt><dd>a pointer to the color module, or NULL on failure. </dd></dl>
404
383
</div><!-- contents -->
384
<!-- start footer part -->
407
385
<hr class="footer"/><address class="footer"><small>
408
386
Generated by  <a href="http://www.doxygen.org/index.html">
409
387
<img class="footer" src="doxygen.png" alt="doxygen"/>
411
389
</small></address>