Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 7a40ba8d8dae1086103297305d7cd8825ea59fa9 / . / www / api / constitute.html
blob: c0619b6561424866cb5979aa6ed892ec514d8788 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, constitute, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
53 style="margin: 45px auto; border: 0px; float: left;" /></a>
54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
56 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]143<div class="sponsor">
144 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]145</div>
146<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]156 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]157</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158</div>
159</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]174</div>
175
176<div class="main">
177
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]178<h1>Module constitute
179 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]180<p class="navigation-index">[<a href="#ConstituteImage">ConstituteImage</a> &bull; <a href="#PingImage">PingImage</a> &bull; <a href="#PingImages">PingImages</a> &bull; <a href="#ReadImage">ReadImage</a> &bull; <a href="#ReadImages">ReadImages</a> &bull; <a href="#WriteImage">WriteImage</a> &bull; <a href="#WriteImages">WriteImages</a>]</p>
181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]182<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
183_8c.html" id="ConstituteImage">ConstituteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184<div class="doc-section">
185
186<p>ConstituteImage() returns an image from the pixel data you supply. The pixel data must be in scanline order top-to-bottom. The data can be char, short int, int, float, or double. Float and double require the pixels to be normalized [0..1], otherwise [0..QuantumRange]. For example, to create a 640x480 image from unsigned red-green-blue character data, use:</p>
187
188<pre class="text">
189 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
190</pre>
191
192<p>The format of the ConstituteImage method is:</p>
193
194<pre class="code">
cristyeaedf062010-05-29 22:36:02 +0000[diff] [blame]195 Image *ConstituteImage(const size_t columns,const size_t rows,
196 const char *map,const StorageType storage,const void *pixels,
197 ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198</pre>
199
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]200<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201
202<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]203<p>width in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]204
205<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]206<p>height in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]207
208<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]209<p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]210
211<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]212<p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213
214<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]215<p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
217<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]218<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]221<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
222_8c.html" id="PingImage">PingImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]223<div class="doc-section">
224
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]225<p>PingImage() returns all the properties of an image or image sequence except for the pixels. It is much faster and consumes far less memory than ReadImage(). On failure, a NULL image is returned and exception describes the reason for the failure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]226
227<p>The format of the PingImage method is:</p>
228
229<pre class="code">
230 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
231</pre>
232
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]233<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234
235<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]236<p>Ping the image defined by the file or filename members of this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]239<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240
241 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]242<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
243_8c.html" id="PingImages">PingImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]244<div class="doc-section">
245
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]246<p>PingImages() pings one or more images and returns them as an image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]247
248<p>The format of the PingImage method is:</p>
249
250<pre class="code">
251 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
252</pre>
253
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]254<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255
256<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]257<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258
259<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]260<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]261
262 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]263<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
264_8c.html" id="ReadImage">ReadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]265<div class="doc-section">
266
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]267<p>ReadImage() reads an image or image sequence from a file or file handle. The method returns a NULL if there is a memory shortage or if the image cannot be read. On failure, a NULL image is returned and exception describes the reason for the failure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]268
269<p>The format of the ReadImage method is:</p>
270
271<pre class="code">
272 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
273</pre>
274
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]275<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276
277<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]278<p>Read the image defined by the file or filename members of this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]279
280<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]281<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]282
283 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]284<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
285_8c.html" id="ReadImages">ReadImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]286<div class="doc-section">
287
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]288<p>ReadImages() reads one or more images and returns them as an image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]289
290<p>The format of the ReadImage method is:</p>
291
292<pre class="code">
293 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
294</pre>
295
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]296<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]297
298<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]299<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]300
301<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]302<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]303
304 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]305<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
306_8c.html" id="WriteImage">WriteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]307<div class="doc-section">
308
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]309<p>WriteImage() writes an image or an image sequence to a file or filehandle. If writing to a file on disk, the name is defined by the filename member of the image structure. Write() returns MagickFalse is these is a memory shortage or if the image cannot be written. Check the exception member of image to determine the cause for any failure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]310
311<p>The format of the WriteImage method is:</p>
312
313<pre class="code">
314 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
315</pre>
316
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]317<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]318
319<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]320<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]321
322<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]323<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324
325 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]326<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
327_8c.html" id="WriteImages">WriteImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]328<div class="doc-section">
329
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]330<p>WriteImages() writes an image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]331
332<p>The format of the WriteImages method is:</p>
333
334<pre class="code">
335 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
336 const char *filename,ExceptionInfo *exception)
337</pre>
338
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]339<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]340
341<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]342<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]343
344<h5>images</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]345<p>the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]346
347<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]348<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349
350<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame^]351<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]352
353 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]354
355</div>
356
357<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]358 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]359 <span id="linkbar-center">
360 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]361 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]362 </span>
363 <span id="linkbar-east">&nbsp;</span>
364 </div>
365 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]366 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]367 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
368 </div>
369 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]370 <script type="text/javascript">
371 var _gaq = _gaq || [];
372 _gaq.push(['_setAccount', 'UA-17690367-1']);
373 _gaq.push(['_trackPageview']);
374
375 (function() {
376 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
377 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
378 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
379 })();
380 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]381</body>
382</html>