granicus.if.org Git - imagemagick/blob - www/api/color.html

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