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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  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"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 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>
 400 \r
 401 </div>\r
 402 \r
 403 <div id="linkbar">\r
 404  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 405     <span id="linkbar-center">\r
 406       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 407     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 408     </span>\r
 409     <span id="linkbar-east">&nbsp;</span>\r
 410   </div>\r
 411   <div class="footer">\r
 412     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 413     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 414   </div>\r
 415   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 416 </body>\r
 417 </html>\r