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" dir="ltr">
\r
5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
8 <style type="text/css" media="all">
\r
9 @import url("../../www/magick.css");
\r
11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <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"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
29 <body id="www-imagemagick-org">
\r
30 <div class="titlebar">
\r
31 <a href="../../index.html">
\r
32 <img src="../../images/script.png" alt="[ImageMagick]"
\r
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
34 <a href="http://www.networkredux.com">
\r
35 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
37 <a href="http://www.imagemagick.org/discourse-server/">
\r
38 <img src="../../images/logo.jpg" alt=""
\r
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
40 <a href="../../index.html">
\r
41 <img src="../../images/sprite.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
45 <div class="eastbar">
\r
48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
55 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
58 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
61 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
64 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
67 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
70 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
73 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
76 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
79 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
81 <div class="sep"></div>
\r
83 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
86 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
89 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
92 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
95 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
98 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
101 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
104 <a title="Resources" href="../../www/resources.html">Resources</a>
106 <div class="sep"></div>
\r
108 <a title="Download" href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
129 <div class="sponsor">
130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
132 <div class="sponsor">
133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135 <div class="sponsor">
136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
144 <div class="sponsor">
145 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
155 <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>
157 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
158 _8c.html" target="source" name="ConstituteImage">ConstituteImage</a></h2>
159 <div class="doc-section">
161 <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>
164 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
167 <p>The format of the ConstituteImage method is:</p>
170 Image *ConstituteImage(const unsigned long columns,
171 const unsigned long rows,const char *map,const StorageType storage,
172 const void *pixels,ExceptionInfo *exception)
175 <p>A description of each parameter follows:</p></ol>
178 <ol><p>width in pixels of the image.</p></ol>
181 <ol><p>height in pixels of the image.</p></ol>
184 <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>
187 <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>
190 <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>
193 <ol><p>return any errors or warnings in this structure.</p></ol>
196 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
197 _8c.html" target="source" name="PingImage">PingImage</a></h2>
198 <div class="doc-section">
200 <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>
202 <p>The format of the PingImage method is:</p>
205 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
208 <p>A description of each parameter follows:</p></ol>
211 <ol><p>Ping the image defined by the file or filename members of this structure.</p></ol>
214 <ol><p>return any errors or warnings in this structure.</p></ol>
217 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
218 _8c.html" target="source" name="PingImages">PingImages</a></h2>
219 <div class="doc-section">
221 <p>PingImages() pings one or more images and returns them as an image list.</p></ol>
223 <p>The format of the PingImage method is:</p>
226 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
229 <p>A description of each parameter follows:</p></ol>
232 <ol><p>the image info.</p></ol>
235 <ol><p>return any errors or warnings in this structure.</p></ol>
238 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
239 _8c.html" target="source" name="ReadImage">ReadImage</a></h2>
240 <div class="doc-section">
242 <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>
244 <p>The format of the ReadImage method is:</p>
247 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
250 <p>A description of each parameter follows:</p></ol>
253 <ol><p>Read the image defined by the file or filename members of this structure.</p></ol>
256 <ol><p>return any errors or warnings in this structure.</p></ol>
259 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
260 _8c.html" target="source" name="ReadImages">ReadImages</a></h2>
261 <div class="doc-section">
263 <p>ReadImages() reads one or more images and returns them as an image list.</p></ol>
265 <p>The format of the ReadImage method is:</p>
268 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
271 <p>A description of each parameter follows:</p></ol>
274 <ol><p>the image info.</p></ol>
277 <ol><p>return any errors or warnings in this structure.</p></ol>
280 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
281 _8c.html" target="source" name="WriteImage">WriteImage</a></h2>
282 <div class="doc-section">
284 <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>
286 <p>The format of the WriteImage method is:</p>
289 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
292 <p>A description of each parameter follows:</p></ol>
295 <ol><p>the image info.</p></ol>
298 <ol><p>the image.</p></ol>
301 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
302 _8c.html" target="source" name="WriteImages">WriteImages</a></h2>
303 <div class="doc-section">
305 <p>WriteImages() writes an image sequence.</p></ol>
307 <p>The format of the WriteImages method is:</p>
310 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
311 const char *filename,ExceptionInfo *exception)
314 <p>A description of each parameter follows:</p></ol>
317 <ol><p>the image info.</p></ol>
320 <ol><p>the image list.</p></ol>
323 <ol><p>the image filename.</p></ol>
326 <ol><p>return any errors or warnings in this structure.</p></ol>
333 <!-- <span id="linkbar-west"> </span> -->
\r
334 <span id="linkbar-center">
\r
335 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</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-2010 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