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