Debian Codegraph @

www/api/image.html

raw ◀ ▶
Source reconstructed at patch state 0 of 4 — not the installed (fully patched) source.
4 Debian patches touch this file
1
2
3
4
5 <!doctype html>
6 <html lang="en" data-bs-theme="dark">
7 <head>
8 <script src="../assets/color-modes.js" ></script>
9 <meta charset="utf-8" />
10 <meta name="viewport" content="width=device-width, initial-scale=1" />
11 <title>ImageMagick – MagickCore, C API: Image Methods</title>
12 <meta name="keywords" content="MagickCore, C API: Image Methods, Image Processing, Digital Image Editing, Image Conversion, Open-Source Software, Image Manipulation, Command-Line Image Tools" />
13 <meta name="description" content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
14 <meta name="application-name" content="ImageMagick" />
15 <meta name="application-url" content="https://imagemagick.org" />
16 <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
17 <meta itemprop='url' content='../../' />
18 <meta itemprop='title' content='ImageMagick' />
19 <meta itemprop='description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
20 <meta property='og:url' content='../../' />
21 <meta property='og:name' content='ImageMagick' />
22 <meta property='og:image' content='../../../../../../../../images/logo.png' />
23 <meta property='og:type' content='website' />
24 <meta property='og:site_name' content='ImageMagick' />
25 <meta property='og:description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
26 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
27 <link type="images/png" sizes="64x64" href="../../../../../../../images/wand.png" rel="icon" />
28 <link type="images/icon" sizes="16x16" href="../../../../../../../images/wand.ico" rel="shortcut icon" />
29 <link href="image.html" rel="canonical" />
30 <link href="../assets/bootstrap.min.css" rel="stylesheet" />
31 </head>
32 <body>
33 <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
34 <symbol id="check2" viewBox="0 0 16 16">
35 <path d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z"/>
36 </symbol>
37 <symbol id="circle-half" viewBox="0 0 16 16">
38 <path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z"/>
39 </symbol>
40 <symbol id="moon-stars-fill" viewBox="0 0 16 16">
41 <path d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z"/>
42 <path d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z"/>
43 </symbol>
44 <symbol id="sun-fill" viewBox="0 0 16 16">
45 <path d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z"/>
46 </symbol>
47 </svg>
48 <div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
49 <button class="btn btn-bd-secondary py-2 dropdown-toggle d-flex align-items-center"
50 id="bd-theme"
51 type="button"
52 aria-expanded="false"
53 data-bs-toggle="dropdown"
54 aria-label="Toggle theme (auto)">
55 <svg class="bi my-1 theme-icon-active" width="1em" height="1em"><use href="#circle-half"></use></svg>
56 <span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
57 </button>
58 <ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
59 <li>
60 <button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
61 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#sun-fill"></use></svg>
62 Light
63 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
64 </button>
65 </li>
66 <li>
67 <button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="dark" aria-pressed="false">
68 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#moon-stars-fill"></use></svg>
69 Dark
70 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
71 </button>
72 </li>
73 <li>
74 <button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="auto" aria-pressed="true">
75 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#circle-half"></use></svg>
76 Auto
77 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
78 </button>
79 </li>
80 </ul>
81 </div>
82 <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
83 <symbol id="arrow-right-circle" viewBox="0 0 16 16">
84 <path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z"/>
85 </symbol>
86 <symbol id="color-mode" viewBox="0 0 118 94">
87 <title>Color Modes</title>
88 <path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z"></path>
89 </symbol>
90 </svg>
91 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
92 <div class="container-fluid">
93 <a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../../../../../images/wand.ico"/></a>
94 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
95 <span class="navbar-toggler-icon"></span>
96 </button>
97
98 <div class="collapse navbar-collapse" id="magick-navbars">
99 <ul class="navbar-nav me-auto mb-2 mb-md-0">
100 <li class="nav-item">
101 <a class="nav-link " href="../www/download.html">Download</a>
102 </li>
103 <li class="nav-item">
104 <a class="nav-link " href="../www/command-line-tools.html">Tools</a>
105 </li>
106 <li class="nav-item">
107 <a class="nav-link " href="../www/command-line-processing.html">CLI</a>
108 </li>
109 <li class="nav-item">
110 <a class="nav-link " href="../www/develop.html">Develop</a>
111 </li>
112 <li class="nav-item">
113 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
114 </li>
115 <li class="nav-item">
116 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
117 </li>
118 </ul>
119 <form class="d-flex form-inline" action="../../../../../https://imagemagick.org/script/search.php">
120 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
121 <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
122 </form>
123 </div>
124 </div>
125 </nav>
126
127 <div class="col-lg-8 mx-auto p-4 py-md-5 text-body-secondary">
128 <header class="d-flex align-items-center pb-3 mb-5 border-bottom">
129 <a href="../index.html" class="d-flex align-items-center text-decoration-none">
130 <h1 class="mt-5 fs-3">MagickCore, C API: Image Methods</h1>
131 </a>
132 </header>
133
134 <main class="container">
135 <h1 class="text-center">Image</h1>
136 <div class="btn-group">
137 <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
138 Select API Method
139 </button>
140 <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
141 <li><a href="#AcquireImage">AcquireImage</a></li>
142 <li><a href="#AcquireImageInfo">AcquireImageInfo</a></li>
143 <li><a href="#AcquireNextImage">AcquireNextImage</a></li>
144 <li><a href="#AppendImages">AppendImages</a></li>
145 <li><a href="#CatchImageException">CatchImageException</a></li>
146 <li><a href="#ClipImagePath">ClipImagePath</a></li>
147 <li><a href="#CloneImage">CloneImage</a></li>
148 <li><a href="#CloneImageInfo">CloneImageInfo</a></li>
149 <li><a href="#CopyImagePixels">CopyImagePixels</a></li>
150 <li><a href="#DestroyImage">DestroyImage</a></li>
151 <li><a href="#DestroyImageInfo">DestroyImageInfo</a></li>
152 <li><a href="#GetImageInfo">GetImageInfo</a></li>
153 <li><a href="#GetImageInfoFile">GetImageInfoFile</a></li>
154 <li><a href="#GetImageMask">GetImageMask</a></li>
155 <li><a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></li>
156 <li><a href="#InterpretImageFilename">InterpretImageFilename</a></li>
157 <li><a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></li>
158 <li><a href="#IsImageObject">IsImageObject</a></li>
159 <li><a href="#IsTaintImage">IsTaintImage</a></li>
160 <li><a href="#ModifyImage">ModifyImage</a></li>
161 <li><a href="#NewMagickImage">NewMagickImage</a></li>
162 <li><a href="#ReferenceImage">ReferenceImage</a></li>
163 <li><a href="#ResetImagePage">ResetImagePage</a></li>
164 <li><a href="#ResetImagePixels">ResetImagePixels</a></li>
165 <li><a href="#SetImageAlpha">SetImageAlpha</a></li>
166 <li><a href="#SetImageBackgroundColor">SetImageBackgroundColor</a></li>
167 <li><a href="#SetImageChannelMask">SetImageChannelMask</a></li>
168 <li><a href="#SetImageColor">SetImageColor</a></li>
169 <li><a href="#SetImageStorageClass">SetImageStorageClass</a></li>
170 <li><a href="#SetImageExtent">SetImageExtent</a></li>
171 <li><a href="#SetImageInfoBlob">SetImageInfoBlob</a></li>
172 <li><a href="#SetImageInfoCustomStream">SetImageInfoCustomStream</a></li>
173 <li><a href="#SetImageInfoFile">SetImageInfoFile</a></li>
174 <li><a href="#SetImageMask">SetImageMask</a></li>
175 <li><a href="#SetImageRegionMask">SetImageRegionMask</a></li>
176 <li><a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></li>
177 <li><a href="#SmushImages">SmushImages</a></li>
178 <li><a href="#StripImage">StripImage</a></li>
179 </ul>
180 </div>
181 <br/>
182 <br/>
183 <div class="magick-header">
184 <h2><a href="../../api/MagickCore/image_8c.html" id="AcquireImage">AcquireImage</a></h2>
185
186 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p>
187
188 <p>The format of the AcquireImage method is:</p>
189
190 <pre class="bg-light text-dark mx-4"><samp>Image *AcquireImage(const ImageInfo *image_info,ExceptionInfo *exception)
191 </samp></pre>
192
193 <p>A description of each parameter follows:</p>
194
195 <dd>
196 </dd>
197
198 <dd> </dd>
199 <dl class="dl-horizontal">
200 <dt>image_info</dt>
201 <dd>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others. </dd>
202
203 <dd> </dd>
204 <dt>exception</dt>
205 <dd>return any errors or warnings in this structure. </dd>
206
207 <dd> </dd>
208 </dl>
209 <h2><a href="../../api/MagickCore/image_8c.html" id="AcquireImageInfo">AcquireImageInfo</a></h2>
210
211 <p>AcquireImageInfo() allocates the ImageInfo structure.</p>
212
213 <p>The format of the AcquireImageInfo method is:</p>
214
215 <pre class="bg-light text-dark mx-4"><samp>ImageInfo *AcquireImageInfo(void)
216 </samp></pre>
217
218 <h2><a href="../../api/MagickCore/image_8c.html" id="AcquireNextImage">AcquireNextImage</a></h2>
219
220 <p>AcquireNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.</p>
221
222 <p>The format of the AcquireNextImage method is:</p>
223
224 <pre class="bg-light text-dark mx-4"><samp>void AcquireNextImage(const ImageInfo *image_info,Image *image,
225 ExceptionInfo *exception)
226 </samp></pre>
227
228 <p>A description of each parameter follows:</p>
229
230 <dd>
231 </dd>
232
233 <dd> </dd>
234 <dl class="dl-horizontal">
235 <dt>image_info</dt>
236 <dd>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others. </dd>
237
238 <dd> </dd>
239 <dt>image</dt>
240 <dd>the image. </dd>
241
242 <dd> </dd>
243 <dt>exception</dt>
244 <dd>return any errors or warnings in this structure. </dd>
245
246 <dd> </dd>
247 </dl>
248 <h2><a href="../../api/MagickCore/image_8c.html" id="AppendImages">AppendImages</a></h2>
249
250 <p>AppendImages() takes all images from the current image pointer to the end of the image list and appends them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
251
252 <p>The current gravity setting effects how the image is justified in the final image.</p>
253
254 <p>The format of the AppendImages method is:</p>
255
256 <pre class="bg-light text-dark mx-4"><samp>Image *AppendImages(const Image *images,const MagickBooleanType stack,
257 ExceptionInfo *exception)
258 </samp></pre>
259
260 <p>A description of each parameter follows:</p>
261
262 <dd>
263 </dd>
264
265 <dd> </dd>
266 <dl class="dl-horizontal">
267 <dt>images</dt>
268 <dd>the image sequence. </dd>
269
270 <dd> </dd>
271 <dt>stack</dt>
272 <dd>A value other than 0 stacks the images top-to-bottom. </dd>
273
274 <dd> </dd>
275 <dt>exception</dt>
276 <dd>return any errors or warnings in this structure. </dd>
277
278 <dd> </dd>
279 </dl>
280 <h2><a href="../../api/MagickCore/image_8c.html" id="CatchImageException">CatchImageException</a></h2>
281
282 <p>CatchImageException() returns if no exceptions are found in the image sequence, otherwise it determines the most severe exception and reports it as a warning or error depending on the severity.</p>
283
284 <p>The format of the CatchImageException method is:</p>
285
286 <pre class="bg-light text-dark mx-4"><samp>ExceptionType CatchImageException(Image *image)
287 </samp></pre>
288
289 <p>A description of each parameter follows:</p>
290
291 <dd>
292 </dd>
293
294 <dd> </dd>
295 <dl class="dl-horizontal">
296 <dt>image</dt>
297 <dd>An image sequence. </dd>
298
299 <dd> </dd>
300 </dl>
301 <h2><a href="../../api/MagickCore/image_8c.html" id="ClipImagePath">ClipImagePath</a></h2>
302
303 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p>
304
305 <p>The format of the ClipImagePath method is:</p>
306
307 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType ClipImagePath(Image *image,const char *pathname,
308 const MagickBooleanType inside,ExceptionInfo *exception)
309 </samp></pre>
310
311 <p>A description of each parameter follows:</p>
312
313 <dd>
314 </dd>
315
316 <dd> </dd>
317 <dl class="dl-horizontal">
318 <dt>image</dt>
319 <dd>the image. </dd>
320
321 <dd> </dd>
322 <dt>pathname</dt>
323 <dd>name of clipping path resource. If name is preceded by #, use clipping path numbered by name. </dd>
324
325 <dd> </dd>
326 <dt>inside</dt>
327 <dd>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path. </dd>
328
329 <dd> </dd>
330 <dt>exception</dt>
331 <dd>return any errors or warnings in this structure. </dd>
332
333 <dd> </dd>
334 </dl>
335 <h2><a href="../../api/MagickCore/image_8c.html" id="CloneImage">CloneImage</a></h2>
336
337 <p>CloneImage() copies an image and returns the copy as a new image object.</p>
338
339 <p>If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the QueueAuthenticPixels() and SyncAuthenticPixels() methods. On failure, a NULL image is returned and exception describes the reason for the failure.</p>
340
341 <p>The format of the CloneImage method is:</p>
342
343 <pre class="bg-light text-dark mx-4"><samp>Image *CloneImage(const Image *image,const size_t columns,
344 const size_t rows,const MagickBooleanType orphan,
345 ExceptionInfo *exception)
346 </samp></pre>
347
348 <p>A description of each parameter follows:</p>
349
350 <dd>
351 </dd>
352
353 <dd> </dd>
354 <dl class="dl-horizontal">
355 <dt>image</dt>
356 <dd>the image. </dd>
357
358 <dd> </dd>
359 <dt>columns</dt>
360 <dd>the number of columns in the cloned image. </dd>
361
362 <dd> </dd>
363 <dt>rows</dt>
364 <dd>the number of rows in the cloned image. </dd>
365
366 <dd> </dd>
367 <dt>detach</dt>
368 <dd> With a value other than 0, the cloned image is detached from its parent I/O stream. </dd>
369
370 <dd> </dd>
371 <dt>exception</dt>
372 <dd>return any errors or warnings in this structure. </dd>
373
374 <dd> </dd>
375 </dl>
376 <h2><a href="../../api/MagickCore/image_8c.html" id="CloneImageInfo">CloneImageInfo</a></h2>
377
378 <p>CloneImageInfo() makes a copy of the given image info structure. If NULL is specified, a new image info structure is created initialized to default values.</p>
379
380 <p>The format of the CloneImageInfo method is:</p>
381
382 <pre class="bg-light text-dark mx-4"><samp>ImageInfo *CloneImageInfo(const ImageInfo *image_info)
383 </samp></pre>
384
385 <p>A description of each parameter follows:</p>
386
387 <dd>
388 </dd>
389
390 <dd> </dd>
391 <dl class="dl-horizontal">
392 <dt>image_info</dt>
393 <dd>the image info. </dd>
394
395 <dd> </dd>
396 </dl>
397 <h2><a href="../../api/MagickCore/image_8c.html" id="CopyImagePixels">CopyImagePixels</a></h2>
398
399 <p>CopyImagePixels() copies pixels from the source image as defined by the geometry the destination image at the specified offset.</p>
400
401 <p>The format of the CopyImagePixels method is:</p>
402
403 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType CopyImagePixels(Image *image,const Image *source_image,
404 const RectangleInfo *geometry,const OffsetInfo *offset,
405 ExceptionInfo *exception)
406 </samp></pre>
407
408 <p>A description of each parameter follows:</p>
409
410 <dd>
411 </dd>
412
413 <dd> </dd>
414 <dl class="dl-horizontal">
415 <dt>image</dt>
416 <dd>the destination image. </dd>
417
418 <dd> </dd>
419 <dt>source_image</dt>
420 <dd>the source image. </dd>
421
422 <dd> </dd>
423 <dt>geometry</dt>
424 <dd>define the dimensions of the source pixel rectangle. </dd>
425
426 <dd> </dd>
427 <dt>offset</dt>
428 <dd>define the offset in the destination image. </dd>
429
430 <dd> </dd>
431 <dt>exception</dt>
432 <dd>return any errors or warnings in this structure. </dd>
433
434 <dd> </dd>
435 </dl>
436 <h2><a href="../../api/MagickCore/image_8c.html" id="DestroyImage">DestroyImage</a></h2>
437
438 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
439
440 <p>The format of the DestroyImage method is:</p>
441
442 <pre class="bg-light text-dark mx-4"><samp>Image *DestroyImage(Image *image)
443 </samp></pre>
444
445 <p>A description of each parameter follows:</p>
446
447 <dd>
448 </dd>
449
450 <dd> </dd>
451 <dl class="dl-horizontal">
452 <dt>image</dt>
453 <dd>the image. </dd>
454
455 <dd> </dd>
456 </dl>
457 <h2><a href="../../api/MagickCore/image_8c.html" id="DestroyImageInfo">DestroyImageInfo</a></h2>
458
459 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p>
460
461 <p>The format of the DestroyImageInfo method is:</p>
462
463 <pre class="bg-light text-dark mx-4"><samp>ImageInfo *DestroyImageInfo(ImageInfo *image_info)
464 </samp></pre>
465
466 <p>A description of each parameter follows:</p>
467
468 <dd>
469 </dd>
470
471 <dd> </dd>
472 <dl class="dl-horizontal">
473 <dt>image_info</dt>
474 <dd>the image info. </dd>
475
476 <dd> </dd>
477 </dl>
478 <h2><a href="../../api/MagickCore/image_8c.html" id="GetImageInfo">GetImageInfo</a></h2>
479
480 <p>GetImageInfo() initializes image_info to default values.</p>
481
482 <p>The format of the GetImageInfo method is:</p>
483
484 <pre class="bg-light text-dark mx-4"><samp>void GetImageInfo(ImageInfo *image_info)
485 </samp></pre>
486
487 <p>A description of each parameter follows:</p>
488
489 <dd>
490 </dd>
491
492 <dd> </dd>
493 <dl class="dl-horizontal">
494 <dt>image_info</dt>
495 <dd>the image info. </dd>
496
497 <dd> </dd>
498 </dl>
499 <h2><a href="../../api/MagickCore/image_8c.html" id="GetImageInfoFile">GetImageInfoFile</a></h2>
500
501 <p>GetImageInfoFile() returns the image info file member.</p>
502
503 <p>The format of the GetImageInfoFile method is:</p>
504
505 <pre class="bg-light text-dark mx-4"><samp>FILE *GetImageInfoFile(const ImageInfo *image_info)
506 </samp></pre>
507
508 <p>A description of each parameter follows:</p>
509
510 <dd>
511 </dd>
512
513 <dd> </dd>
514 <dl class="dl-horizontal">
515 <dt>image_info</dt>
516 <dd>the image info. </dd>
517
518 <dd> </dd>
519 </dl>
520 <h2><a href="../../api/MagickCore/image_8c.html" id="GetImageMask">GetImageMask</a></h2>
521
522 <p>GetImageMask() returns the mask associated with the image.</p>
523
524 <p>The format of the GetImageMask method is:</p>
525
526 <pre class="bg-light text-dark mx-4"><samp>Image *GetImageMask(const Image *image,const PixelMask type,
527 ExceptionInfo *exception)
528 </samp></pre>
529
530 <p>A description of each parameter follows:</p>
531
532 <dd>
533 </dd>
534
535 <dd> </dd>
536 <dl class="dl-horizontal">
537 <dt>image</dt>
538 <dd>the image. </dd>
539
540 <dd> </dd>
541 <dt>type</dt>
542 <dd>the mask type, ReadPixelMask or WritePixelMask. </dd>
543
544 <dd> </dd>
545 </dl>
546 <h2><a href="../../api/MagickCore/image_8c.html" id="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
547
548 <p>GetImageVirtualPixelMethod() gets the "virtual pixels" method for the image. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
549
550 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
551
552 <pre class="bg-light text-dark mx-4"><samp>VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
553 </samp></pre>
554
555 <p>A description of each parameter follows:</p>
556
557 <dd>
558 </dd>
559
560 <dd> </dd>
561 <dl class="dl-horizontal">
562 <dt>image</dt>
563 <dd>the image. </dd>
564
565 <dd> </dd>
566 </dl>
567 <h2><a href="../../api/MagickCore/image_8c.html" id="InterpretImageFilename">InterpretImageFilename</a></h2>
568
569 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p>
570
571 <p>The format of the InterpretImageFilename method is:</p>
572
573 <pre class="bg-light text-dark mx-4"><samp>size_t InterpretImageFilename(const ImageInfo *image_info,Image *image,
574 const char *format,int value,char *filename,ExceptionInfo *exception)
575 </samp></pre>
576
577 <p>A description of each parameter follows.</p>
578
579 <dt>image_info</dt>
580 <p>the image info..</p>
581
582 <dt>image</dt>
583 <p>the image.</p>
584
585 <dt>format</dt>
586 <p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p>
587
588 <dt>value</dt>
589 <p>Numeric value to substitute into format filename.</p>
590
591 <dt>filename</dt>
592 <p>return the formatted filename in this character buffer.</p>
593
594 <dt>exception</dt>
595 <p>return any errors or warnings in this structure.</p>
596
597 <h2><a href="../../api/MagickCore/image_8c.html" id="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
598
599 <p>IsHighDynamicRangeImage() returns MagickTrue if any pixel component is non-integer or exceeds the bounds of the quantum depth (e.g. for Q16 0..65535.</p>
600
601 <p>The format of the IsHighDynamicRangeImage method is:</p>
602
603 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsHighDynamicRangeImage(const Image *image,
604 ExceptionInfo *exception)
605 </samp></pre>
606
607 <p>A description of each parameter follows:</p>
608
609 <dd>
610 </dd>
611
612 <dd> </dd>
613 <dl class="dl-horizontal">
614 <dt>image</dt>
615 <dd>the image. </dd>
616
617 <dd> </dd>
618 <dt>exception</dt>
619 <dd>return any errors or warnings in this structure. </dd>
620
621 <dd> </dd>
622 </dl>
623 <h2><a href="../../api/MagickCore/image_8c.html" id="IsImageObject">IsImageObject</a></h2>
624
625 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p>
626
627 <p>The format of the IsImageObject method is:</p>
628
629 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsImageObject(const Image *image)
630 </samp></pre>
631
632 <p>A description of each parameter follows:</p>
633
634 <dd>
635 </dd>
636
637 <dd> </dd>
638 <dl class="dl-horizontal">
639 <dt>image</dt>
640 <dd>the image. </dd>
641
642 <dd> </dd>
643 </dl>
644 <h2><a href="../../api/MagickCore/image_8c.html" id="IsTaintImage">IsTaintImage</a></h2>
645
646 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p>
647
648 <p>The format of the IsTaintImage method is:</p>
649
650 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsTaintImage(const Image *image)
651 </samp></pre>
652
653 <p>A description of each parameter follows:</p>
654
655 <dd>
656 </dd>
657
658 <dd> </dd>
659 <dl class="dl-horizontal">
660 <dt>image</dt>
661 <dd>the image. </dd>
662
663 <dd> </dd>
664 </dl>
665 <h2><a href="../../api/MagickCore/image_8c.html" id="ModifyImage">ModifyImage</a></h2>
666
667 <p>ModifyImage() ensures that there is only a single reference to the image to be modified, updating the provided image pointer to point to a clone of the original image if necessary.</p>
668
669 <p>The format of the ModifyImage method is:</p>
670
671 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
672 </samp></pre>
673
674 <p>A description of each parameter follows:</p>
675
676 <dd>
677 </dd>
678
679 <dd> </dd>
680 <dl class="dl-horizontal">
681 <dt>image</dt>
682 <dd>the image. </dd>
683
684 <dd> </dd>
685 <dt>exception</dt>
686 <dd>return any errors or warnings in this structure. </dd>
687
688 <dd> </dd>
689 </dl>
690 <h2><a href="../../api/MagickCore/image_8c.html" id="NewMagickImage">NewMagickImage</a></h2>
691
692 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p>
693
694 <p>The format of the NewMagickImage method is:</p>
695
696 <pre class="bg-light text-dark mx-4"><samp>Image *NewMagickImage(const ImageInfo *image_info,const size_t width,
697 const size_t height,const PixelInfo *background,
698 ExceptionInfo *exception)
699 </samp></pre>
700
701 <p>A description of each parameter follows:</p>
702
703 <dd>
704 </dd>
705
706 <dd> </dd>
707 <dl class="dl-horizontal">
708 <dt>image</dt>
709 <dd>the image. </dd>
710
711 <dd> </dd>
712 <dt>width</dt>
713 <dd>the image width. </dd>
714
715 <dd> </dd>
716 <dt>height</dt>
717 <dd>the image height. </dd>
718
719 <dd> </dd>
720 <dt>background</dt>
721 <dd>the image color. </dd>
722
723 <dd> </dd>
724 <dt>exception</dt>
725 <dd>return any errors or warnings in this structure. </dd>
726
727 <dd> </dd>
728 </dl>
729 <h2><a href="../../api/MagickCore/image_8c.html" id="ReferenceImage">ReferenceImage</a></h2>
730
731 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p>
732
733 <p>The format of the ReferenceImage method is:</p>
734
735 <pre class="bg-light text-dark mx-4"><samp>Image *ReferenceImage(Image *image)
736 </samp></pre>
737
738 <p>A description of each parameter follows:</p>
739
740 <dd>
741 </dd>
742
743 <dd> </dd>
744 <dl class="dl-horizontal">
745 <dt>image</dt>
746 <dd>the image. </dd>
747
748 <dd> </dd>
749 </dl>
750 <h2><a href="../../api/MagickCore/image_8c.html" id="ResetImagePage">ResetImagePage</a></h2>
751
752 <p>ResetImagePage() resets the image page canvas and position.</p>
753
754 <p>The format of the ResetImagePage method is:</p>
755
756 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType ResetImagePage(Image *image,const char *page)
757 </samp></pre>
758
759 <p>A description of each parameter follows:</p>
760
761 <dd>
762 </dd>
763
764 <dd> </dd>
765 <dl class="dl-horizontal">
766 <dt>image</dt>
767 <dd>the image. </dd>
768
769 <dd> </dd>
770 <dt>page</dt>
771 <dd>the relative page specification. </dd>
772
773 <dd> </dd>
774 </dl>
775 <h2><a href="../../api/MagickCore/image_8c.html" id="ResetImagePixels">ResetImagePixels</a></h2>
776
777 <p>ResetImagePixels() reset the image pixels, that is, all the pixel components are zeroed.</p>
778
779 <p>The format of the SetImage method is:</p>
780
781 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType ResetImagePixels(Image *image,
782 ExceptionInfo *exception)
783 </samp></pre>
784
785 <p>A description of each parameter follows:</p>
786
787 <dd>
788 </dd>
789
790 <dd> </dd>
791 <dl class="dl-horizontal">
792 <dt>image</dt>
793 <dd>the image. </dd>
794
795 <dd> </dd>
796 <dt>exception</dt>
797 <dd>return any errors or warnings in this structure. </dd>
798
799 <dd> </dd>
800 </dl>
801 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageAlpha">SetImageAlpha</a></h2>
802
803 <p>SetImageAlpha() sets the alpha levels of the image.</p>
804
805 <p>The format of the SetImageAlpha method is:</p>
806
807 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageAlpha(Image *image,const Quantum alpha,
808 ExceptionInfo *exception)
809 </samp></pre>
810
811 <p>A description of each parameter follows:</p>
812
813 <dd>
814 </dd>
815
816 <dd> </dd>
817 <dl class="dl-horizontal">
818 <dt>image</dt>
819 <dd>the image. </dd>
820
821 <dd> </dd>
822 <dt>alpha</dt>
823 <dd>the level of transparency: 0 is fully transparent and QuantumRange is fully opaque. </dd>
824
825 <dd> </dd>
826 <dt>exception</dt>
827 <dd>return any errors or warnings in this structure. </dd>
828
829 <dd> </dd>
830 </dl>
831 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
832
833 <p>SetImageBackgroundColor() initializes the image pixels to the image background color. The background color is defined by the background_color member of the image structure.</p>
834
835 <p>The format of the SetImage method is:</p>
836
837 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageBackgroundColor(Image *image,
838 ExceptionInfo *exception)
839 </samp></pre>
840
841 <p>A description of each parameter follows:</p>
842
843 <dd>
844 </dd>
845
846 <dd> </dd>
847 <dl class="dl-horizontal">
848 <dt>image</dt>
849 <dd>the image. </dd>
850
851 <dd> </dd>
852 <dt>exception</dt>
853 <dd>return any errors or warnings in this structure. </dd>
854
855 <dd> </dd>
856 </dl>
857 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageChannelMask">SetImageChannelMask</a></h2>
858
859 <p>SetImageChannelMask() sets the image channel mask from the specified channel mask.</p>
860
861 <p>The format of the SetImageChannelMask method is:</p>
862
863 <pre class="bg-light text-dark mx-4"><samp>ChannelType SetImageChannelMask(Image *image,
864 const ChannelType channel_mask)
865 </samp></pre>
866
867 <p>A description of each parameter follows:</p>
868
869 <dd>
870 </dd>
871
872 <dd> </dd>
873 <dl class="dl-horizontal">
874 <dt>image</dt>
875 <dd>the image. </dd>
876
877 <dd> </dd>
878 <dt>channel_mask</dt>
879 <dd>the channel mask. </dd>
880
881 <dd> </dd>
882 </dl>
883 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageColor">SetImageColor</a></h2>
884
885 <p>SetImageColor() set the entire image canvas to the specified color.</p>
886
887 <p>The format of the SetImageColor method is:</p>
888
889 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageColor(Image *image,const PixelInfo *color,
890 ExceptionInfo *exception)
891 </samp></pre>
892
893 <p>A description of each parameter follows:</p>
894
895 <dd>
896 </dd>
897
898 <dd> </dd>
899 <dl class="dl-horizontal">
900 <dt>image</dt>
901 <dd>the image. </dd>
902
903 <dd> </dd>
904 <dt>background</dt>
905 <dd>the image color. </dd>
906
907 <dd> </dd>
908 <dt>exception</dt>
909 <dd>return any errors or warnings in this structure. </dd>
910
911 <dd> </dd>
912 </dl>
913 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageStorageClass">SetImageStorageClass</a></h2>
914
915 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p>
916
917 <p>The format of the SetImageStorageClass method is:</p>
918
919 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageStorageClass(Image *image,
920 const ClassType storage_class,ExceptionInfo *exception)
921 </samp></pre>
922
923 <p>A description of each parameter follows:</p>
924
925 <dd>
926 </dd>
927
928 <dd> </dd>
929 <dl class="dl-horizontal">
930 <dt>image</dt>
931 <dd>the image. </dd>
932
933 <dd> </dd>
934 <dt>storage_class</dt>
935 <dd> The image class. </dd>
936
937 <dd> </dd>
938 <dt>exception</dt>
939 <dd>return any errors or warnings in this structure. </dd>
940
941 <dd> </dd>
942 </dl>
943 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageExtent">SetImageExtent</a></h2>
944
945 <p>SetImageExtent() sets the image size (i.e. columns &amp; rows).</p>
946
947 <p>The format of the SetImageExtent method is:</p>
948
949 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageExtent(Image *image,const size_t columns,
950 const size_t rows,ExceptionInfo *exception)
951 </samp></pre>
952
953 <p>A description of each parameter follows:</p>
954
955 <dd>
956 </dd>
957
958 <dd> </dd>
959 <dl class="dl-horizontal">
960 <dt>image</dt>
961 <dd>the image. </dd>
962
963 <dd> </dd>
964 <dt>columns</dt>
965 <dd> The image width in pixels. </dd>
966
967 <dd> </dd>
968 <dt>rows</dt>
969 <dd> The image height in pixels. </dd>
970
971 <dd> </dd>
972 <dt>exception</dt>
973 <dd>return any errors or warnings in this structure. </dd>
974
975 <dd> </dd>
976 </dl>
977 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageInfoBlob">SetImageInfoBlob</a></h2>
978
979 <p>SetImageInfoBlob() sets the image info blob member.</p>
980
981 <p>The format of the SetImageInfoBlob method is:</p>
982
983 <pre class="bg-light text-dark mx-4"><samp>void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
984 const size_t length)
985 </samp></pre>
986
987 <p>A description of each parameter follows:</p>
988
989 <dd>
990 </dd>
991
992 <dd> </dd>
993 <dl class="dl-horizontal">
994 <dt>image_info</dt>
995 <dd>the image info. </dd>
996
997 <dd> </dd>
998 <dt>blob</dt>
999 <dd>the blob. </dd>
1000
1001 <dd> </dd>
1002 <dt>length</dt>
1003 <dd>the blob length. </dd>
1004
1005 <dd> </dd>
1006 </dl>
1007 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageInfoCustomStream">SetImageInfoCustomStream</a></h2>
1008
1009 <p>SetImageInfoCustomStream() sets the image info custom stream handlers.</p>
1010
1011 <p>The format of the SetImageInfoCustomStream method is:</p>
1012
1013 <pre class="bg-light text-dark mx-4"><samp>void SetImageInfoCustomStream(ImageInfo *image_info,
1014 CustomStreamInfo *custom_stream)
1015 </samp></pre>
1016
1017 <p>A description of each parameter follows:</p>
1018
1019 <dd>
1020 </dd>
1021
1022 <dd> </dd>
1023 <dl class="dl-horizontal">
1024 <dt>image_info</dt>
1025 <dd>the image info. </dd>
1026
1027 <dd> </dd>
1028 <dt>custom_stream</dt>
1029 <dd>your custom stream methods. </dd>
1030
1031 <dd> </dd>
1032 </dl>
1033 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageInfoFile">SetImageInfoFile</a></h2>
1034
1035 <p>SetImageInfoFile() sets the image info file member.</p>
1036
1037 <p>The format of the SetImageInfoFile method is:</p>
1038
1039 <pre class="bg-light text-dark mx-4"><samp>void SetImageInfoFile(ImageInfo *image_info,FILE *file)
1040 </samp></pre>
1041
1042 <p>A description of each parameter follows:</p>
1043
1044 <dd>
1045 </dd>
1046
1047 <dd> </dd>
1048 <dl class="dl-horizontal">
1049 <dt>image_info</dt>
1050 <dd>the image info. </dd>
1051
1052 <dd> </dd>
1053 <dt>file</dt>
1054 <dd>the file. </dd>
1055
1056 <dd> </dd>
1057 </dl>
1058 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageMask">SetImageMask</a></h2>
1059
1060 <p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p>
1061
1062 <p>The format of the SetImageMask method is:</p>
1063
1064 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageMask(Image *image,const PixelMask type,
1065 const Image *mask,ExceptionInfo *exception)
1066 </samp></pre>
1067
1068 <p>A description of each parameter follows:</p>
1069
1070 <dd>
1071 </dd>
1072
1073 <dd> </dd>
1074 <dl class="dl-horizontal">
1075 <dt>image</dt>
1076 <dd>the image. </dd>
1077
1078 <dd> </dd>
1079 <dt>type</dt>
1080 <dd>the mask type, ReadPixelMask or WritePixelMask. </dd>
1081
1082 <dd> </dd>
1083 <dt>mask</dt>
1084 <dd>the image mask. </dd>
1085
1086 <dd> </dd>
1087 <dt>exception</dt>
1088 <dd>return any errors or warnings in this structure. </dd>
1089
1090 <dd> </dd>
1091 </dl>
1092 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageRegionMask">SetImageRegionMask</a></h2>
1093
1094 <p>SetImageRegionMask() associates a mask with the image as defined by the specified region.</p>
1095
1096 <p>The format of the SetImageRegionMask method is:</p>
1097
1098 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageRegionMask(Image *image,const PixelMask type,
1099 const RectangleInfo *region,ExceptionInfo *exception)
1100 </samp></pre>
1101
1102 <p>A description of each parameter follows:</p>
1103
1104 <dd>
1105 </dd>
1106
1107 <dd> </dd>
1108 <dl class="dl-horizontal">
1109 <dt>image</dt>
1110 <dd>the image. </dd>
1111
1112 <dd> </dd>
1113 <dt>type</dt>
1114 <dd>the mask type, ReadPixelMask or WritePixelMask. </dd>
1115
1116 <dd> </dd>
1117 <dt>geometry</dt>
1118 <dd>the mask region. </dd>
1119
1120 <dd> </dd>
1121 <dt>exception</dt>
1122 <dd>return any errors or warnings in this structure. </dd>
1123
1124 <dd> </dd>
1125 </dl>
1126 <h2><a href="../../api/MagickCore/image_8c.html" id="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
1127
1128 <p>SetImageVirtualPixelMethod() sets the "virtual pixels" method for the image and returns the previous setting. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
1129
1130 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
1131
1132 <pre class="bg-light text-dark mx-4"><samp>VirtualPixelMethod SetImageVirtualPixelMethod(Image *image,
1133 const VirtualPixelMethod virtual_pixel_method,ExceptionInfo *exception)
1134 </samp></pre>
1135
1136 <p>A description of each parameter follows:</p>
1137
1138 <dd>
1139 </dd>
1140
1141 <dd> </dd>
1142 <dl class="dl-horizontal">
1143 <dt>image</dt>
1144 <dd>the image. </dd>
1145
1146 <dd> </dd>
1147 <dt>virtual_pixel_method</dt>
1148 <dd>choose the type of virtual pixel. </dd>
1149
1150 <dd> </dd>
1151 <dt>exception</dt>
1152 <dd>return any errors or warnings in this structure. </dd>
1153
1154 <dd> </dd>
1155 </dl>
1156 <h2><a href="../../api/MagickCore/image_8c.html" id="SmushImages">SmushImages</a></h2>
1157
1158 <p>SmushImages() takes all images from the current image pointer to the end of the image list and smushes them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
1159
1160 <p>The current gravity setting now effects how the image is justified in the final image.</p>
1161
1162 <p>The format of the SmushImages method is:</p>
1163
1164 <pre class="bg-light text-dark mx-4"><samp>Image *SmushImages(const Image *images,const MagickBooleanType stack,
1165 ExceptionInfo *exception)
1166 </samp></pre>
1167
1168 <p>A description of each parameter follows:</p>
1169
1170 <dd>
1171 </dd>
1172
1173 <dd> </dd>
1174 <dl class="dl-horizontal">
1175 <dt>images</dt>
1176 <dd>the image sequence. </dd>
1177
1178 <dd> </dd>
1179 <dt>stack</dt>
1180 <dd>A value other than 0 stacks the images top-to-bottom. </dd>
1181
1182 <dd> </dd>
1183 <dt>offset</dt>
1184 <dd>minimum distance in pixels between images. </dd>
1185
1186 <dd> </dd>
1187 <dt>exception</dt>
1188 <dd>return any errors or warnings in this structure. </dd>
1189
1190 <dd> </dd>
1191 </dl>
1192 <h2><a href="../../api/MagickCore/image_8c.html" id="StripImage">StripImage</a></h2>
1193
1194 <p>StripImage() strips an image of all profiles and comments.</p>
1195
1196 <p>The format of the StripImage method is:</p>
1197
1198 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType StripImage(Image *image,ExceptionInfo *exception)
1199 </samp></pre>
1200
1201 <p>A description of each parameter follows:</p>
1202
1203 <dd>
1204 </dd>
1205
1206 <dd> </dd>
1207 <dl class="dl-horizontal">
1208 <dt>image</dt>
1209 <dd>the image. </dd>
1210
1211 <dd> </dd>
1212 <dt>exception</dt>
1213 <dd>return any errors or warnings in this structure. </dd>
1214
1215 <dd> </dd>
1216 </dl>
1217 <h2><a href="../../api/MagickCore/image_8c.html" id="SyncImageSettings">SyncImageSettings</a></h2>
1218
1219 <p>SyncImageSettings() syncs any image_info global options into per-image attributes.</p>
1220
1221 <p>Note: in IMv6 free form 'options' were always mapped into 'artifacts', so that operations and coders can find such settings. In IMv7 if a desired per-image artifact is not set, then it will directly look for a global option as a fallback, as such this copy is no longer needed, only the link set up.</p>
1222
1223 <p>The format of the SyncImageSettings method is:</p>
1224
1225 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1226 Image *image,ExceptionInfo *exception)
1227 MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1228 Image *image,ExceptionInfo *exception)
1229 </samp></pre>
1230
1231 <p>A description of each parameter follows:</p>
1232
1233 <dd>
1234 </dd>
1235
1236 <dd> </dd>
1237 <dl class="dl-horizontal">
1238 <dt>image_info</dt>
1239 <dd>the image info. </dd>
1240
1241 <dd> </dd>
1242 <dt>image</dt>
1243 <dd>the image. </dd>
1244
1245 <dd> </dd>
1246 <dt>exception</dt>
1247 <dd>return any errors or warnings in this structure. </dd>
1248
1249 <dd> </dd>
1250 </dl>
1251 </div>
1252 </div>
1253 </main><!-- /.container -->
1254 <footer class="py-5 text-center text-body-secondary bg-body-tertiary">
1255 <div class="container-fluid">
1256 <a href="../www/security-policy.html">Security</a> •
1257 <a href="../www/news.html">News</a>
1258
1259 <a href="#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../../../../../images/wand.ico"/></a>
1260
1261 <a href="../www/links.html">Related</a> •
1262 <a href="../www/sitemap.html">Sitemap</a>
1263 <br/>
1264 <a href="../www/support.html">Sponsor</a> •
1265 <a href="../www/cite.html">Cite</a> •
1266 <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
1267 <a href="../www/contact.html">Contact Us</a>
1268 <br/>
1269 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
1270 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
1271 <br/>
1272 <small>Copyright © 1999 ImageMagick Studio LLC</small>
1273 </div>
1274 </footer>
1275 </div>
1276
1277 <!-- Javascript assets -->
1278 <script src="../assets/bootstrap.bundle.min.js" ></script>
1279 </body>
1280 </html>