cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 3 | <head> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 4 | <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta> |
| 5 | <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta> |
cristy | ffb69ed | 2010-12-25 00:06:48 +0000 | [diff] [blame] | 6 | <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 7 | <meta http-equiv="content-language" content="en-US"></meta> |
| 8 | <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta> |
| 9 | <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta> |
| 10 | <meta name="application-name" content="ImageMagick"></meta> |
| 11 | <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta> |
| 12 | <meta name="application-url" content="http://www.imagemagick.org"></meta> |
| 13 | <meta name="generator" content="PHP"></meta> |
| 14 | <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"></meta> |
| 15 | <meta name="rating" content="GENERAL"></meta> |
| 16 | <meta name="robots" content="INDEX, FOLLOW"></meta> |
| 17 | <meta name="generator" content="ImageMagick Studio LLC"></meta> |
| 18 | <meta name="author" content="ImageMagick Studio LLC"></meta> |
| 19 | <meta name="revisit-after" content="2 DAYS"></meta> |
| 20 | <meta name="resource-type" content="document"></meta> |
| 21 | <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta> |
| 22 | <meta name="distribution" content="Global"></meta> |
| 23 | <link rel="icon" href="../../images/wand.png"></link> |
| 24 | <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link> |
| 25 | <link rel="canonical" href="../../index.html"></link> |
| 26 | <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 27 | |
| 28 | <!-- Add jQuery library --> |
| 29 | <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script> |
| 30 | |
| 31 | <!-- Add mousewheel plugin (this is optional) --> |
| 32 | <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script> |
| 33 | |
| 34 | <!-- Add fancyBox --> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 35 | <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 36 | <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script> |
| 37 | |
| 38 | <!-- Optionally add helpers - button, thumbnail and/or media --> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 39 | <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 40 | <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script> |
| 41 | <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script> |
| 42 | |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 43 | <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 44 | <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script> |
| 45 | |
cristy | 72da67d | 2013-02-24 21:40:48 +0000 | [diff] [blame] | 46 | <script type="text/javascript"> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 47 | $(document).ready(function() { |
| 48 | $(".fancybox").fancybox(); |
| 49 | }); |
cristy | 72da67d | 2013-02-24 21:40:48 +0000 | [diff] [blame] | 50 | </script> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 51 | |
| 52 | <!-- ImageMagick style --> |
| 53 | <style type="text/css" media="all"> |
| 54 | @import url("../../www/magick.css"); |
| 55 | </style> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 56 | </head> |
| 57 | |
| 58 | <body id="www-imagemagick-org"> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 59 | |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 60 | |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 61 | |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 62 | <div class="titlebar"> |
| 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> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 72 | |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 73 | </div> |
cristy | 417eeb1 | 2013-07-28 18:48:22 +0000 | [diff] [blame] | 74 | <a href="../../discourse-server"> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 75 | <img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 76 | <a href="../../index.html"> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 77 | <img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 78 | </div> |
| 79 | |
| 80 | <div class="westbar"> |
| 81 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 82 | <div class="menu"> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 83 | <a title="About ImageMagick" href="../../index.html">About ImageMagick</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 84 | </div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 85 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 86 | <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 87 | </div> |
| 88 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 89 | <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 90 | </div> |
| 91 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 92 | <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 93 | </div> |
| 94 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 95 | <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a> |
cristy | da16f16 | 2011-02-19 23:52:17 +0000 | [diff] [blame] | 96 | </div> |
| 97 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 98 | <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 99 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 100 | <div class="sep"></div> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 101 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 102 | <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 103 | </div> |
| 104 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 105 | <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 106 | </div> |
| 107 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 108 | <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 109 | </div> |
| 110 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 111 | <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 112 | </div> |
| 113 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 114 | <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 115 | </div> |
| 116 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 117 | <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 118 | </div> |
| 119 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 120 | <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 121 | </div> |
| 122 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 123 | <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 124 | </div> |
| 125 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 126 | <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 127 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 128 | <div class="sep"></div> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 129 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 130 | <a title="Install from Source" href="../../www/install-source.html">Install from Source</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 131 | </div> |
| 132 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 133 | <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 134 | </div> |
| 135 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 136 | <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 137 | </div> |
| 138 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 139 | <a title="Resources" href="../../www/resources.html">Resources</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 140 | </div> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 141 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 142 | <a title="Architecture" href="../../www/architecture.html">Architecture</a> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 143 | </div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 144 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 145 | <a title="Download" href="../../www/download.html">Download</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 146 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 147 | <div class="sep"></div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 148 | <div class="menu"> |
cristy | 3dfa219 | 2013-02-24 22:46:05 +0000 | [diff] [blame] | 149 | <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 150 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 151 | <div class="sep"></div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 152 | <div class="menu"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 153 | <a title="Site Map" href="../../www/sitemap.html">Site Map</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 154 | </div> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 155 | <div class="sub"> |
cristy | d8833bf | 2013-02-24 22:14:53 +0000 | [diff] [blame] | 156 | <a title="Site Map: Links" href="../../www/links.html">Links</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 157 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 158 | <div class="sep"></div> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 159 | <div class="menu"> |
| 160 | <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 161 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 162 | </div> |
| 163 | |
| 164 | <div class="eastbar"> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 165 | |
cristy | 417eeb1 | 2013-07-28 18:48:22 +0000 | [diff] [blame] | 166 | <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 167 | <noscript> |
| 168 | <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank"> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 169 | <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 170 | </noscript> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 171 | |
| 172 | |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 173 | </div> |
| 174 | |
| 175 | <div class="main"> |
| 176 | |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 177 | <h1>Module constitute Methods</h1> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 178 | <p class="navigation-index">[<a href="constitute.html#ConstituteImage">ConstituteImage</a> • <a href="constitute.html#PingImage">PingImage</a> • <a href="constitute.html#PingImages">PingImages</a> • <a href="constitute.html#ReadImage">ReadImage</a> • <a href="constitute.html#ReadImages">ReadImages</a> • <a href="constitute.html#WriteImage">WriteImage</a> • <a href="constitute.html#WriteImages">WriteImages</a>]</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 179 | |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 180 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ConstituteImage">ConstituteImage</a></h2> |
| 181 | <div class="doc-section"> |
| 182 | |
| 183 | <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> |
| 184 | |
| 185 | <pre class="text"> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 186 | image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception); |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 187 | </pre> |
| 188 | |
| 189 | <p>The format of the ConstituteImage method is:</p> |
| 190 | |
| 191 | <pre class="code"> |
| 192 | Image *ConstituteImage(const size_t columns,const size_t rows, |
| 193 | const char *map,const StorageType storage,const void *pixels, |
| 194 | ExceptionInfo *exception) |
| 195 | </pre> |
| 196 | |
| 197 | <p>A description of each parameter follows:</p> |
| 198 | |
| 199 | <h5>columns</h5> |
| 200 | <p>width in pixels of the image.</p> |
| 201 | |
| 202 | <h5>rows</h5> |
| 203 | <p>height in pixels of the image.</p> |
| 204 | |
| 205 | <h5>map</h5> |
| 206 | <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> |
| 207 | |
| 208 | <h5>storage</h5> |
| 209 | <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> |
| 210 | |
| 211 | <h5>pixels</h5> |
| 212 | <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> |
| 213 | |
| 214 | <h5>exception</h5> |
| 215 | <p>return any errors or warnings in this structure.</p> |
| 216 | |
| 217 | </div> |
| 218 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImage">PingImage</a></h2> |
| 219 | <div class="doc-section"> |
| 220 | |
| 221 | <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> |
| 222 | |
| 223 | <p>The format of the PingImage method is:</p> |
| 224 | |
| 225 | <pre class="code"> |
| 226 | Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception) |
| 227 | </pre> |
| 228 | |
| 229 | <p>A description of each parameter follows:</p> |
| 230 | |
| 231 | <h5>image_info</h5> |
| 232 | <p>Ping the image defined by the file or filename members of this structure.</p> |
| 233 | |
| 234 | <h5>exception</h5> |
| 235 | <p>return any errors or warnings in this structure.</p> |
| 236 | |
| 237 | </div> |
| 238 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImages">PingImages</a></h2> |
| 239 | <div class="doc-section"> |
| 240 | |
| 241 | <p>PingImages() pings one or more images and returns them as an image list.</p> |
| 242 | |
| 243 | <p>The format of the PingImage method is:</p> |
| 244 | |
| 245 | <pre class="code"> |
| 246 | Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception) |
| 247 | </pre> |
| 248 | |
| 249 | <p>A description of each parameter follows:</p> |
| 250 | |
| 251 | <h5>image_info</h5> |
| 252 | <p>the image info.</p> |
| 253 | |
| 254 | <h5>exception</h5> |
| 255 | <p>return any errors or warnings in this structure.</p> |
| 256 | |
| 257 | </div> |
| 258 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImage">ReadImage</a></h2> |
| 259 | <div class="doc-section"> |
| 260 | |
| 261 | <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> |
| 262 | |
| 263 | <p>The format of the ReadImage method is:</p> |
| 264 | |
| 265 | <pre class="code"> |
| 266 | Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception) |
| 267 | </pre> |
| 268 | |
| 269 | <p>A description of each parameter follows:</p> |
| 270 | |
| 271 | <h5>image_info</h5> |
| 272 | <p>Read the image defined by the file or filename members of this structure.</p> |
| 273 | |
| 274 | <h5>exception</h5> |
| 275 | <p>return any errors or warnings in this structure.</p> |
| 276 | |
| 277 | </div> |
| 278 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImages">ReadImages</a></h2> |
| 279 | <div class="doc-section"> |
| 280 | |
| 281 | <p>ReadImages() reads one or more images and returns them as an image list.</p> |
| 282 | |
| 283 | <p>The format of the ReadImage method is:</p> |
| 284 | |
| 285 | <pre class="code"> |
| 286 | Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception) |
| 287 | </pre> |
| 288 | |
| 289 | <p>A description of each parameter follows:</p> |
| 290 | |
| 291 | <h5>image_info</h5> |
| 292 | <p>the image info.</p> |
| 293 | |
| 294 | <h5>exception</h5> |
| 295 | <p>return any errors or warnings in this structure.</p> |
| 296 | |
| 297 | </div> |
| 298 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImage">WriteImage</a></h2> |
| 299 | <div class="doc-section"> |
| 300 | |
| 301 | <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> |
| 302 | |
| 303 | <p>The format of the WriteImage method is:</p> |
| 304 | |
| 305 | <pre class="code"> |
| 306 | MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image) |
| 307 | </pre> |
| 308 | |
| 309 | <p>A description of each parameter follows:</p> |
| 310 | |
| 311 | <h5>image_info</h5> |
| 312 | <p>the image info.</p> |
| 313 | |
| 314 | <h5>image</h5> |
| 315 | <p>the image.</p> |
| 316 | |
| 317 | </div> |
| 318 | <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImages">WriteImages</a></h2> |
| 319 | <div class="doc-section"> |
| 320 | |
| 321 | <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> |
| 322 | |
| 323 | <p>The format of the WriteImages method is:</p> |
| 324 | |
| 325 | <pre class="code"> |
| 326 | MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images, |
| 327 | const char *filename,ExceptionInfo *exception) |
| 328 | </pre> |
| 329 | |
| 330 | <p>A description of each parameter follows:</p> |
| 331 | |
| 332 | <h5>image_info</h5> |
| 333 | <p>the image info.</p> |
| 334 | |
| 335 | <h5>images</h5> |
| 336 | <p>the image list.</p> |
| 337 | |
| 338 | <h5>filename</h5> |
| 339 | <p>the image filename.</p> |
| 340 | |
| 341 | <h5>exception</h5> |
| 342 | <p>return any errors or warnings in this structure.</p> |
| 343 | |
| 344 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 345 | |
| 346 | </div> |
| 347 | |
| 348 | <div id="linkbar"> |
cristy | ac1b432 | 2013-07-28 13:58:06 +0000 | [diff] [blame] | 349 | <span id="linkbar-west"> </span> |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 350 | |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 351 | <span id="linkbar-center"> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 352 | <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • |
| 353 | <a href="../../discourse-server">Discourse Server</a> • |
| 354 | <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> • |
cristy | 8ee7f24 | 2013-06-20 16:08:44 +0000 | [diff] [blame] | 355 | <a href="http://jqmagick.imagemagick.org/">JqMagick</a> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 356 | </span> |
cristy | ac1b432 | 2013-07-28 13:58:06 +0000 | [diff] [blame] | 357 | <span id="linkbar-east"> </span> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame^] | 358 | </div> |
| 359 | <div class="footer"> |
| 360 | <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span> |
| 361 | <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span> |
| 362 | </div> |
| 363 | <div style="clear: both; margin: 0; width: 100%; "></div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 364 | </body> |
| 365 | </html> |