granicus.if.org Git - imagemagick/blob - www/api/memory.html

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