1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
7 <style type="text/css" media="screen,projection"><!--
\r
8 @import url("../../www/magick.css");
\r
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
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"/>
15 <meta name="Generator" content="PHP"/>
16 <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"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
28 <body id="www-imagemagick-org">
\r
29 <div class="titlebar">
\r
30 <a href="../../index.html">
\r
31 <img src="../../images/script.png" alt="[ImageMagick]"
\r
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
33 <a href="http://www.networkredux.com">
\r
34 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
36 <a href="http://www.imagemagick.org/discourse-server/">
\r
37 <img src="../../images/logo.jpg" alt=""
\r
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
39 <a href="../../index.html">
\r
40 <img src="../../images/sprite.jpg" alt=""
\r
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
44 <div class="eastbar">
\r
47 <a href="../../index.html">About ImageMagick</a>
49 <div class="sep"></div>
\r
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
54 <a href="../../www/command-line-processing.html">Processing</a>
57 <a href="../../www/command-line-options.html">Options</a>
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
63 <a href="../../www/api.html">Program Interfaces</a>
66 <a href="../../www/magick-wand.html">MagickWand</a>
69 <a href="../../www/magick-core.html">MagickCore</a>
72 <a href="../../www/perl-magick.html">PerlMagick</a>
75 <a href="../../Magick++/">Magick++</a>
78 <a href="../../www/architecture.html">Architecture</a>
80 <div class="sep"></div>
\r
82 <a href="../../www/install-source.html">Install from Source</a>
85 <a href="../../www/install-source.html#unix">Unix</a>
88 <a href="../../www/install-source.html#windows">Windows</a>
91 <a href="../../www/binary-releases.html">Binary Releases</a>
94 <a href="../../www/binary-releases.html#unix">Unix</a>
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
100 <a href="../../www/binary-releases.html#windows">Windows</a>
103 <a href="../../www/resources.html">Resources</a>
105 <div class="sep"></div>
\r
107 <a href="../../www/download.html">Download</a>
109 <div class="sep"></div>
\r
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113 <div class="sep"></div>
\r
115 <a href="../../www/sitemap.html">Site Map</a>
118 <a href="../../www/links.html">Links</a>
120 <div class="sep"></div>
\r
122 <a href="../../www/sponsors.html">Sponsors:</a>
124 <div class="sponsbox">
125 <div class="sponsor">
126 <a href="http://www.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
128 <div class="sponsor">
129 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
131 <div class="sponsor">
132 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
134 <div class="sponsor">
135 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
137 <div class="sponsor">
138 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
140 <div class="sponsor">
141 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
143 <div class="sponsor">
144 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
154 <p class="navigation-index">[<a href="#ConstituteImage">ConstituteImage</a> • <a href="#PingImage">PingImage</a> • <a href="#PingImages">PingImages</a> • <a href="#ReadImage">ReadImage</a> • <a href="#ReadImages">ReadImages</a> • <a href="#WriteImage">WriteImage</a> • <a href="#WriteImages">WriteImages</a>]</p>
156 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
157 _8c.html" target="source" name="ConstituteImage">ConstituteImage</a></h2>
158 <div class="doc-section">
160 <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>
163 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
166 <p>The format of the ConstituteImage method is:</p>
169 Image *ConstituteImage(const unsigned long columns,
170 const unsigned long rows,const char *map,const StorageType storage,
171 const void *pixels,ExceptionInfo *exception)
174 <p>A description of each parameter follows:</p></ol>
177 <ol><p>width in pixels of the image.</p></ol>
180 <ol><p>height in pixels of the image.</p></ol>
183 <ol><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></ol>
186 <ol><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></ol>
189 <ol><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></ol>
192 <ol><p>return any errors or warnings in this structure.</p></ol>
195 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
196 _8c.html" target="source" name="PingImage">PingImage</a></h2>
197 <div class="doc-section">
199 <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></ol>
201 <p>The format of the PingImage method is:</p>
204 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
207 <p>A description of each parameter follows:</p></ol>
210 <ol><p>Ping the image defined by the file or filename members of this structure.</p></ol>
213 <ol><p>return any errors or warnings in this structure.</p></ol>
216 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
217 _8c.html" target="source" name="PingImages">PingImages</a></h2>
218 <div class="doc-section">
220 <p>PingImages() pings one or more images and returns them as an image list.</p></ol>
222 <p>The format of the PingImage method is:</p>
225 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
228 <p>A description of each parameter follows:</p></ol>
231 <ol><p>the image info.</p></ol>
234 <ol><p>return any errors or warnings in this structure.</p></ol>
237 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
238 _8c.html" target="source" name="ReadImage">ReadImage</a></h2>
239 <div class="doc-section">
241 <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></ol>
243 <p>The format of the ReadImage method is:</p>
246 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
249 <p>A description of each parameter follows:</p></ol>
252 <ol><p>Read the image defined by the file or filename members of this structure.</p></ol>
255 <ol><p>return any errors or warnings in this structure.</p></ol>
258 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
259 _8c.html" target="source" name="ReadImages">ReadImages</a></h2>
260 <div class="doc-section">
262 <p>ReadImages() reads one or more images and returns them as an image list.</p></ol>
264 <p>The format of the ReadImage method is:</p>
267 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
270 <p>A description of each parameter follows:</p></ol>
273 <ol><p>the image info.</p></ol>
276 <ol><p>return any errors or warnings in this structure.</p></ol>
279 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
280 _8c.html" target="source" name="WriteImage">WriteImage</a></h2>
281 <div class="doc-section">
283 <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></ol>
285 <p>The format of the WriteImage method is:</p>
288 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
291 <p>A description of each parameter follows:</p></ol>
294 <ol><p>the image info.</p></ol>
297 <ol><p>the image.</p></ol>
300 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
301 _8c.html" target="source" name="WriteImages">WriteImages</a></h2>
302 <div class="doc-section">
304 <p>WriteImages() writes an image sequence.</p></ol>
306 <p>The format of the WriteImages method is:</p>
309 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
310 const char *filename,ExceptionInfo *exception)
313 <p>A description of each parameter follows:</p></ol>
316 <ol><p>the image info.</p></ol>
319 <ol><p>the image list.</p></ol>
322 <ol><p>the image filename.</p></ol>
325 <ol><p>return any errors or warnings in this structure.</p></ol>
332 <!-- <span id="linkbar-west"> </span> -->
\r
333 <span id="linkbar-center">
\r
334 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
335 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
336 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
338 <span id="linkbar-east"> </span>
\r
340 <div class="footer">
\r
341 <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
\r
342 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
344 <div style="clear: both; margin: 0; width: 100%; "></div>
\r