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">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="screen,projection"><!--\r
   9     @import url("../../www/magick.css");\r
  10   --></style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Count the Colors in an Image</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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="#QueryColorname">QueryColorname</a> &bull; <a href="#QueryMagickColor">QueryMagickColor</a> &bull; <a href="#QueryMagickColorname">QueryMagickColorname</a>]</p>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 161 _8c.html" target="source" name="GetColorInfoList">GetColorInfoList</a></h2>
 162 <div class="doc-section">
 163
 164 <p>GetColorInfoList() returns any colors that match the specified pattern.</p></ol>
 165
 166 <p>The format of the GetColorInfoList function is:</p>
 167
 168 <pre class="text">
 169   const ColorInfo **GetColorInfoList(const char *pattern,
 170     unsigned long *number_colors,ExceptionInfo *exception)
 171 </pre>
 172
 173 <p>A description of each parameter follows:</p></ol>
 174
 175 <h5>pattern</h5>
 176 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 177
 178 <h5>number_colors</h5>
 179 <ol><p>This integer returns the number of colors in the list.</p></ol>
 180
 181 <h5>exception</h5>
 182 <ol><p>return any errors or warnings in this structure.</p></ol>
 183
 184  </div>
 185 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 186 _8c.html" target="source" name="GetColorList">GetColorList</a></h2>
 187 <div class="doc-section">
 188
 189 <p>GetColorList() returns any colors that match the specified pattern.</p></ol>
 190
 191 <p>The format of the GetColorList function is:</p>
 192
 193 <pre class="text">
 194   char **GetColorList(const char *pattern,unsigned long *number_colors,
 195     ExceptionInfo *exception)
 196 </pre>
 197
 198 <p>A description of each parameter follows:</p></ol>
 199
 200 <h5>pattern</h5>
 201 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 202
 203 <h5>number_colors</h5>
 204 <ol><p>This integer returns the number of colors in the list.</p></ol>
 205
 206 <h5>exception</h5>
 207 <ol><p>return any errors or warnings in this structure.</p></ol>
 208
 209  </div>
 210 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 211 _8c.html" target="source" name="ListColorInfo">ListColorInfo</a></h2>
 212 <div class="doc-section">
 213
 214 <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>
 215
 216 <p>The format of the ListColorInfo method is:</p>
 217
 218 <pre class="code">
 219   MagickBooleanType ListColorInfo(FILE *file,ExceptionInfo *exception)
 220 </pre>
 221
 222 <p>A description of each parameter follows.</p></ol>
 223
 224 <h5>file</h5>
 225 <ol><p>List color names to this file handle.</p></ol>
 226
 227 <h5>exception</h5>
 228 <ol><p>return any errors or warnings in this structure.</p></ol>
 229
 230  </div>
 231 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 232 _8c.html" target="source" name="LoadColorList">LoadColorList</a></h2>
 233 <div class="doc-section">
 234
 235 <p>LoadColorList() loads one or more color configuration file which provides a mapping between color attributes and a color name.</p></ol>
 236
 237 <p>The format of the LoadColorLists method is:</p>
 238
 239 <pre class="code">
 240   MagickBooleanType LoadColorLists(const char *filename,
 241     ExceptionInfo *exception)
 242 </pre>
 243
 244 <p>A description of each parameter follows:</p></ol>
 245
 246 <h5>filename</h5>
 247 <ol><p>the font file name.</p></ol>
 248
 249 <h5>exception</h5>
 250 <ol><p>return any errors or warnings in this structure.</p></ol>
 251
 252  </div>
 253 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 254 _8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
 255 <div class="doc-section">
 256
 257 <p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
 258
 259 <p>The format of the QueryColorDatabase method is:</p>
 260
 261 <pre class="code">
 262   MagickBooleanType QueryColorDatabase(const char *name,PixelPacket *color,
 263     ExceptionInfo *exception)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p></ol>
 267
 268 <h5>name</h5>
 269 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
 270
 271 <h5>color</h5>
 272 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
 273
 274 <h5>exception</h5>
 275 <ol><p>return any errors or warnings in this structure.</p></ol>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 279 _8c.html" target="source" name="QueryColorname">QueryColorname</a></h2>
 280 <div class="doc-section">
 281
 282 <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>
 283
 284 <p>The format of the QueryColorname method is:</p>
 285
 286 <pre class="code">
 287   MagickBooleanType QueryColorname(const Image *image,
 288     const PixelPacket *color,const ComplianceType compliance,char *name,
 289     ExceptionInfo *exception)
 290 </pre>
 291
 292 <p>A description of each parameter follows.</p></ol>
 293
 294 <h5>image</h5>
 295 <ol><p>the image.</p></ol>
 296
 297 <h5>color</h5>
 298 <ol><p>the color intensities.</p></ol>
 299
 300 <h5>compliance</h5>
 301 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
 302
 303 <h5>name</h5>
 304 <ol><p>Return the color name or hex value.</p></ol>
 305
 306 <h5>exception</h5>
 307 <ol><p>return any errors or warnings in this structure.</p></ol>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 311 _8c.html" target="source" name="QueryMagickColor">QueryMagickColor</a></h2>
 312 <div class="doc-section">
 313
 314 <p>QueryMagickColor() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
 315
 316 <p>The format of the QueryMagickColor method is:</p>
 317
 318 <pre class="code">
 319   MagickBooleanType QueryMagickColor(const char *name,
 320     MagickPixelPacket *color,ExceptionInfo *exception)
 321 </pre>
 322
 323 <p>A description of each parameter follows:</p></ol>
 324
 325 <h5>name</h5>
 326 <ol><p>the color name (e.g. white, blue, yellow).</p></ol>
 327
 328 <h5>color</h5>
 329 <ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
 330
 331 <h5>exception</h5>
 332 <ol><p>return any errors or warnings in this structure.</p></ol>
 333
 334  </div>
 335 <h2><a href="http://www.imagemagick.org/api/MagickCore/color
 336 _8c.html" target="source" name="QueryMagickColorname">QueryMagickColorname</a></h2>
 337 <div class="doc-section">
 338
 339 <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>
 340
 341 <p>The format of the QueryMagickColorname method is:</p>
 342
 343 <pre class="code">
 344   MagickBooleanType QueryMagickColorname(const Image *image,
 345     const PixelPacket *color,const ComplianceType compliance,char *name,
 346     ExceptionInfo *exception)
 347 </pre>
 348
 349 <p>A description of each parameter follows.</p></ol>
 350
 351 <h5>image</h5>
 352 <ol><p>the image.</p></ol>
 353
 354 <h5>color</h5>
 355 <ol><p>the color intensities.</p></ol>
 356
 357 <h5>Compliance</h5>
 358 <ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
 359
 360 <h5>name</h5>
 361 <ol><p>Return the color name or hex value.</p></ol>
 362
 363 <h5>exception</h5>
 364 <ol><p>return any errors or warnings in this structure.</p></ol>
 365
 366  </div>
 367 \r
 368 </div>\r
 369 \r
 370 <div id="linkbar">\r
 371  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 372     <span id="linkbar-center">\r
 373       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 374     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 375     </span>\r
 376     <span id="linkbar-east">&nbsp;</span>\r
 377   </div>\r
 378   <div class="footer">\r
 379     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 380     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 381   </div>\r
 382   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 383 </body>\r
 384 </html>\r