]> granicus.if.org Git - imagemagick/blob - www/api/color.html
efaa22b09e9756d7273e0914f390376772071721
[imagemagick] / www / api / color.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
4 <head>\r
5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
8   <style type="text/css" media="all">\r
9     @import url("../../www/magick.css");\r
10   </style>\r
11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
12   <title>ImageMagick: MagickCore, C API for ImageMagick: Count the Colors in an Image</title>
13   <meta http-equiv="Content-Language" content="en-US"/>
14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16   <meta name="Generator" content="PHP"/>
17   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, count, the, colors, in, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19   <meta name="Rating" content="GENERAL"/>
20   <meta name="Robots" content="INDEX, FOLLOW"/>
21   <meta name="Generator" content="ImageMagick Studio LLC"/>
22   <meta name="Author" content="ImageMagick Studio LLC"/>
23   <meta name="Revisit-after" content="2 DAYS"/>
24   <meta name="Resource-type" content="document"/>
25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26   <meta name="Distribution" content="Global"/>
27 </head>\r
28 \r
29 <body id="www-imagemagick-org">\r
30 <div class="titlebar">\r
31 <a href="../../index.html">\r
32   <img src="../../images/script.png" alt="[ImageMagick]"\r
33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
34 <a href="http://www.networkredux.com">\r
35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
37 <a href="http://www.imagemagick.org/discourse-server/">\r
38   <img src="../../images/logo.jpg" alt=""\r
39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
40 <a href="../../index.html">\r
41   <img src="../../images/sprite.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 </div>\r
44 \r
45 <div class="eastbar">\r
46 \r
47 <div class="menu">
48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
49 </div>
50 <div class="sep"></div>\r
51 <div class="menu">
52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53 </div>
54 <div class="sub">
55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62 </div>
63 <div class="sep"></div>\r
64 <div class="menu">
65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
66 </div>
67 <div class="sub">
68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
75 </div>
76 <div class="menu">
77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
78 </div>
79 <div class="sub">
80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
90 </div>
91 <div class="sep"></div>\r
92 <div  class="menu">
93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
94 </div>
95 <div class="sub">
96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
100  </div>
101 <div class="menu">
102   <a title="Resources" href="../../www/resources.html">Resources</a>
103 </div>
104 <div class="menu">
105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106 </div>
107 <div class="menu">
108   <a title="Download" href="../../www/download.html">Download</a>
109 </div>
110 <div class="sep"></div>\r
111 <div class="menu">
112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
113 </div>
114 <div class="sep"></div>\r
115 <div class="menu">
116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
117 </div>
118 <div  class="sub">
119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
120 </div>
121 <div class="sep"></div>\r
122 <div  class="menu">
123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
124
125 <div class="sponsbox">
126 <div  class="sponsor">
127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
128 </div>
129 <div  class="sponsor">
130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
137 </div>
138 <div  class="sponsor">
139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140 </div>
141 <div  class="sponsor">
142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
143 </div>
144 <div  class="sponsor">
145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20111001000240 -->
146 </div>
147 </div>
148 </div>
149 \r
150 \r
151 </div>\r
152 \r
153 <div class="main">\r
154 \r
155 <p class="navigation-index">[<a href="#GetColorInfoList">GetColorInfoList</a> &bull; <a href="#GetColorList">GetColorList</a> &bull; <a href="#ListColorInfo">ListColorInfo</a> &bull; <a href="#LoadColorList">LoadColorList</a> &bull; <a href="#QueryColorDatabase">QueryColorDatabase</a> &bull; <a href="#QueryColorname">QueryColorname</a> &bull; <a href="#QueryMagickColor">QueryMagickColor</a> &bull; <a href="#QueryMagickColorname">QueryMagickColorname</a>]</p>
156
157 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
158 _8c.html" target="source" name="GetColorInfoList">GetColorInfoList</a></h2>
159 <div class="doc-section">
160
161 <p>GetColorInfoList() returns any colors that match the specified pattern.</p></ol>
162
163 <p>The format of the GetColorInfoList function is:</p>
164
165 <pre class="text">
166   const ColorInfo **GetColorInfoList(const char *pattern,
167     size_t *number_colors,ExceptionInfo *exception)
168 </pre>
169
170 <p>A description of each parameter follows:</p></ol>
171
172 <h5>pattern</h5>
173 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
174
175 <h5>number_colors</h5>
176 <ol><p>This integer returns the number of colors in the list.</p></ol>
177
178 <h5>exception</h5>
179 <ol><p>return any errors or warnings in this structure.</p></ol>
180
181  </div>
182 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
183 _8c.html" target="source" name="GetColorList">GetColorList</a></h2>
184 <div class="doc-section">
185
186 <p>GetColorList() returns any colors that match the specified pattern.</p></ol>
187
188 <p>The format of the GetColorList function is:</p>
189
190 <pre class="text">
191   char **GetColorList(const char *pattern,size_t *number_colors,
192     ExceptionInfo *exception)
193 </pre>
194
195 <p>A description of each parameter follows:</p></ol>
196
197 <h5>pattern</h5>
198 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
199
200 <h5>number_colors</h5>
201 <ol><p>This integer returns the number of colors in the list.</p></ol>
202
203 <h5>exception</h5>
204 <ol><p>return any errors or warnings in this structure.</p></ol>
205
206  </div>
207 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
208 _8c.html" target="source" name="ListColorInfo">ListColorInfo</a></h2>
209 <div class="doc-section">
210
211 <p>ListColorInfo() lists color names to the specified file.  Color names are a convenience.  Rather than defining a color by its red, green, and blue intensities just use a color name such as white, blue, or yellow.</p></ol>
212
213 <p>The format of the ListColorInfo method is:</p>
214
215 <pre class="code">
216   MagickBooleanType ListColorInfo(FILE *file,ExceptionInfo *exception)
217 </pre>
218
219 <p>A description of each parameter follows.</p></ol>
220
221 <h5>file</h5>
222 <ol><p>List color names to this file handle.</p></ol>
223
224 <h5>exception</h5>
225 <ol><p>return any errors or warnings in this structure.</p></ol>
226
227  </div>
228 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
229 _8c.html" target="source" name="LoadColorList">LoadColorList</a></h2>
230 <div class="doc-section">
231
232 <p>LoadColorList() loads one or more color configuration file which provides a mapping between color attributes and a color name.</p></ol>
233
234 <p>The format of the LoadColorLists method is:</p>
235
236 <pre class="code">
237   MagickBooleanType LoadColorLists(const char *filename,
238     ExceptionInfo *exception)
239 </pre>
240
241 <p>A description of each parameter follows:</p></ol>
242
243 <h5>filename</h5>
244 <ol><p>the font file name.</p></ol>
245
246 <h5>exception</h5>
247 <ol><p>return any errors or warnings in this structure.</p></ol>
248
249  </div>
250 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
251 _8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
252 <div class="doc-section">
253
254 <p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
255
256 <p>The format of the QueryColorDatabase method is:</p>
257
258 <pre class="code">
259   MagickBooleanType QueryColorDatabase(const char *name,PixelPacket *color,
260     ExceptionInfo *exception)
261 </pre>
262
263 <p>A description of each parameter follows:</p></ol>
264
265 <h5>name</h5>
266 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
267
268 <h5>color</h5>
269 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
270
271 <h5>exception</h5>
272 <ol><p>return any errors or warnings in this structure.</p></ol>
273
274  </div>
275 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
276 _8c.html" target="source" name="QueryColorname">QueryColorname</a></h2>
277 <div class="doc-section">
278
279 <p>QueryColorname() returns a named color for the given color intensity.  If an exact match is not found, a rgb() color is returned instead.</p></ol>
280
281 <p>The format of the QueryColorname method is:</p>
282
283 <pre class="code">
284   MagickBooleanType QueryColorname(const Image *image,
285     const PixelPacket *color,const ComplianceType compliance,char *name,
286     ExceptionInfo *exception)
287 </pre>
288
289 <p>A description of each parameter follows.</p></ol>
290
291 <h5>image</h5>
292 <ol><p>the image.</p></ol>
293
294 <h5>color</h5>
295 <ol><p>the color intensities.</p></ol>
296
297 <h5>compliance</h5>
298 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
299
300 <h5>name</h5>
301 <ol><p>Return the color name or hex value.</p></ol>
302
303 <h5>exception</h5>
304 <ol><p>return any errors or warnings in this structure.</p></ol>
305
306  </div>
307 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
308 _8c.html" target="source" name="QueryMagickColor">QueryMagickColor</a></h2>
309 <div class="doc-section">
310
311 <p>QueryMagickColor() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
312
313 <p>The format of the QueryMagickColor method is:</p>
314
315 <pre class="code">
316   MagickBooleanType QueryMagickColor(const char *name,
317     MagickPixelPacket *color,ExceptionInfo *exception)
318 </pre>
319
320 <p>A description of each parameter follows:</p></ol>
321
322 <h5>name</h5>
323 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
324
325 <h5>color</h5>
326 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
327
328 <h5>exception</h5>
329 <ol><p>return any errors or warnings in this structure.</p></ol>
330
331  </div>
332 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
333 _8c.html" target="source" name="QueryMagickColorname">QueryMagickColorname</a></h2>
334 <div class="doc-section">
335
336 <p>QueryMagickColorname() returns a named color for the given color intensity. If an exact match is not found, a hex value is returned instead.  For example an intensity of rgb:(0,0,0) returns black whereas rgb:(223,223,223) returns #dfdfdf.</p></ol>
337
338 <p>The format of the QueryMagickColorname method is:</p>
339
340 <pre class="code">
341   MagickBooleanType QueryMagickColorname(const Image *image,
342     const PixelPacket *color,const ComplianceType compliance,char *name,
343     ExceptionInfo *exception)
344 </pre>
345
346 <p>A description of each parameter follows.</p></ol>
347
348 <h5>image</h5>
349 <ol><p>the image.</p></ol>
350
351 <h5>color</h5>
352 <ol><p>the color intensities.</p></ol>
353
354 <h5>Compliance</h5>
355 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
356
357 <h5>name</h5>
358 <ol><p>Return the color name or hex value.</p></ol>
359
360 <h5>exception</h5>
361 <ol><p>return any errors or warnings in this structure.</p></ol>
362
363  </div>
364 \r
365 </div>\r
366 \r
367 <div id="linkbar">\r
368  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
369     <span id="linkbar-center">\r
370       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
371     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
372     </span>\r
373     <span id="linkbar-east">&nbsp;</span>\r
374   </div>\r
375   <div class="footer">\r
376     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
377     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
378   </div>\r
379   <div style="clear: both; margin: 0; width: 100%; "></div>\r
380 </body>\r
381 </html>\r