granicus.if.org Git - imagemagick/blob - 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: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 <div  class="sponsor">
 151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 152 </div>
 153 </div>
 154 </div>
 155 </div>\r
 156 \r
 157 <div class="eastbar">\r
 158   <script type="text/javascript">\r
 159   <!--\r
 160     google_ad_client = "pub-3129977114552745";\r
 161     google_ad_slot = "0574824969";\r
 162     google_ad_width = 160;\r
 163     google_ad_height = 600;\r
 164   //-->\r
 165   </script>\r
 166   <script type="text/javascript"\r
 167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 168   </script>\r
 169 </div>\r
 170 \r
 171 <div class="main">\r
 172 \r
 173 <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>
 174
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 176 _8c.html" target="source" name="GetColorInfoList">GetColorInfoList</a></h2>
 177 <div class="doc-section">
 178
 179 <p>GetColorInfoList() returns any colors that match the specified pattern.</p></ol>
 180
 181 <p>The format of the GetColorInfoList function is:</p>
 182
 183 <pre class="text">
 184   const ColorInfo **GetColorInfoList(const char *pattern,
 185     size_t *number_colors,ExceptionInfo *exception)
 186 </pre>
 187
 188 <p>A description of each parameter follows:</p></ol>
 189
 190 <h5>pattern</h5>
 191 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 192
 193 <h5>number_colors</h5>
 194 <ol><p>This integer returns the number of colors in the list.</p></ol>
 195
 196 <h5>exception</h5>
 197 <ol><p>return any errors or warnings in this structure.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 201 _8c.html" target="source" name="GetColorList">GetColorList</a></h2>
 202 <div class="doc-section">
 203
 204 <p>GetColorList() returns any colors that match the specified pattern.</p></ol>
 205
 206 <p>The format of the GetColorList function is:</p>
 207
 208 <pre class="text">
 209   char **GetColorList(const char *pattern,size_t *number_colors,
 210     ExceptionInfo *exception)
 211 </pre>
 212
 213 <p>A description of each parameter follows:</p></ol>
 214
 215 <h5>pattern</h5>
 216 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 217
 218 <h5>number_colors</h5>
 219 <ol><p>This integer returns the number of colors in the list.</p></ol>
 220
 221 <h5>exception</h5>
 222 <ol><p>return any errors or warnings in this structure.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 226 _8c.html" target="source" name="ListColorInfo">ListColorInfo</a></h2>
 227 <div class="doc-section">
 228
 229 <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>
 230
 231 <p>The format of the ListColorInfo method is:</p>
 232
 233 <pre class="code">
 234   MagickBooleanType ListColorInfo(FILE *file,ExceptionInfo *exception)
 235 </pre>
 236
 237 <p>A description of each parameter follows.</p></ol>
 238
 239 <h5>file</h5>
 240 <ol><p>List color names to this file handle.</p></ol>
 241
 242 <h5>exception</h5>
 243 <ol><p>return any errors or warnings in this structure.</p></ol>
 244
 245  </div>
 246 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 247 _8c.html" target="source" name="LoadColorList">LoadColorList</a></h2>
 248 <div class="doc-section">
 249
 250 <p>LoadColorList() loads one or more color configuration file which provides a mapping between color attributes and a color name.</p></ol>
 251
 252 <p>The format of the LoadColorLists method is:</p>
 253
 254 <pre class="code">
 255   MagickBooleanType LoadColorLists(const char *filename,
 256     ExceptionInfo *exception)
 257 </pre>
 258
 259 <p>A description of each parameter follows:</p></ol>
 260
 261 <h5>filename</h5>
 262 <ol><p>the font file name.</p></ol>
 263
 264 <h5>exception</h5>
 265 <ol><p>return any errors or warnings in this structure.</p></ol>
 266
 267  </div>
 268 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 269 _8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
 270 <div class="doc-section">
 271
 272 <p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
 273
 274 <p>The format of the QueryColorDatabase method is:</p>
 275
 276 <pre class="code">
 277   MagickBooleanType QueryColorDatabase(const char *name,
 278     const ComplianceType compliance,PixelPacket *color,
 279     ExceptionInfo *exception)
 280 </pre>
 281
 282 <p>A description of each parameter follows:</p></ol>
 283
 284 <h5>name</h5>
 285 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
 286
 287 <h5>compliance</h5>
 288 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
 289
 290 <h5>color</h5>
 291 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
 292
 293 <h5>exception</h5>
 294 <ol><p>return any errors or warnings in this structure.</p></ol>
 295
 296  </div>
 297 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 298 _8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
 299 <div class="doc-section">
 300
 301 <p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
 302
 303 <p>The format of the QueryColorDatabase method is:</p>
 304
 305 <pre class="code">
 306   MagickBooleanType QueryColorDatabase(const char *name,PixelPacket *color,
 307     ExceptionInfo *exception)
 308 </pre>
 309
 310 <p>A description of each parameter follows:</p></ol>
 311
 312 <h5>name</h5>
 313 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
 314
 315 <h5>color</h5>
 316 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
 317
 318 <h5>exception</h5>
 319 <ol><p>return any errors or warnings in this structure.</p></ol>
 320
 321  </div>
 322 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 323 _8c.html" target="source" name="QueryColorname">QueryColorname</a></h2>
 324 <div class="doc-section">
 325
 326 <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>
 327
 328 <p>The format of the QueryColorname method is:</p>
 329
 330 <pre class="code">
 331   MagickBooleanType QueryColorname(const Image *image,
 332     const PixelPacket *color,const ComplianceType compliance,char *name,
 333     ExceptionInfo *exception)
 334 </pre>
 335
 336 <p>A description of each parameter follows.</p></ol>
 337
 338 <h5>image</h5>
 339 <ol><p>the image.</p></ol>
 340
 341 <h5>color</h5>
 342 <ol><p>the color intensities.</p></ol>
 343
 344 <h5>compliance</h5>
 345 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
 346
 347 <h5>name</h5>
 348 <ol><p>Return the color name or hex value.</p></ol>
 349
 350 <h5>exception</h5>
 351 <ol><p>return any errors or warnings in this structure.</p></ol>
 352
 353  </div>
 354 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 355 _8c.html" target="source" name="QueryMagickColorCompliance">QueryMagickColorCompliance</a></h2>
 356 <div class="doc-section">
 357
 358 <p>QueryMagickColorCompliance() returns the red, green, blue, and opacity intensities for a given color name and standards compliance.</p></ol>
 359
 360 <p>The format of the QueryMagickColor method is:</p>
 361
 362 <pre class="code">
 363   MagickBooleanType QueryMagickColor(const char *name,
 364     const ComplianceType compliance,MagickPixelPacket *color,
 365     ExceptionInfo *exception)
 366 </pre>
 367
 368 <p>A description of each parameter follows:</p></ol>
 369
 370 <h5>name</h5>
 371 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
 372
 373 <h5>compliance</h5>
 374 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
 375
 376 <h5>color</h5>
 377 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
 378
 379 <h5>exception</h5>
 380 <ol><p>return any errors or warnings in this structure.</p></ol>
 381
 382  </div>
 383 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 384 _8c.html" target="source" name="QueryMagickColor">QueryMagickColor</a></h2>
 385 <div class="doc-section">
 386
 387 <p>QueryMagickColor() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
 388
 389 <p>The format of the QueryMagickColor method is:</p>
 390
 391 <pre class="code">
 392   MagickBooleanType QueryMagickColor(const char *name,
 393     MagickPixelPacket *color,ExceptionInfo *exception)
 394 </pre>
 395
 396 <p>A description of each parameter follows:</p></ol>
 397
 398 <h5>name</h5>
 399 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
 400
 401 <h5>color</h5>
 402 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
 403
 404 <h5>exception</h5>
 405 <ol><p>return any errors or warnings in this structure.</p></ol>
 406
 407  </div>
 408 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 409 _8c.html" target="source" name="QueryMagickColorname">QueryMagickColorname</a></h2>
 410 <div class="doc-section">
 411
 412 <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>
 413
 414 <p>The format of the QueryMagickColorname method is:</p>
 415
 416 <pre class="code">
 417   MagickBooleanType QueryMagickColorname(const Image *image,
 418     const PixelPacket *color,const ComplianceType compliance,char *name,
 419     ExceptionInfo *exception)
 420 </pre>
 421
 422 <p>A description of each parameter follows.</p></ol>
 423
 424 <h5>image</h5>
 425 <ol><p>the image.</p></ol>
 426
 427 <h5>color</h5>
 428 <ol><p>the color intensities.</p></ol>
 429
 430 <h5>Compliance</h5>
 431 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
 432
 433 <h5>name</h5>
 434 <ol><p>Return the color name or hex value.</p></ol>
 435
 436 <h5>exception</h5>
 437 <ol><p>return any errors or warnings in this structure.</p></ol>
 438
 439  </div>
 440 \r
 441 </div>\r
 442 \r
 443 <div id="linkbar">\r
 444     <span id="linkbar-west">&nbsp;</span>\r
 445     <span id="linkbar-center">\r
 446       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 447       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 448     </span>\r
 449     <span id="linkbar-east">&nbsp;</span>\r
 450   </div>\r
 451   <div class="footer">\r
 452     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 453     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 454   </div>\r
 455   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 456   <script type="text/javascript">\r
 457     var _gaq = _gaq || [];\r
 458     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 459     _gaq.push(['_trackPageview']);\r
 460 \r
 461     (function() {\r
 462       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 463       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 464       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 465     })();\r
 466   </script>\r
 467 </body>\r
 468 </html>\r