Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 5cadd6188544c5c842e97e7a60c7459fb2286ef7 / . / www / api / color.html
blob: e0c9c78734f576f307cd347da8fc12cd403b4bd4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
--></style>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
<title>ImageMagick: MagickCore, C API for ImageMagick: Count the Colors in an Image</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<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."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<a href="../../index.html">
<img src="../../images/script.png" alt="[ImageMagick]"
style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
<a href="http://www.networkredux.com">
<img src="../../images/networkredux.png" alt="[sponsor]"
style="margin: 45px auto; border: 0px; float: left;" /></a>
<a href="http://www.imagemagick.org/discourse-server/">
<img src="../../images/logo.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="eastbar">
<div class="menu">
<a href="../../index.html">About ImageMagick</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a href="../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a href="../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a href="../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a href="../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a href="../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a href="../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a href="../../Magick++/">Magick++</a>
</div>
<div class="menu">
<a href="../../www/architecture.html">Architecture</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a href="../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a href="../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a href="../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="menu">
<a href="../../www/resources.html">Resources</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../http://www.imagemagick.org/script/search.php">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a href="../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/sponsors.html">Sponsors:</a>
<div class="sponsbox">
<div class="sponsor">
<a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
</div>
<div class="sponsor">
<a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
</div>
<div class="sponsor">
<a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
</div>
<div class="sponsor">
<a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
</div>
<div class="sponsor">
<a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
</div>
<div class="sponsor">
<a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
</div>
</div>
</div>
</div>
<div class="main">
<p class="navigation-index">[<a href="#GetColorInfoList">GetColorInfoList</a> &bull; <a href="#GetColorList">GetColorList</a> &bull; <a href="#GetImageHistogram">GetImageHistogram</a> &bull; <a href="#GetNumberColors">GetNumberColors</a> &bull; <a href="#IsGrayImage">IsGrayImage</a> &bull; <a href="#IsHistogramImage">IsHistogramImage</a> &bull; <a href="#IsMonochromeImage">IsMonochromeImage</a> &bull; <a href="#IsOpaqueImage">IsOpaqueImage</a> &bull; <a href="#IsPaletteImage">IsPaletteImage</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> &bull; <a href="#UniqueImageColors">UniqueImageColors</a>]</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="GetColorInfoList">GetColorInfoList</a></h2>
<div class="doc-section">
<p>GetColorInfoList() returns any colors that match the specified pattern.</p></ol>
<p>The format of the GetColorInfoList function is:</p>
<pre class="text">
const ColorInfo **GetColorInfoList(const char *pattern,
unsigned long *number_colors,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>pattern</h5>
<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
<h5>number_colors</h5>
<ol><p>This integer returns the number of colors in the list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="GetColorList">GetColorList</a></h2>
<div class="doc-section">
<p>GetColorList() returns any colors that match the specified pattern.</p></ol>
<p>The format of the GetColorList function is:</p>
<pre class="text">
char **GetColorList(const char *pattern,unsigned long *number_colors,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>pattern</h5>
<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
<h5>number_colors</h5>
<ol><p>This integer returns the number of colors in the list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="GetImageHistogram">GetImageHistogram</a></h2>
<div class="doc-section">
<p>GetImageHistogram() returns the unique colors in an image.</p></ol>
<p>The format of the GetImageHistogram method is:</p>
<pre class="code">
unsigned long GetImageHistogram(const Image *image,
unsigned long *number_colors,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>file</h5>
<ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="GetNumberColors">GetNumberColors</a></h2>
<div class="doc-section">
<p>GetNumberColors() returns the number of unique colors in an image.</p></ol>
<p>The format of the GetNumberColors method is:</p>
<pre class="code">
unsigned long GetNumberColors(const Image *image,FILE *file,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>file</h5>
<ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
<div class="doc-section">
<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
<p>The format of the IsGrayImage method is:</p>
<pre class="code">
MagickBooleanType IsGrayImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="IsHistogramImage">IsHistogramImage</a></h2>
<div class="doc-section">
<p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p></ol>
<p>The format of the IsHistogramImage method is:</p>
<pre class="code">
MagickBooleanType IsHistogramImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
<div class="doc-section">
<p>IsMonochromeImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities and the intensity is either 0 or QuantumRange.</p></ol>
<p>The format of the IsMonochromeImage method is:</p>
<pre class="code">
MagickBooleanType IsMonochromeImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
<div class="doc-section">
<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
<p>The format of the IsOpaqueImage method is:</p>
<pre class="code">
MagickBooleanType IsOpaqueImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="IsPaletteImage">IsPaletteImage</a></h2>
<div class="doc-section">
<p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p></ol>
<p>The format of the IsPaletteImage method is:</p>
<pre class="code">
MagickBooleanType IsPaletteImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="ListColorInfo">ListColorInfo</a></h2>
<div class="doc-section">
<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>
<p>The format of the ListColorInfo method is:</p>
<pre class="code">
MagickBooleanType ListColorInfo(FILE *file,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>file</h5>
<ol><p>List color names to this file handle.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="LoadColorList">LoadColorList</a></h2>
<div class="doc-section">
<p>LoadColorList() loads one or more color configuration file which provides a mapping between color attributes and a color name.</p></ol>
<p>The format of the LoadColorLists method is:</p>
<pre class="code">
MagickBooleanType LoadColorLists(const char *filename,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>filename</h5>
<ol><p>the font file name.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="QueryColorDatabase">QueryColorDatabase</a></h2>
<div class="doc-section">
<p>QueryColorDatabase() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
<p>The format of the QueryColorDatabase method is:</p>
<pre class="code">
MagickBooleanType QueryColorDatabase(const char *name,PixelPacket *color,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>name</h5>
<ol><p>the color name (e.g. white, blue, yellow).</p></ol>
<h5>color</h5>
<ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="QueryColorname">QueryColorname</a></h2>
<div class="doc-section">
<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>
<p>The format of the QueryColorname method is:</p>
<pre class="code">
MagickBooleanType QueryColorname(const Image *image,
const PixelPacket *color,const ComplianceType compliance,char *name,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>color</h5>
<ol><p>the color intensities.</p></ol>
<h5>compliance</h5>
<ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
<h5>name</h5>
<ol><p>Return the color name or hex value.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="QueryMagickColor">QueryMagickColor</a></h2>
<div class="doc-section">
<p>QueryMagickColor() returns the red, green, blue, and opacity intensities for a given color name.</p></ol>
<p>The format of the QueryMagickColor method is:</p>
<pre class="code">
MagickBooleanType QueryMagickColor(const char *name,
MagickPixelPacket *color,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>name</h5>
<ol><p>the color name (e.g. white, blue, yellow).</p></ol>
<h5>color</h5>
<ol><p>the red, green, blue, and opacity intensities values of the named color in this structure.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="QueryMagickColorname">QueryMagickColorname</a></h2>
<div class="doc-section">
<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>
<p>The format of the QueryMagickColorname method is:</p>
<pre class="code">
MagickBooleanType QueryMagickColorname(const Image *image,
const PixelPacket *color,const ComplianceType compliance,char *name,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>color</h5>
<ol><p>the color intensities.</p></ol>
<h5>Compliance</h5>
<ol><p>Adhere to this color standard: SVG, X11, or XPM.</p></ol>
<h5>name</h5>
<ol><p>Return the color name or hex value.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/color
_8c.html" target="source" name="UniqueImageColors">UniqueImageColors</a></h2>
<div class="doc-section">
<p>UniqueImageColors() returns the unique colors of an image.</p></ol>
<p>The format of the UniqueImageColors method is:</p>
<pre class="code">
Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
</div>
<div id="linkbar">
<!-- <span id="linkbar-west">&nbsp;</span> -->
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
<a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
<a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>