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   <title>ImageMagick: MagickCore, C API for ImageMagick: Memory Allocation</title/>
   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"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  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"/>
  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"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  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"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 <div  class="sponsor">
 151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 152 </div>
 153 </div>
 154 </div>
 155 </div>\r
 156 \r
 157 <div class="eastbar">\r
 158   <script type="text/javascript">\r
 159   <!--\r
 160     google_ad_client = "pub-3129977114552745";\r
 161     google_ad_slot = "0574824969";\r
 162     google_ad_width = 160;\r
 163     google_ad_height = 600;\r
 164   //-->\r
 165   </script>\r
 166   <script type="text/javascript"\r
 167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 168   </script>\r
 169 </div>\r
 170 \r
 171 <div class="main">\r
 172 \r
 173 <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>
 174
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 176 _8c.html" target="source" name="AcquireAlignedMemory">AcquireAlignedMemory</a></h2>
 177 <div class="doc-section">
 178
 179 <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>
 180
 181 <p>The format of the AcquireAlignedMemory method is:</p>
 182
 183 <pre class="code">
 184   void *AcquireAlignedMemory(const size_t count,const size_t quantum)
 185 </pre>
 186
 187 <p>A description of each parameter follows:</p></ol>
 188
 189 <h5>count</h5>
 190 <ol><p>the number of quantum elements to allocate.</p></ol>
 191
 192 <h5>quantum</h5>
 193 <ol><p>the number of bytes in each quantum.</p></ol>
 194
 195  </div>
 196 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 197 _8c.html" target="source" name="AcquireMagickMemory">AcquireMagickMemory</a></h2>
 198 <div class="doc-section">
 199
 200 <p>AcquireMagickMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
 201
 202 <p>The format of the AcquireMagickMemory method is:</p>
 203
 204 <pre class="code">
 205   void *AcquireMagickMemory(const size_t size)
 206 </pre>
 207
 208 <p>A description of each parameter follows:</p></ol>
 209
 210 <h5>size</h5>
 211 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 212
 213  </div>
 214 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 215 _8c.html" target="source" name="AcquireQuantumMemory">AcquireQuantumMemory</a></h2>
 216 <div class="doc-section">
 217
 218 <p>AcquireQuantumMemory() returns a pointer to a block of memory at least count * quantum bytes suitably aligned for any use.</p></ol>
 219
 220 <p>The format of the AcquireQuantumMemory method is:</p>
 221
 222 <pre class="code">
 223   void *AcquireQuantumMemory(const size_t count,const size_t quantum)
 224 </pre>
 225
 226 <p>A description of each parameter follows:</p></ol>
 227
 228 <h5>count</h5>
 229 <ol><p>the number of quantum elements to allocate.</p></ol>
 230
 231 <h5>quantum</h5>
 232 <ol><p>the number of bytes in each quantum.</p></ol>
 233
 234  </div>
 235 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 236 _8c.html" target="source" name="CopyMagickMemory">CopyMagickMemory</a></h2>
 237 <div class="doc-section">
 238
 239 <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>
 240
 241 <p>The format of the CopyMagickMemory method is:</p>
 242
 243 <pre class="code">
 244   void *CopyMagickMemory(void *destination,const void *source,
 245     const size_t size)
 246 </pre>
 247
 248 <p>A description of each parameter follows:</p></ol>
 249
 250 <h5>destination</h5>
 251 <ol><p>the destination.</p></ol>
 252
 253 <h5>source</h5>
 254 <ol><p>the source.</p></ol>
 255
 256 <h5>size</h5>
 257 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 258
 259  </div>
 260 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 261 _8c.html" target="source" name="GetMagickMemoryMethods">GetMagickMemoryMethods</a></h2>
 262 <div class="doc-section">
 263
 264 <p>GetMagickMemoryMethods() gets the methods to acquire, resize, and destroy memory.</p></ol>
 265
 266 <p>The format of the GetMagickMemoryMethods() method is:</p>
 267
 268 <pre class="code">
 269   void GetMagickMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
 270     ResizeMemoryHandler *resize_memory_handler,
 271     DestroyMemoryHandler *destroy_memory_handler)
 272 </pre>
 273
 274 <p>A description of each parameter follows:</p></ol>
 275
 276 <h5>acquire_memory_handler</h5>
 277 <ol><p>method to acquire memory (e.g. malloc).</p></ol>
 278
 279 <h5>resize_memory_handler</h5>
 280 <ol><p>method to resize memory (e.g. realloc).</p></ol>
 281
 282 <h5>destroy_memory_handler</h5>
 283 <ol><p>method to destroy memory (e.g. free).</p></ol>
 284
 285  </div>
 286 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 287 _8c.html" target="source" name="RelinquishAlignedMemory">RelinquishAlignedMemory</a></h2>
 288 <div class="doc-section">
 289
 290 <p>RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory() or reuse.</p></ol>
 291
 292 <p>The format of the RelinquishAlignedMemory method is:</p>
 293
 294 <pre class="code">
 295   void *RelinquishAlignedMemory(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="RelinquishMagickMemory">RelinquishMagickMemory</a></h2>
 306 <div class="doc-section">
 307
 308 <p>RelinquishMagickMemory() frees memory acquired with AcquireMagickMemory() or AcquireQuantumMemory() for reuse.</p></ol>
 309
 310 <p>The format of the RelinquishMagickMemory method is:</p>
 311
 312 <pre class="code">
 313   void *RelinquishMagickMemory(void *memory)
 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 block of memory to free for reuse.</p></ol>
 320
 321  </div>
 322 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 323 _8c.html" target="source" name="ResetMagickMemory">ResetMagickMemory</a></h2>
 324 <div class="doc-section">
 325
 326 <p>ResetMagickMemory() fills the first size bytes of the memory area pointed to by memory with the constant byte c.</p></ol>
 327
 328 <p>The format of the ResetMagickMemory method is:</p>
 329
 330 <pre class="code">
 331   void *ResetMagickMemory(void *memory,int byte,const size_t size)
 332 </pre>
 333
 334 <p>A description of each parameter follows:</p></ol>
 335
 336 <h5>memory</h5>
 337 <ol><p>A pointer to a memory allocation.</p></ol>
 338
 339 <h5>byte</h5>
 340 <ol><p>Set the memory to this value.</p></ol>
 341
 342 <h5>size</h5>
 343 <ol><p>Size of the memory to reset.</p></ol>
 344
 345  </div>
 346 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 347 _8c.html" target="source" name="ResizeMagickMemory">ResizeMagickMemory</a></h2>
 348 <div class="doc-section">
 349
 350 <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>
 351
 352 <p>The format of the ResizeMagickMemory method is:</p>
 353
 354 <pre class="code">
 355   void *ResizeMagickMemory(void *memory,const size_t size)
 356 </pre>
 357
 358 <p>A description of each parameter follows:</p></ol>
 359
 360 <h5>memory</h5>
 361 <ol><p>A pointer to a memory allocation.</p></ol>
 362
 363 <h5>size</h5>
 364 <ol><p>the new size of the allocated memory.</p></ol>
 365
 366  </div>
 367 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 368 _8c.html" target="source" name="ResizeQuantumMemory">ResizeQuantumMemory</a></h2>
 369 <div class="doc-section">
 370
 371 <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>
 372
 373 <p>The format of the ResizeQuantumMemory method is:</p>
 374
 375 <pre class="code">
 376   void *ResizeQuantumMemory(void *memory,const size_t count,
 377     const size_t quantum)
 378 </pre>
 379
 380 <p>A description of each parameter follows:</p></ol>
 381
 382 <h5>memory</h5>
 383 <ol><p>A pointer to a memory allocation.</p></ol>
 384
 385 <h5>count</h5>
 386 <ol><p>the number of quantum elements to allocate.</p></ol>
 387
 388 <h5>quantum</h5>
 389 <ol><p>the number of bytes in each quantum.</p></ol>
 390
 391  </div>
 392 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 393 _8c.html" target="source" name="SetMagickMemoryMethods">SetMagickMemoryMethods</a></h2>
 394 <div class="doc-section">
 395
 396 <p>SetMagickMemoryMethods() sets the methods to acquire, resize, and destroy memory.</p></ol>
 397
 398 <p>The format of the SetMagickMemoryMethods() method is:</p>
 399
 400 <pre class="code">
 401   SetMagickMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
 402     ResizeMemoryHandler resize_memory_handler,
 403     DestroyMemoryHandler destroy_memory_handler)
 404 </pre>
 405
 406 <p>A description of each parameter follows:</p></ol>
 407
 408 <h5>acquire_memory_handler</h5>
 409 <ol><p>method to acquire memory (e.g. malloc).</p></ol>
 410
 411 <h5>resize_memory_handler</h5>
 412 <ol><p>method to resize memory (e.g. realloc).</p></ol>
 413
 414 <h5>destroy_memory_handler</h5>
 415 <ol><p>method to destroy memory (e.g. free).</p></ol>
 416
 417  </div>
 418 \r
 419 </div>\r
 420 \r
 421 <div id="linkbar">\r
 422     <span id="linkbar-west">&nbsp;</span>\r
 423     <span id="linkbar-center">\r
 424       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 425       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 426     </span>\r
 427     <span id="linkbar-east">&nbsp;</span>\r
 428   </div>\r
 429   <div class="footer">\r
 430     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 431     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 432   </div>\r
 433   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 434   <script type="text/javascript">\r
 435     var _gaq = _gaq || [];\r
 436     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 437     _gaq.push(['_trackPageview']);\r
 438 \r
 439     (function() {\r
 440       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 441       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 442       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 443     })();\r
 444   </script>\r
 445 </body>\r
 446 </html>\r