blob: 6994542045ab1a88827e596a0e05fdb56d169c1b [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +00003<head>
cristy44443b92015-05-05 00:06:07 +00004 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Colormap Methods</title>
cristy44443b92015-05-05 00:06:07 +00008 <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. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
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:, colormap, methods, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
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-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
25 <link rel="icon" href="../../images/wand.png">
26 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="css/bootstrap.min.css">
28 <link rel="stylesheet" href="css/magick.css">
cristy06f63f22012-10-31 00:50:07 +000029</head>
30
cristy44443b92015-05-05 00:06:07 +000031<body>
cristy06f63f22012-10-31 00:50:07 +000032<div class="main">
cristy44443b92015-05-05 00:06:07 +000033<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
46 <a class="magick-nav-item " href="../../index.html">Home</a>
47 <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../../www/api.html">Development</a>
51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
53 </nav>
54 </div>
55</div>
56<div class="container">
57<p class="text-center"><a href="colormap.html#AcquireImageColormap">AcquireImageColormap</a><a href="colormap.html#CycleColormap">CycleColormap</a></p>
cristy06f63f22012-10-31 00:50:07 +000058
cristy44443b92015-05-05 00:06:07 +000059<div class="magick-header">
cristy20398432011-08-11 01:31:50 +000060<h2><a href="http://www.imagemagick.org/api/MagickCore/colormap_8c.html" id="AcquireImageColormap">AcquireImageColormap</a></h2>
cristy20398432011-08-11 01:31:50 +000061
62<p>AcquireImageColormap() allocates an image colormap and initializes it to a linear gray colorspace. If the image already has a colormap, it is replaced. AcquireImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p>
63
64<p>The format of the AcquireImageColormap method is:</p>
65
cristy44443b92015-05-05 00:06:07 +000066<pre class="text">
67MagickBooleanType AcquireImageColormap(Image *image,const size_t colors,
68 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +000069</pre>
70
71<p>A description of each parameter follows:</p>
72
cristy44443b92015-05-05 00:06:07 +000073<dd>
74</dd>
cristy20398432011-08-11 01:31:50 +000075
cristy44443b92015-05-05 00:06:07 +000076<dd> </dd>
77<dl class="dl-horizontal">
78<dt>image</dt>
79<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +000080
cristy44443b92015-05-05 00:06:07 +000081<dd> </dd>
82<dt>colors</dt>
83<dd>the number of colors in the image colormap. </dd>
84
85<dd> </dd>
86<dt>exception</dt>
87<dd>return any errors or warnings in this structure. </dd>
88
89<dd> </dd>
90</dl>
cristy20398432011-08-11 01:31:50 +000091<h2><a href="http://www.imagemagick.org/api/MagickCore/colormap_8c.html" id="CycleColormap">CycleColormap</a></h2>
cristy20398432011-08-11 01:31:50 +000092
93<p>CycleColormap() displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychodelic effect.</p>
94
cristy44443b92015-05-05 00:06:07 +000095<p>WARNING: this assumes an images colormap is in a well know and defined order. Currently Imagemagick has no way of setting that order.</p>
96
cristy20398432011-08-11 01:31:50 +000097<p>The format of the CycleColormapImage method is:</p>
98
cristy44443b92015-05-05 00:06:07 +000099<pre class="text">
100MagickBooleanType CycleColormapImage(Image *image,const ssize_t displace,
101 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000102</pre>
103
104<p>A description of each parameter follows:</p>
105
cristy44443b92015-05-05 00:06:07 +0000106<dd>
107</dd>
cristy20398432011-08-11 01:31:50 +0000108
cristy44443b92015-05-05 00:06:07 +0000109<dd> </dd>
110<dl class="dl-horizontal">
111<dt>image</dt>
112<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000113
cristy44443b92015-05-05 00:06:07 +0000114<dd> </dd>
115<dt>displace</dt>
116<dd> displace the colormap this amount. </dd>
cristy06f63f22012-10-31 00:50:07 +0000117
cristy44443b92015-05-05 00:06:07 +0000118<dd> </dd>
119<dt>exception</dt>
120<dd>return any errors or warnings in this structure. </dd>
121
122<dd> </dd>
123</dl>
cristy06f63f22012-10-31 00:50:07 +0000124</div>
cristy44443b92015-05-05 00:06:07 +0000125 <footer class="magick-footer">
126 <div class="magick-nav-item navbar-left">
127 <a href="../../www/support.html">Donations</a>
128 </div>
129 <div class="magick-nav-item navbar-right">
130 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
131 <noscript>
132 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
133 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
134 </noscript>
135 </div>
136 <p><a href="../../www/sitemap.html">Sitemap</a>
137 <a href="../../www/links.html">Related</a>
138 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a>
139 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
140 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
141</p>
142 <p><a href="colormap.html#">Back to top</a>
143 <a href="../../www/contact.html">Contact Us</a></p>
144 </footer>
145</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000146
cristy44443b92015-05-05 00:06:07 +0000147 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
148 <script src="../../js/bootstrap.min.js"></script>
149 <script type="text/javascript">
150 /* */
151 (function() {
152 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
153 s.type = 'text/javascript';
154 s.async = true;
155 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
156 t.parentNode.insertBefore(s, t);
157 })();
158 /* */
159 </script>
cristy44cbd482013-08-04 20:53:36 +0000160</div>
cristy06f63f22012-10-31 00:50:07 +0000161</body>
cristy5a367e42015-05-05 12:39:18 +0000162</html>