Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 2c8396015846a8b80baa4772893cf50b36268276 / . / www / api / memory.html
blob: 72e8ff0e3bceb67c9e04f73a14ba97d0fb91f164 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame^]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame^]5 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Memory Allocation</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, memory, allocation, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy5e6c2fe2010-03-20 20:36:58 +0000[diff] [blame]127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
cristya6510532010-03-06 13:09:30 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<p class="navigation-index">[<a href="#AcquireAlignedMemory">AcquireAlignedMemory</a> &bull; <a href="#AcquireMagickMemory">AcquireMagickMemory</a> &bull; <a href="#AcquireQuantumMemory">AcquireQuantumMemory</a> &bull; <a href="#CopyMagickMemory">CopyMagickMemory</a> &bull; <a href="#GetMagickMemoryMethods">GetMagickMemoryMethods</a> &bull; <a href="#RelinquishAlignedMemory">RelinquishAlignedMemory</a> &bull; <a href="#RelinquishMagickMemory">RelinquishMagickMemory</a> &bull; <a href="#ResetMagickMemory">ResetMagickMemory</a> &bull; <a href="#ResizeMagickMemory">ResizeMagickMemory</a> &bull; <a href="#ResizeQuantumMemory">ResizeQuantumMemory</a> &bull; <a href="#SetMagickMemoryMethods">SetMagickMemoryMethods</a>]</p>
156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
158_8c.html" target="source" name="AcquireAlignedMemory">AcquireAlignedMemory</a></h2>
159<div class="doc-section">
160
161<p>AcquireAlignedMemory() returns a pointer to a block of memory at least size bytes whose address is a multiple of 16*sizeof(void *).</p></ol>
162
163<p>The format of the AcquireAlignedMemory method is:</p>
164
165<pre class="code">
166 void *AcquireAlignedMemory(const size_t count,const size_t quantum)
167</pre>
168
169<p>A description of each parameter follows:</p></ol>
170
171<h5>count</h5>
172<ol><p>the number of quantum elements to allocate.</p></ol>
173
174<h5>quantum</h5>
175<ol><p>the number of bytes in each quantum.</p></ol>
176
177 </div>
178<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
179_8c.html" target="source" name="AcquireMagickMemory">AcquireMagickMemory</a></h2>
180<div class="doc-section">
181
182<p>AcquireMagickMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
183
184<p>The format of the AcquireMagickMemory method is:</p>
185
186<pre class="code">
187 void *AcquireMagickMemory(const size_t size)
188</pre>
189
190<p>A description of each parameter follows:</p></ol>
191
192<h5>size</h5>
193<ol><p>the size of the memory in bytes to allocate.</p></ol>
194
195 </div>
196<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
197_8c.html" target="source" name="AcquireQuantumMemory">AcquireQuantumMemory</a></h2>
198<div class="doc-section">
199
200<p>AcquireQuantumMemory() returns a pointer to a block of memory at least count * quantum bytes suitably aligned for any use.</p></ol>
201
202<p>The format of the AcquireQuantumMemory method is:</p>
203
204<pre class="code">
205 void *AcquireQuantumMemory(const size_t count,const size_t quantum)
206</pre>
207
208<p>A description of each parameter follows:</p></ol>
209
210<h5>count</h5>
211<ol><p>the number of quantum elements to allocate.</p></ol>
212
213<h5>quantum</h5>
214<ol><p>the number of bytes in each quantum.</p></ol>
215
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
218_8c.html" target="source" name="CopyMagickMemory">CopyMagickMemory</a></h2>
219<div class="doc-section">
220
221<p>CopyMagickMemory() copies size bytes from memory area source to the destination. Copying between objects that overlap will take place correctly. It returns destination.</p></ol>
222
223<p>The format of the CopyMagickMemory method is:</p>
224
225<pre class="code">
226 void *CopyMagickMemory(void *destination,const void *source,
227 const size_t size)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>destination</h5>
233<ol><p>the destination.</p></ol>
234
235<h5>source</h5>
236<ol><p>the source.</p></ol>
237
238<h5>size</h5>
239<ol><p>the size of the memory in bytes to allocate.</p></ol>
240
241 </div>
242<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
243_8c.html" target="source" name="GetMagickMemoryMethods">GetMagickMemoryMethods</a></h2>
244<div class="doc-section">
245
246<p>GetMagickMemoryMethods() gets the methods to acquire, resize, and destroy memory.</p></ol>
247
248<p>The format of the GetMagickMemoryMethods() method is:</p>
249
250<pre class="code">
251 void GetMagickMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
252 ResizeMemoryHandler *resize_memory_handler,
253 DestroyMemoryHandler *destroy_memory_handler)
254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>acquire_memory_handler</h5>
259<ol><p>method to acquire memory (e.g. malloc).</p></ol>
260
261<h5>resize_memory_handler</h5>
262<ol><p>method to resize memory (e.g. realloc).</p></ol>
263
264<h5>destroy_memory_handler</h5>
265<ol><p>method to destroy memory (e.g. free).</p></ol>
266
267 </div>
268<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
269_8c.html" target="source" name="RelinquishAlignedMemory">RelinquishAlignedMemory</a></h2>
270<div class="doc-section">
271
272<p>RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory() or reuse.</p></ol>
273
274<p>The format of the RelinquishAlignedMemory method is:</p>
275
276<pre class="code">
277 void *RelinquishAlignedMemory(void *memory)
278</pre>
279
280<p>A description of each parameter follows:</p></ol>
281
282<h5>memory</h5>
283<ol><p>A pointer to a block of memory to free for reuse.</p></ol>
284
285 </div>
286<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
287_8c.html" target="source" name="RelinquishMagickMemory">RelinquishMagickMemory</a></h2>
288<div class="doc-section">
289
290<p>RelinquishMagickMemory() frees memory acquired with AcquireMagickMemory() or AcquireQuantumMemory() for reuse.</p></ol>
291
292<p>The format of the RelinquishMagickMemory method is:</p>
293
294<pre class="code">
295 void *RelinquishMagickMemory(void *memory)
296</pre>
297
298<p>A description of each parameter follows:</p></ol>
299
300<h5>memory</h5>
301<ol><p>A pointer to a block of memory to free for reuse.</p></ol>
302
303 </div>
304<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
305_8c.html" target="source" name="ResetMagickMemory">ResetMagickMemory</a></h2>
306<div class="doc-section">
307
308<p>ResetMagickMemory() fills the first size bytes of the memory area pointed to by memory with the constant byte c.</p></ol>
309
310<p>The format of the ResetMagickMemory method is:</p>
311
312<pre class="code">
313 void *ResetMagickMemory(void *memory,int byte,const size_t size)
314</pre>
315
316<p>A description of each parameter follows:</p></ol>
317
318<h5>memory</h5>
319<ol><p>A pointer to a memory allocation.</p></ol>
320
321<h5>byte</h5>
322<ol><p>Set the memory to this value.</p></ol>
323
324<h5>size</h5>
325<ol><p>Size of the memory to reset.</p></ol>
326
327 </div>
328<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
329_8c.html" target="source" name="ResizeMagickMemory">ResizeMagickMemory</a></h2>
330<div class="doc-section">
331
332<p>ResizeMagickMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.</p></ol>
333
334<p>The format of the ResizeMagickMemory method is:</p>
335
336<pre class="code">
337 void *ResizeMagickMemory(void *memory,const size_t size)
338</pre>
339
340<p>A description of each parameter follows:</p></ol>
341
342<h5>memory</h5>
343<ol><p>A pointer to a memory allocation.</p></ol>
344
345<h5>size</h5>
346<ol><p>the new size of the allocated memory.</p></ol>
347
348 </div>
349<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
350_8c.html" target="source" name="ResizeQuantumMemory">ResizeQuantumMemory</a></h2>
351<div class="doc-section">
352
353<p>ResizeQuantumMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.</p></ol>
354
355<p>The format of the ResizeQuantumMemory method is:</p>
356
357<pre class="code">
358 void *ResizeQuantumMemory(void *memory,const size_t count,
359 const size_t quantum)
360</pre>
361
362<p>A description of each parameter follows:</p></ol>
363
364<h5>memory</h5>
365<ol><p>A pointer to a memory allocation.</p></ol>
366
367<h5>count</h5>
368<ol><p>the number of quantum elements to allocate.</p></ol>
369
370<h5>quantum</h5>
371<ol><p>the number of bytes in each quantum.</p></ol>
372
373 </div>
374<h2><a href="http://www.imagemagick.org/api/MagickCore/memory
375_8c.html" target="source" name="SetMagickMemoryMethods">SetMagickMemoryMethods</a></h2>
376<div class="doc-section">
377
378<p>SetMagickMemoryMethods() sets the methods to acquire, resize, and destroy memory.</p></ol>
379
380<p>The format of the SetMagickMemoryMethods() method is:</p>
381
382<pre class="code">
383 SetMagickMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
384 ResizeMemoryHandler resize_memory_handler,
385 DestroyMemoryHandler destroy_memory_handler)
386</pre>
387
388<p>A description of each parameter follows:</p></ol>
389
390<h5>acquire_memory_handler</h5>
391<ol><p>method to acquire memory (e.g. malloc).</p></ol>
392
393<h5>resize_memory_handler</h5>
394<ol><p>method to resize memory (e.g. realloc).</p></ol>
395
396<h5>destroy_memory_handler</h5>
397<ol><p>method to destroy memory (e.g. free).</p></ol>
398
399 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]400
401</div>
402
403<div id="linkbar">
404 <!-- <span id="linkbar-west">&nbsp;</span> -->
405 <span id="linkbar-center">
406 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy37f02952010-03-24 19:47:41 +0000[diff] [blame]407 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]408 </span>
409 <span id="linkbar-east">&nbsp;</span>
410 </div>
411 <div class="footer">
412 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
413 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
414 </div>
415 <div style="clear: both; margin: 0; width: 100%; "></div>
416</body>
417</html>