Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / af8d6655e12345c48d687558c0665070d206a942 / . / www / api / constitute.html
blob: fd124f0306aaa47cc3759e8f7bf3a2309201211b [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"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]12 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, 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]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]55 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]57 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]59 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]61 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]64<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]71 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
78</div>
79<div class="sub">
80 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
81</div>
82<div class="sep"></div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]138 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]146 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
149 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
150</div>
151<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]158 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
159</div>
160<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000[diff] [blame]167 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]168</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169</div>
170</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]172
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177 google_ad_slot = "0574824969";
178 google_ad_width = 160;
179 google_ad_height = 600;
180 //-->
181 </script>
182 <script type="text/javascript"
183 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
184 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]189<h1>Module constitute
190 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]191<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>
192
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]193<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
194_8c.html" id="ConstituteImage">ConstituteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195<div class="doc-section">
196
197<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>
198
199<pre class="text">
200 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
201</pre>
202
203<p>The format of the ConstituteImage method is:</p>
204
205<pre class="code">
cristyeaedf062010-05-29 22:36:02 +0000[diff] [blame]206 Image *ConstituteImage(const size_t columns,const size_t rows,
207 const char *map,const StorageType storage,const void *pixels,
208 ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209</pre>
210
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]211<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]214<p>width in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]215
216<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]217<p>height in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]218
219<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]220<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]221
222<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]223<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]224
225<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]226<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]227
228<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]229<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]230
231 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]232<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
233_8c.html" id="PingImage">PingImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234<div class="doc-section">
235
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<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]237
238<p>The format of the PingImage method is:</p>
239
240<pre class="code">
241 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
242</pre>
243
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]244<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
246<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]247<p>Ping the image defined by the file or filename members of this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]248
249<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]250<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]251
252 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]253<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
254_8c.html" id="PingImages">PingImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255<div class="doc-section">
256
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<p>PingImages() pings one or more images and returns them as an image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258
259<p>The format of the PingImage method is:</p>
260
261<pre class="code">
262 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
263</pre>
264
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]265<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]266
267<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]268<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]269
270<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]271<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]272
273 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]274<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
275_8c.html" id="ReadImage">ReadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276<div class="doc-section">
277
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]278<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]279
280<p>The format of the ReadImage method is:</p>
281
282<pre class="code">
283 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
284</pre>
285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]286<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]287
288<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]289<p>Read the image defined by the file or filename members of this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]290
291<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]292<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293
294 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]295<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
296_8c.html" id="ReadImages">ReadImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]297<div class="doc-section">
298
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]299<p>ReadImages() reads one or more images and returns them as an image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]300
301<p>The format of the ReadImage method is:</p>
302
303<pre class="code">
304 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
305</pre>
306
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]307<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308
309<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]310<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311
312<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]313<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314
315 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]316<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
317_8c.html" id="WriteImage">WriteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]318<div class="doc-section">
319
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]320<p>WriteImage() writes an image or an image sequence to a file or file handle. If writing to a file is on disk, the name is defined by the filename member of the image structure. WriteImage() returns MagickFalse is there 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]321
322<p>The format of the WriteImage method is:</p>
323
324<pre class="code">
325 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
326</pre>
327
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]328<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329
330<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]331<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]332
333<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]334<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335
336 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
338_8c.html" id="WriteImages">WriteImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]339<div class="doc-section">
340
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]341<p>WriteImages() writes an image sequence into one or more files. While WriteImage() can write an image sequence, it is limited to writing the sequence into a single file using a format which supports multiple frames. WriteImages(), however, does not have this limitation, instead it generates multiple output files if necessary (or when requested). When ImageInfo's adjoin flag is set to MagickFalse, the file name is expected to include a printf-style formatting string for the frame number (e.g. "image02d.png").</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]342
343<p>The format of the WriteImages method is:</p>
344
345<pre class="code">
346 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
347 const char *filename,ExceptionInfo *exception)
348</pre>
349
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]350<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]351
352<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]353<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354
355<h5>images</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]356<p>the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]357
358<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]359<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]360
361<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]362<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]363
364 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]365
366</div>
367
368<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]369 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]370 <span id="linkbar-center">
371 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]372 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]373 </span>
374 <span id="linkbar-east">&nbsp;</span>
375 </div>
376 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]377 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]378 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
379 </div>
380 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]381 <script type="text/javascript">
382 var _gaq = _gaq || [];
383 _gaq.push(['_setAccount', 'UA-17690367-1']);
384 _gaq.push(['_trackPageview']);
385
386 (function() {
387 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
388 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
389 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
390 })();
391 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]392</body>
393</html>