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