1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<?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">
<head>
<style type="text/css"><!--
@import url("../../www/magick.css");
//--></style>
<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, PerlMagick, Magick++, Image, Magick" />
<meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated. ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems. Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically. ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF." />
<meta name="Rating" content="GENERAL" />
<meta name="Robots" content="ALL" />
<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-2005 ImageMagick Studio LLC" />
<meta name="Distribution" content="Global" />
<link rel="shortcut icon" href="/../images/wand.ico" type="image/x-icon" />
</head>
<body id="www-imagemagick-org">
<table width="100%" id="titlebar" bgcolor="#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="202" height="118" border="0" name="titlebar-west" /></a></td>
<td width="35%"><br /></td>
<td align="left"><a href="http://www.imagemagick.org/" target="353401583"><img id="titlebar-west" src="../../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
<td width="65%"><br /></td>
<td bgcolor="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 bgcolor="white" align="right"><a href="../../index.html"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
</tr>
</tbody>
</table>
<table 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>
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/api.html">Program Interfaces</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/binary-releases.html">Binary Releases</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/links.html">Links</a>
<span>]</span><br /><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors</a>
<a href="http://www.devlib.org" class="sponsor" target="sponsor">IT and Programming<br />Resources</a><!-- 20050515 -->
<span>]</span>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#ConstituteImage">ConstituteImage</a> | <a href="#DestroyConstitute">DestroyConstitute</a> | <a href="#PingImage">PingImage</a> | <a href="#ReadImage">ReadImage</a> | <a href="#ReadInlineImage">ReadInlineImage</a> | <a href="#WriteImage">WriteImage</a> | <a href="#WriteImages">WriteImages</a> ]</p>
<div style="margin: auto;">
<h2><a 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>
<h4>columns</h4>
<p>width in pixels of the image.</p>
<h4>rows</h4>
<p>height in pixels of the image.</p>
<h4>map</h4>
<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>
<h4>storage</h4>
<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>
<h4>pixels</h4>
<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>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="DestroyConstitute">DestroyConstitute</a></h2>
</div>
<p>DestroyConstitute() destroys the constitute environment.</p>
<p>The format of the DestroyConstitute method is:</p>
<pre class="code">
DestroyConstitute(void)
</pre>
<div style="margin: auto;">
<h2><a name="PingImage">PingImage</a></h2>
</div>
<p>PingImage() returns all the attributes 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>
<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>
<h4>image_info</h4>
<p>Ping the image defined by the file or filename members of this structure.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a 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>
<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>
<h4>image_info</h4>
<p>Read the image defined by the file or filename members of this structure.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a name="ReadInlineImage">ReadInlineImage</a></h2>
</div>
<p>ReadInlineImage() reads a Base64-encoded inline image or image sequence. 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>
<p>The format of the ReadInlineImage method is:</p>
<pre class="code">
Image *ReadInlineImage(const ImageInfo *image_info,const char *content,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h4>image_info</h4>
<p>The image info.</p>
<h4>content</h4>
<p>The image encoded in Base64.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
<div style="margin: auto;">
<h2><a 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>
<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>
<h4>image_info</h4>
<p>The image info.</p>
<h4>image</h4>
<p>The image.</p>
<div style="margin: auto;">
<h2><a name="WriteImages">WriteImages</a></h2>
</div>
<p>WriteImages() writes an image sequence.</p>
<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>
<h4>image_info</h4>
<p>The image info.</p>
<h4>images</h4>
<p>The image list.</p>
<h4>filename</h4>
<p>The image filename.</p>
<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<a href="http://redux.imagemagick.org/discussion-server" target="4777554">Discourse Server</a> |
<a href="../../www/mailing-list.html">Mailing Lists</a> |
<a href="http://redux.imagemagick.org/gallery" target="1152160234">Image Gallery</a> |
<a href="http://redux.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="236640627">ImageMagick Studio</a>
</div>
<div>
<span id="footer-west">© 1999-2005 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>
|
