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