<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
//--></style>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<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."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2008 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
</head>
<body id="www-imagemagick-org">
<table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
<tbody>
<tr valign="top">
<td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="350" height="60" border="0" vspace="28" name="titlebar-west"/></a></td>
<td align="left"><a href="https://secure.networkredux.com/affiliate/idevaffiliate.html?id=146" target="1744960231"><img id="titlebar-west" src="../../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
<td width="99%"><br /> </td>
<td style="background-color: white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
<td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="161516388"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
</tr>
</tbody>
</table>
<table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tbody>
<tr valign="top" style="height: 100%;">
<td id="menu" width="1%" height="100%">
<p><a href="#main">Skip to page contents</a></p>
<font size="-1">
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<span>]</span><br /><span>[</span>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/command-line-processing.html" class="sub">Processing</a>
<a href="../../www/command-line-options.html" class="sub">Options</a>
<a href="http://www.imagemagick.org/Usage/" target="245877245" class="sub">Usage</a>
<a href="../../www/api.html">Program Interfaces</a>
<a href="../../www/magick-wand.html" class="sub">MagickWand</a>
<a href="../../www/magick-core.html" class="sub">MagickCore</a>
<a href="../../www/perl-magick.html" class="sub">PerlMagick</a>
<a href="../../Magick++/" target="1435541230" class="sub">Magick++</a>
<a href="../../www/architecture.html">Architecture</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/install-source.html#unix" class="sub">Unix</a>
<a href="../../www/install-source.html#windows" class="sub">Windows</a>
<a href="../../www/binary-releases.html">Binary Releases</a>
<a href="../../www/binary-releases.html#unix" class="sub">Unix</a>
<a href="../../www/binary-releases.html#macosx" class="sub">Mac OS X</a>
<a href="../../www/binary-releases.html#windows" class="sub">Windows</a>
<a href="../../www/resources.html">Resources</a>
<span>]</span><br /><span>[</span>
<a href="../../www/download.html">Download</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sitemap.html">Site Map</a>
<a href="../../www/links.html" class="sub">Links</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors:</a>
<fieldset>
<a href="http://www.fosstools.org/" class="sponsor" target="sponsor">Foss Tools</a><!-- 200803010000 -->
<br />
<a href="http://business-directory.com"><img src="../../images/business+directory.gif" alt="[Business + Directory]" width="105" height="60" border="0" name="business+directory"/></a> <!-- 200808010160 -->
<br />
<a href="http://analogik.com"><img src="../../images/analogik.png" alt="[Electronic Music]" width="105" height="60" border="0" name="analogik"/></a> <!-- 200804030160 -->
</fieldset>
<span>]</span>
</font>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#ConstituteImage">ConstituteImage</a> | <a href="#PingImage">PingImage</a> | <a href="#ReadImage">ReadImage</a> | <a href="#WriteImage">WriteImage</a> | <a href="#WriteImages">WriteImages</a> ]</p>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/constitute.c
?view=markup" target="source" name="ConstituteImage">ConstituteImage</a></h2>
</div>
<p>ConstituteImage() returns an image from the 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>
<pre class="text">
image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
</pre>
<p>The format of the ConstituteImage method is:</p>
<pre class="code">
Image *ConstituteImage(const unsigned long columns,
const unsigned long rows,const char *map,const StorageType storage,
const void *pixels,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>columns</h5>
<ol><p>width in pixels of the image.</p></ol>
<h5>rows</h5>
<ol><p>height in pixels of the image.</p></ol>
<h5>map</h5>
<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>
<h5>storage</h5>
<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>
<h5>pixels</h5>
<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>
<h5>exception</h5>
<ol><p>Return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/constitute.c
?view=markup" target="source" name="PingImage">PingImage</a></h2>
</div>
<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>
<p>The format of the PingImage method is:</p>
<pre class="code">
Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>Ping the image defined by the file or filename members of this structure.</p></ol>
<h5>exception</h5>
<ol><p>Return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/constitute.c
?view=markup" target="source" name="ReadImage">ReadImage</a></h2>
</div>
<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>
<p>The format of the ReadImage method is:</p>
<pre class="code">
Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>Read the image defined by the file or filename members of this structure.</p></ol>
<h5>exception</h5>
<ol><p>Return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/constitute.c
?view=markup" target="source" name="WriteImage">WriteImage</a></h2>
</div>
<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>
<p>The format of the WriteImage method is:</p>
<pre class="code">
MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>the image info.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/constitute.c
?view=markup" target="source" name="WriteImages">WriteImages</a></h2>
</div>
<p>WriteImages() writes an image sequence.</p></ol>
<p>The format of the WriteImages method is:</p>
<pre class="code">
MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
const char *filename,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>the image info.</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>filename</h5>
<ol><p>the image filename.</p></ol>
<h5>exception</h5>
<ol><p>Return any errors or warnings in this structure.</p></ol>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<a href="http://www.imagemagick.org/discourse-server/" target="1670907634">Discourse Server</a> •
<a href="../../www/mailing-list.html">Mailing Lists</a> •
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="1118132401">ImageMagick Studio</a>
</div>
<div id="footer">
<span id="footer-west">© 1999-2008 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>
