]> granicus.if.org Git - imagemagick/blob - www/api/color.html
(no commit message)
[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   <title>ImageMagick: MagickCore, C API for ImageMagick: Count the Colors in an Image</title/>
8   <meta http-equiv="Content-Language" content="en-US"/>
9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
11   <meta name="Application-name" content="ImageMagick"/>
12   <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."/>
13   <meta name="Application-url" content="http://www.imagemagick.org"/>
14   <meta name="Generator" content="PHP"/>
15   <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"/>
16   <meta name="Rating" content="GENERAL"/>
17   <meta name="Robots" content="INDEX, FOLLOW"/>
18   <meta name="Generator" content="ImageMagick Studio LLC"/>
19   <meta name="Author" content="ImageMagick Studio LLC"/>
20   <meta name="Revisit-after" content="2 DAYS"/>
21   <meta name="Resource-type" content="document"/>
22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
23   <meta name="Distribution" content="Global"/>
24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
27   <style type="text/css" media="all">\r
28     @import url("../../www/magick.css");\r
29   </style>\r
30 </head>\r
31 \r
32 <body id="www-imagemagick-org">\r
33 <div class="titlebar">\r
34 <a href="../../index.html">\r
35   <img src="../../images/script.png" alt="[ImageMagick]"\r
36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
37 <a href="http://www.networkredux.com">\r
38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
40 <a href="http://www.imagemagick.org/discourse-server/">\r
41   <img src="../../images/logo.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 <a href="../../index.html">\r
44   <img src="../../images/sprite.jpg" alt=""\r
45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
46 </div>\r
47 \r
48 <div class="westbar">\r
49 \r
50 <div class="menu">
51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
52 </div>
53 <div class="sep"></div>\r
54 <div class="menu">
55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62 </div>
63 <div class="sub">
64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65 </div>
66 <div class="sep"></div>\r
67 <div class="menu">
68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
75 </div>
76 <div class="sub">
77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
78 </div>
79 <div class="menu">
80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
90 </div>
91 <div class="sub">
92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
93 </div>
94 <div class="sep"></div>\r
95 <div  class="menu">
96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
100 </div>
101 <div class="sub">
102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
103  </div>
104 <div class="menu">
105   <a title="Resources" href="../../www/resources.html">Resources</a>
106 </div>
107 <div class="menu">
108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109 </div>
110 <div class="menu">
111   <a title="Download" href="../../www/download.html">Download</a>
112 </div>
113 <div class="sep"></div>\r
114 <div class="menu">
115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
116 </div>
117 <div class="sep"></div>\r
118 <div class="menu">
119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
120 </div>
121 <div  class="sub">
122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
123 </div>
124 <div class="sep"></div>\r
125 <div  class="menu">
126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
127
128 <div class="sponsbox">
129 <div  class="sponsor">
130   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
137 </div>
138 <div  class="sponsor">
139   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
140 </div>
141 <div  class="sponsor">
142   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
143 </div>
144 <div  class="sponsor">
145    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
146 </div>
147 <div  class="sponsor">
148    <a title="Sponsor: Atlas Multimedia" href="http://www.atlas-multimedia.de/">Atlas Multimedia</a><!-- 20101201000025 tanju.temurbas-->
149 </div>
150 </div>
151 </div>
152 </div>\r
153 \r
154 <div class="eastbar">\r
155   <script type="text/javascript">\r
156   <!--\r
157     google_ad_client = "pub-3129977114552745";\r
158     google_ad_slot = "0574824969";\r
159     google_ad_width = 160;\r
160     google_ad_height = 600;\r
161   //-->\r
162   </script>\r
163   <script type="text/javascript"\r
164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
165   </script>\r
166 </div>\r
167 \r
168 <div class="main">\r
169 \r
170 <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="#QueryColorDatabase">QueryColorDatabase</a> &bull; <a href="#QueryColorname">QueryColorname</a> &bull; <a href="#QueryMagickColorCompliance">QueryMagickColorCompliance</a> &bull; <a href="#QueryMagickColor">QueryMagickColor</a> &bull; <a href="#QueryMagickColorname">QueryMagickColorname</a>]</p>
171
172 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
173 _8c.html" target="source" name="GetColorInfoList">GetColorInfoList</a></h2>
174 <div class="doc-section">
175
176 <p>GetColorInfoList() returns any colors that match the specified pattern.</p></ol>
177
178 <p>The format of the GetColorInfoList function is:</p>
179
180 <pre class="text">
181   const ColorInfo **GetColorInfoList(const char *pattern,
182     size_t *number_colors,ExceptionInfo *exception)
183 </pre>
184
185 <p>A description of each parameter follows:</p></ol>
186
187 <h5>pattern</h5>
188 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
189
190 <h5>number_colors</h5>
191 <ol><p>This integer returns the number of colors in the list.</p></ol>
192
193 <h5>exception</h5>
194 <ol><p>return any errors or warnings in this structure.</p></ol>
195
196  </div>
197 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
198 _8c.html" target="source" name="GetColorList">GetColorList</a></h2>
199 <div class="doc-section">
200
201 <p>GetColorList() returns any colors that match the specified pattern.</p></ol>
202
203 <p>The format of the GetColorList function is:</p>
204
205 <pre class="text">
206   char **GetColorList(const char *pattern,size_t *number_colors,
207     ExceptionInfo *exception)
208 </pre>
209
210 <p>A description of each parameter follows:</p></ol>
211
212 <h5>pattern</h5>
213 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
214
215 <h5>number_colors</h5>
216 <ol><p>This integer returns the number of colors in the list.</p></ol>
217
218 <h5>exception</h5>
219 <ol><p>return any errors or warnings in this structure.</p></ol>
220
221  </div>
222 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
223 _8c.html" target="source" name="ListColorInfo">ListColorInfo</a></h2>
224 <div class="doc-section">
225
226 <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>
227
228 <p>The format of the ListColorInfo method is:</p>
229
230 <pre class="code">
231   MagickBooleanType ListColorInfo(FILE *file,ExceptionInfo *exception)
232 </pre>
233
234 <p>A description of each parameter follows.</p></ol>
235
236 <h5>file</h5>
237 <ol><p>List color names to this file handle.</p></ol>
238
239 <h5>exception</h5>
240 <ol><p>return any errors or warnings in this structure.</p></ol>
241
242  </div>
243 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
244 _8c.html" target="source" name="LoadColorList">LoadColorList</a></h2>
245 <div class="doc-section">
246
247 <p>LoadColorList() loads one or more color configuration file which provides a mapping between color attributes and a color name.</p></ol>
248
249 <p>The format of the LoadColorLists method is:</p>
250
251 <pre class="code">
252   MagickBooleanType LoadColorLists(const char *filename,
253     ExceptionInfo *exception)
254 </pre>
255
256 <p>A description of each parameter follows:</p></ol>
257
258 <h5>filename</h5>
259 <ol><p>the font file name.</p></ol>
260
261 <h5>exception</h5>
262 <ol><p>return any errors or warnings in this structure.</p></ol>
263
264  </div>
265 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
266 _8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
267 <div class="doc-section">
268
269 <p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
270
271 <p>The format of the QueryColorDatabase method is:</p>
272
273 <pre class="code">
274   MagickBooleanType QueryColorDatabase(const char *name,
275     const ComplianceType compliance,PixelPacket *color,
276     ExceptionInfo *exception)
277 </pre>
278
279 <p>A description of each parameter follows:</p></ol>
280
281 <h5>name</h5>
282 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
283
284 <h5>compliance</h5>
285 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
286
287 <h5>color</h5>
288 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
289
290 <h5>exception</h5>
291 <ol><p>return any errors or warnings in this structure.</p></ol>
292
293  </div>
294 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
295 _8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
296 <div class="doc-section">
297
298 <p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
299
300 <p>The format of the QueryColorDatabase method is:</p>
301
302 <pre class="code">
303   MagickBooleanType QueryColorDatabase(const char *name,PixelPacket *color,
304     ExceptionInfo *exception)
305 </pre>
306
307 <p>A description of each parameter follows:</p></ol>
308
309 <h5>name</h5>
310 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
311
312 <h5>color</h5>
313 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
314
315 <h5>exception</h5>
316 <ol><p>return any errors or warnings in this structure.</p></ol>
317
318  </div>
319 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
320 _8c.html" target="source" name="QueryColorname">QueryColorname</a></h2>
321 <div class="doc-section">
322
323 <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>
324
325 <p>The format of the QueryColorname method is:</p>
326
327 <pre class="code">
328   MagickBooleanType QueryColorname(const Image *image,
329     const PixelPacket *color,const ComplianceType compliance,char *name,
330     ExceptionInfo *exception)
331 </pre>
332
333 <p>A description of each parameter follows.</p></ol>
334
335 <h5>image</h5>
336 <ol><p>the image.</p></ol>
337
338 <h5>color</h5>
339 <ol><p>the color intensities.</p></ol>
340
341 <h5>compliance</h5>
342 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
343
344 <h5>name</h5>
345 <ol><p>Return the color name or hex value.</p></ol>
346
347 <h5>exception</h5>
348 <ol><p>return any errors or warnings in this structure.</p></ol>
349
350  </div>
351 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
352 _8c.html" target="source" name="QueryMagickColorCompliance">QueryMagickColorCompliance</a></h2>
353 <div class="doc-section">
354
355 <p>QueryMagickColorCompliance() returns the red, green, blue, and opacity intensities for a given color name and standards compliance.</p></ol>
356
357 <p>The format of the QueryMagickColor method is:</p>
358
359 <pre class="code">
360   MagickBooleanType QueryMagickColor(const char *name,
361     const ComplianceType compliance,MagickPixelPacket *color,
362     ExceptionInfo *exception)
363 </pre>
364
365 <p>A description of each parameter follows:</p></ol>
366
367 <h5>name</h5>
368 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
369
370 <h5>compliance</h5>
371 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
372
373 <h5>color</h5>
374 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
375
376 <h5>exception</h5>
377 <ol><p>return any errors or warnings in this structure.</p></ol>
378
379  </div>
380 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
381 _8c.html" target="source" name="QueryMagickColor">QueryMagickColor</a></h2>
382 <div class="doc-section">
383
384 <p>QueryMagickColor() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
385
386 <p>The format of the QueryMagickColor method is:</p>
387
388 <pre class="code">
389   MagickBooleanType QueryMagickColor(const char *name,
390     MagickPixelPacket *color,ExceptionInfo *exception)
391 </pre>
392
393 <p>A description of each parameter follows:</p></ol>
394
395 <h5>name</h5>
396 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
397
398 <h5>color</h5>
399 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
400
401 <h5>exception</h5>
402 <ol><p>return any errors or warnings in this structure.</p></ol>
403
404  </div>
405 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
406 _8c.html" target="source" name="QueryMagickColorname">QueryMagickColorname</a></h2>
407 <div class="doc-section">
408
409 <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>
410
411 <p>The format of the QueryMagickColorname method is:</p>
412
413 <pre class="code">
414   MagickBooleanType QueryMagickColorname(const Image *image,
415     const PixelPacket *color,const ComplianceType compliance,char *name,
416     ExceptionInfo *exception)
417 </pre>
418
419 <p>A description of each parameter follows.</p></ol>
420
421 <h5>image</h5>
422 <ol><p>the image.</p></ol>
423
424 <h5>color</h5>
425 <ol><p>the color intensities.</p></ol>
426
427 <h5>Compliance</h5>
428 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
429
430 <h5>name</h5>
431 <ol><p>Return the color name or hex value.</p></ol>
432
433 <h5>exception</h5>
434 <ol><p>return any errors or warnings in this structure.</p></ol>
435
436  </div>
437 \r
438 </div>\r
439 \r
440 <div id="linkbar">\r
441     <span id="linkbar-west">&nbsp;</span>\r
442     <span id="linkbar-center">\r
443       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
444       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
445     </span>\r
446     <span id="linkbar-east">&nbsp;</span>\r
447   </div>\r
448   <div class="footer">\r
449     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
450     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
451   </div>\r
452   <div style="clear: both; margin: 0; width: 100%; "></div>\r
453   <script type="text/javascript">\r
454     var _gaq = _gaq || [];\r
455     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
456     _gaq.push(['_trackPageview']);\r
457 \r
458     (function() {\r
459       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
460       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
461       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
462     })();\r
463   </script>\r
464 </body>\r
465 </html>\r