Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / eed6cb663d33342848fce694ad45fe2db637547f / . / www / api / constitute.html
blob: 6741f51ec07d91407c36829c272851bc7c684ac4 [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">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]10 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]16 <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 automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]19 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, constitute, an, image, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy1454be72011-12-19 01:52:48 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]32 <!-- Add jQuery library -->
33 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
34
35 <!-- Optionaly include easing and/or mousewheel plugins -->
36 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
37 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
38
39 <!-- Add fancyBox -->
40 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.3" type="text/css" media="screen" />
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.3"></script>
42
43 <!-- Optionaly include button and/or thumbnail helpers -->
44 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.3" type="text/css" media="screen" />
45 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.3"></script>
46
47 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.3" type="text/css" media="screen" />
48 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.3"></script>
49 <script type="text/javascript">
50 $(document).ready(function() {
51 $(".fancybox").fancybox();
52 });
53 </script>
54 <!-- ImageMagick style -->
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]55 <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]56 <style type="text/css" media="all">
57 @import url("../../www/magick.css");
58 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]59</head>
60
61<body id="www-imagemagick-org">
62<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]63<div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
65 <!--
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
70 //-->
71 </script>
72 <script type="text/javascript"
73 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
74 </script>
75</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]77 <img src="../../images/logo.jpg"
78 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]79 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]81 <img src="../../images/sprite.jpg"
82 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]83 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
84</div>
85
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]86<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]87
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]92 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]101 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]102</div>
103<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
105</div>
106<div class="sep"></div>
107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]114 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]117 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
125<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]132 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]134<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]135<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
138<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
141<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143 </div>
144<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]147<div class="menu">
148 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]151 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]155 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]157<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]159 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]160</div>
161<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]162 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164<div class="sep"></div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]165<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]166 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]167
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]168 <a href="http://www.networkredux.com"> <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
169 <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201204010120 mickey@163... -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<div class="sponsbox">
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]171<div class="sponsor">
172 <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201204010120 mickey@163... -->
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]173</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]174<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]175 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]176</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]177<div class="sponsor">
178 <a rel="follow" title="Sponsor: Autos Part" href="http://www.pkwteile.de/autoteile">Autos Part</a><!-- 201203010270 info@pkwte... -->
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]179</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]180<div class="sponsor">
181 <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]182</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]183<div class="sponsor">
184 <a rel="follow" title="Sponsor: Tenant Check" href="http://www.rentmethod.com/">Tenant Check</a><!-- 201203010090 chris@rentm... -->
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]185</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]186<div class="sponsor">
187 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201204010090 barsh@inter... -->
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]188</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]189<div class="sponsor">
190 <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
191</div>
192<div class="sponsor">
193 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201301010090s jen@seo lowprofilelinks -->
194</div>
195<div class="sponsor">
196 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
197</div>
198<div class="sponsor">
199 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
200</div>
201<div class="sponsor">
202 <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
203</div>
204<div class="sponsor">
205 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
206</div>
207<div class="sponsor">
208 <a rel="follow" title="Sponsor: Royalty Free Stock Images" href="http://www.canstockphoto.com/">Royalty Free Stock Images</a><!-- 2012050100360 support@can -->
209</div>
210<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]211 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
212</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]213<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]214 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]215</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]216<div class="sponsor">
217 <a rel="follow" title="Sponsor: Got Stripes" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012090100150 brooks@stripes...-->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]218</div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]219<div class="sponsor">
220 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingreviewz.com">Web Hosting Reviews</a><!-- 2012040100030 Soft Tec-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]221</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]222</div>
223</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]224</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]225
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]226<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]227 <div class="g-plusone" data-size="standard" data-count="false"></div>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]228 <script type="text/javascript">
229 window.___gcfg = {
230 lang: 'en-US'
231 };
232
233 (function() {
234 var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
235 po.src = 'https://apis.google.com/js/plusone.js';
236 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
237 })();
238 </script>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]239</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]240
241<div class="main">
242
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]243<h1>Module constitute Methods</h1>
244<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]246<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ConstituteImage">ConstituteImage</a></h2>
247<div class="doc-section">
248
249<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>
250
251<pre class="text">
252 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
253</pre>
254
255<p>The format of the ConstituteImage method is:</p>
256
257<pre class="code">
258 Image *ConstituteImage(const size_t columns,const size_t rows,
259 const char *map,const StorageType storage,const void *pixels,
260 ExceptionInfo *exception)
261</pre>
262
263<p>A description of each parameter follows:</p>
264
265<h5>columns</h5>
266<p>width in pixels of the image.</p>
267
268<h5>rows</h5>
269<p>height in pixels of the image.</p>
270
271<h5>map</h5>
272<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>
273
274<h5>storage</h5>
275<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>
276
277<h5>pixels</h5>
278<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>
279
280<h5>exception</h5>
281<p>return any errors or warnings in this structure.</p>
282
283 </div>
284<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImage">PingImage</a></h2>
285<div class="doc-section">
286
287<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>
288
289<p>The format of the PingImage method is:</p>
290
291<pre class="code">
292 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
293</pre>
294
295<p>A description of each parameter follows:</p>
296
297<h5>image_info</h5>
298<p>Ping the image defined by the file or filename members of this structure.</p>
299
300<h5>exception</h5>
301<p>return any errors or warnings in this structure.</p>
302
303 </div>
304<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImages">PingImages</a></h2>
305<div class="doc-section">
306
307<p>PingImages() pings one or more images and returns them as an image list.</p>
308
309<p>The format of the PingImage method is:</p>
310
311<pre class="code">
312 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
313</pre>
314
315<p>A description of each parameter follows:</p>
316
317<h5>image_info</h5>
318<p>the image info.</p>
319
320<h5>exception</h5>
321<p>return any errors or warnings in this structure.</p>
322
323 </div>
324<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImage">ReadImage</a></h2>
325<div class="doc-section">
326
327<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>
328
329<p>The format of the ReadImage method is:</p>
330
331<pre class="code">
332 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
333</pre>
334
335<p>A description of each parameter follows:</p>
336
337<h5>image_info</h5>
338<p>Read the image defined by the file or filename members of this structure.</p>
339
340<h5>exception</h5>
341<p>return any errors or warnings in this structure.</p>
342
343 </div>
344<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImages">ReadImages</a></h2>
345<div class="doc-section">
346
347<p>ReadImages() reads one or more images and returns them as an image list.</p>
348
349<p>The format of the ReadImage method is:</p>
350
351<pre class="code">
352 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
353</pre>
354
355<p>A description of each parameter follows:</p>
356
357<h5>image_info</h5>
358<p>the image info.</p>
359
360<h5>exception</h5>
361<p>return any errors or warnings in this structure.</p>
362
363 </div>
364<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImage">WriteImage</a></h2>
365<div class="doc-section">
366
367<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>
368
369<p>The format of the WriteImage method is:</p>
370
371<pre class="code">
372 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
373</pre>
374
375<p>A description of each parameter follows:</p>
376
377<h5>image_info</h5>
378<p>the image info.</p>
379
380<h5>image</h5>
381<p>the image.</p>
382
383 </div>
384<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImages">WriteImages</a></h2>
385<div class="doc-section">
386
387<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>
388
389<p>The format of the WriteImages method is:</p>
390
391<pre class="code">
392 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
393 const char *filename,ExceptionInfo *exception)
394</pre>
395
396<p>A description of each parameter follows:</p>
397
398<h5>image_info</h5>
399<p>the image info.</p>
400
401<h5>images</h5>
402<p>the image list.</p>
403
404<h5>filename</h5>
405<p>the image filename.</p>
406
407<h5>exception</h5>
408<p>return any errors or warnings in this structure.</p>
409
410 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]411
412</div>
413
414<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]415 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]416 <span id="linkbar-center">
417 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]418 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]419 </span>
420 <span id="linkbar-east">&nbsp;</span>
421 </div>
422 <div class="footer">
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame^]423 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]424 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
425 </div>
426 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]427 <script type="text/javascript">
428 var _gaq = _gaq || [];
429 _gaq.push(['_setAccount', 'UA-17690367-1']);
430 _gaq.push(['_trackPageview']);
431
432 (function() {
433 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
434 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
435 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
436 })();
437 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]438</body>
439</html>