Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / af8d6655e12345c48d687558c0665070d206a942 / . / www / api / memory.html
blob: 445d2f0fc25f0fad114e89668fd087de94903a85 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Memory Allocation</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]12 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]55 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]57 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]59 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]61 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]64<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]71 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
78</div>
79<div class="sub">
80 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
81</div>
82<div class="sep"></div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]138 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]146 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
149 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
150</div>
151<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]158 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
159</div>
160<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame^]167 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]168</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169</div>
170</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]172
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177 google_ad_slot = "0574824969";
178 google_ad_width = 160;
179 google_ad_height = 600;
180 //-->
181 </script>
182 <script type="text/javascript"
183 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
184 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]189<h1>Module memory
190 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]191<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>
192
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]193<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
194_8c.html" id="AcquireAlignedMemory">AcquireAlignedMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195<div class="doc-section">
196
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<p>AcquireAlignedMemory() returns a pointer to a block of memory at least size bytes whose address is a multiple of 16*sizeof(void *).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199<p>The format of the AcquireAlignedMemory method is:</p>
200
201<pre class="code">
202 void *AcquireAlignedMemory(const size_t count,const size_t quantum)
203</pre>
204
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]205<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]206
207<h5>count</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]208<p>the number of quantum elements to allocate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209
210<h5>quantum</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]211<p>the number of bytes in each quantum.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]214<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
215_8c.html" id="AcquireMagickMemory">AcquireMagickMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216<div class="doc-section">
217
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]218<p>AcquireMagickMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220<p>The format of the AcquireMagickMemory method is:</p>
221
222<pre class="code">
223 void *AcquireMagickMemory(const size_t size)
224</pre>
225
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]226<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]227
228<h5>size</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]229<p>the size of the memory in bytes to allocate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]230
231 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]232<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
233_8c.html" id="AcquireQuantumMemory">AcquireQuantumMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234<div class="doc-section">
235
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<p>AcquireQuantumMemory() returns a pointer to a block of memory at least count * quantum bytes suitably aligned for any use.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238<p>The format of the AcquireQuantumMemory method is:</p>
239
240<pre class="code">
241 void *AcquireQuantumMemory(const size_t count,const size_t quantum)
242</pre>
243
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]244<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
246<h5>count</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]247<p>the number of quantum elements to allocate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]248
249<h5>quantum</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]250<p>the number of bytes in each quantum.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]251
252 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]253<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
254_8c.html" id="CopyMagickMemory">CopyMagickMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255<div class="doc-section">
256
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258
259<p>The format of the CopyMagickMemory method is:</p>
260
261<pre class="code">
262 void *CopyMagickMemory(void *destination,const void *source,
263 const size_t size)
264</pre>
265
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]266<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]267
268<h5>destination</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]269<p>the destination.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270
271<h5>source</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]272<p>the source.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273
274<h5>size</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]275<p>the size of the memory in bytes to allocate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276
277 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]278<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
279_8c.html" id="GetMagickMemoryMethods">GetMagickMemoryMethods</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280<div class="doc-section">
281
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]282<p>GetMagickMemoryMethods() gets the methods to acquire, resize, and destroy memory.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]283
284<p>The format of the GetMagickMemoryMethods() method is:</p>
285
286<pre class="code">
287 void GetMagickMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
288 ResizeMemoryHandler *resize_memory_handler,
289 DestroyMemoryHandler *destroy_memory_handler)
290</pre>
291
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]292<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293
294<h5>acquire_memory_handler</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]295<p>method to acquire memory (e.g. malloc).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]296
297<h5>resize_memory_handler</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]298<p>method to resize memory (e.g. realloc).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]299
300<h5>destroy_memory_handler</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]301<p>method to destroy memory (e.g. free).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]302
303 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]304<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
305_8c.html" id="RelinquishAlignedMemory">RelinquishAlignedMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]306<div class="doc-section">
307
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]308<p>RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory() or reuse.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]309
310<p>The format of the RelinquishAlignedMemory method is:</p>
311
312<pre class="code">
313 void *RelinquishAlignedMemory(void *memory)
314</pre>
315
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]316<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]317
318<h5>memory</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]319<p>A pointer to a block of memory to free for reuse.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]320
321 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]322<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
323_8c.html" id="RelinquishMagickMemory">RelinquishMagickMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324<div class="doc-section">
325
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]326<p>RelinquishMagickMemory() frees memory acquired with AcquireMagickMemory() or AcquireQuantumMemory() for reuse.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]327
328<p>The format of the RelinquishMagickMemory method is:</p>
329
330<pre class="code">
331 void *RelinquishMagickMemory(void *memory)
332</pre>
333
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]334<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335
336<h5>memory</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<p>A pointer to a block of memory to free for reuse.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
339 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]340<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
341_8c.html" id="ResetMagickMemory">ResetMagickMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]342<div class="doc-section">
343
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]344<p>ResetMagickMemory() fills the first size bytes of the memory area pointed to by memory with the constant byte c.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]345
346<p>The format of the ResetMagickMemory method is:</p>
347
348<pre class="code">
349 void *ResetMagickMemory(void *memory,int byte,const size_t size)
350</pre>
351
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]352<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]353
354<h5>memory</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]355<p>A pointer to a memory allocation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]356
357<h5>byte</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]358<p>Set the memory to this value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]359
360<h5>size</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]361<p>Size of the memory to reset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]362
363 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]364<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
365_8c.html" id="ResizeMagickMemory">ResizeMagickMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]366<div class="doc-section">
367
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]368<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]369
370<p>The format of the ResizeMagickMemory method is:</p>
371
372<pre class="code">
373 void *ResizeMagickMemory(void *memory,const size_t size)
374</pre>
375
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]376<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]377
378<h5>memory</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]379<p>A pointer to a memory allocation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]380
381<h5>size</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]382<p>the new size of the allocated memory.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]383
384 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]385<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
386_8c.html" id="ResizeQuantumMemory">ResizeQuantumMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]387<div class="doc-section">
388
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]389<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]390
391<p>The format of the ResizeQuantumMemory method is:</p>
392
393<pre class="code">
394 void *ResizeQuantumMemory(void *memory,const size_t count,
395 const size_t quantum)
396</pre>
397
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]398<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]399
400<h5>memory</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]401<p>A pointer to a memory allocation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]402
403<h5>count</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]404<p>the number of quantum elements to allocate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]405
406<h5>quantum</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]407<p>the number of bytes in each quantum.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]408
409 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]410<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/memory
411_8c.html" id="SetMagickMemoryMethods">SetMagickMemoryMethods</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]412<div class="doc-section">
413
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]414<p>SetMagickMemoryMethods() sets the methods to acquire, resize, and destroy memory.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]415
416<p>The format of the SetMagickMemoryMethods() method is:</p>
417
418<pre class="code">
419 SetMagickMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
420 ResizeMemoryHandler resize_memory_handler,
421 DestroyMemoryHandler destroy_memory_handler)
422</pre>
423
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]424<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]425
426<h5>acquire_memory_handler</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]427<p>method to acquire memory (e.g. malloc).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]428
429<h5>resize_memory_handler</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]430<p>method to resize memory (e.g. realloc).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]431
432<h5>destroy_memory_handler</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]433<p>method to destroy memory (e.g. free).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]434
435 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]436
437</div>
438
439<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]440 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]441 <span id="linkbar-center">
442 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]443 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]444 </span>
445 <span id="linkbar-east">&nbsp;</span>
446 </div>
447 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]448 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]449 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
450 </div>
451 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]452 <script type="text/javascript">
453 var _gaq = _gaq || [];
454 _gaq.push(['_setAccount', 'UA-17690367-1']);
455 _gaq.push(['_trackPageview']);
456
457 (function() {
458 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
459 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
460 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
461 })();
462 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]463</body>
464</html>