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">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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 href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 137 </div>
 138 <div  class="sponsor">
 139    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 140 </div>
 141 <div  class="sponsor">
 142    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 </div>
 145 </div>
 146 \r
 147 \r
 148 </div>\r
 149 \r
 150 <div class="main">\r
 151 \r
 152 <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>
 153
 154 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 155 _8c.html" target="source" name="AcquireAlignedMemory">AcquireAlignedMemory</a></h2>
 156 <div class="doc-section">
 157
 158 <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>
 159
 160 <p>The format of the AcquireAlignedMemory method is:</p>
 161
 162 <pre class="code">
 163   void *AcquireAlignedMemory(const size_t count,const size_t quantum)
 164 </pre>
 165
 166 <p>A description of each parameter follows:</p></ol>
 167
 168 <h5>count</h5>
 169 <ol><p>the number of quantum elements to allocate.</p></ol>
 170
 171 <h5>quantum</h5>
 172 <ol><p>the number of bytes in each quantum.</p></ol>
 173
 174  </div>
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 176 _8c.html" target="source" name="AcquireMagickMemory">AcquireMagickMemory</a></h2>
 177 <div class="doc-section">
 178
 179 <p>AcquireMagickMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
 180
 181 <p>The format of the AcquireMagickMemory method is:</p>
 182
 183 <pre class="code">
 184   void *AcquireMagickMemory(const size_t size)
 185 </pre>
 186
 187 <p>A description of each parameter follows:</p></ol>
 188
 189 <h5>size</h5>
 190 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 191
 192  </div>
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 194 _8c.html" target="source" name="AcquireQuantumMemory">AcquireQuantumMemory</a></h2>
 195 <div class="doc-section">
 196
 197 <p>AcquireQuantumMemory() returns a pointer to a block of memory at least count * quantum bytes suitably aligned for any use.</p></ol>
 198
 199 <p>The format of the AcquireQuantumMemory method is:</p>
 200
 201 <pre class="code">
 202   void *AcquireQuantumMemory(const size_t count,const size_t quantum)
 203 </pre>
 204
 205 <p>A description of each parameter follows:</p></ol>
 206
 207 <h5>count</h5>
 208 <ol><p>the number of quantum elements to allocate.</p></ol>
 209
 210 <h5>quantum</h5>
 211 <ol><p>the number of bytes in each quantum.</p></ol>
 212
 213  </div>
 214 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 215 _8c.html" target="source" name="CopyMagickMemory">CopyMagickMemory</a></h2>
 216 <div class="doc-section">
 217
 218 <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>
 219
 220 <p>The format of the CopyMagickMemory method is:</p>
 221
 222 <pre class="code">
 223   void *CopyMagickMemory(void *destination,const void *source,
 224     const size_t size)
 225 </pre>
 226
 227 <p>A description of each parameter follows:</p></ol>
 228
 229 <h5>destination</h5>
 230 <ol><p>the destination.</p></ol>
 231
 232 <h5>source</h5>
 233 <ol><p>the source.</p></ol>
 234
 235 <h5>size</h5>
 236 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 237
 238  </div>
 239 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 240 _8c.html" target="source" name="GetMagickMemoryMethods">GetMagickMemoryMethods</a></h2>
 241 <div class="doc-section">
 242
 243 <p>GetMagickMemoryMethods() gets the methods to acquire, resize, and destroy memory.</p></ol>
 244
 245 <p>The format of the GetMagickMemoryMethods() method is:</p>
 246
 247 <pre class="code">
 248   void GetMagickMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
 249     ResizeMemoryHandler *resize_memory_handler,
 250     DestroyMemoryHandler *destroy_memory_handler)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p></ol>
 254
 255 <h5>acquire_memory_handler</h5>
 256 <ol><p>method to acquire memory (e.g. malloc).</p></ol>
 257
 258 <h5>resize_memory_handler</h5>
 259 <ol><p>method to resize memory (e.g. realloc).</p></ol>
 260
 261 <h5>destroy_memory_handler</h5>
 262 <ol><p>method to destroy memory (e.g. free).</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 266 _8c.html" target="source" name="RelinquishAlignedMemory">RelinquishAlignedMemory</a></h2>
 267 <div class="doc-section">
 268
 269 <p>RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory() or reuse.</p></ol>
 270
 271 <p>The format of the RelinquishAlignedMemory method is:</p>
 272
 273 <pre class="code">
 274   void *RelinquishAlignedMemory(void *memory)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p></ol>
 278
 279 <h5>memory</h5>
 280 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 284 _8c.html" target="source" name="RelinquishMagickMemory">RelinquishMagickMemory</a></h2>
 285 <div class="doc-section">
 286
 287 <p>RelinquishMagickMemory() frees memory acquired with AcquireMagickMemory() or AcquireQuantumMemory() for reuse.</p></ol>
 288
 289 <p>The format of the RelinquishMagickMemory method is:</p>
 290
 291 <pre class="code">
 292   void *RelinquishMagickMemory(void *memory)
 293 </pre>
 294
 295 <p>A description of each parameter follows:</p></ol>
 296
 297 <h5>memory</h5>
 298 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
 299
 300  </div>
 301 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 302 _8c.html" target="source" name="ResetMagickMemory">ResetMagickMemory</a></h2>
 303 <div class="doc-section">
 304
 305 <p>ResetMagickMemory() fills the first size bytes of the memory area pointed to by memory with the constant byte c.</p></ol>
 306
 307 <p>The format of the ResetMagickMemory method is:</p>
 308
 309 <pre class="code">
 310   void *ResetMagickMemory(void *memory,int byte,const size_t size)
 311 </pre>
 312
 313 <p>A description of each parameter follows:</p></ol>
 314
 315 <h5>memory</h5>
 316 <ol><p>A pointer to a memory allocation.</p></ol>
 317
 318 <h5>byte</h5>
 319 <ol><p>Set the memory to this value.</p></ol>
 320
 321 <h5>size</h5>
 322 <ol><p>Size of the memory to reset.</p></ol>
 323
 324  </div>
 325 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 326 _8c.html" target="source" name="ResizeMagickMemory">ResizeMagickMemory</a></h2>
 327 <div class="doc-section">
 328
 329 <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>
 330
 331 <p>The format of the ResizeMagickMemory method is:</p>
 332
 333 <pre class="code">
 334   void *ResizeMagickMemory(void *memory,const size_t size)
 335 </pre>
 336
 337 <p>A description of each parameter follows:</p></ol>
 338
 339 <h5>memory</h5>
 340 <ol><p>A pointer to a memory allocation.</p></ol>
 341
 342 <h5>size</h5>
 343 <ol><p>the new size of the allocated memory.</p></ol>
 344
 345  </div>
 346 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 347 _8c.html" target="source" name="ResizeQuantumMemory">ResizeQuantumMemory</a></h2>
 348 <div class="doc-section">
 349
 350 <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>
 351
 352 <p>The format of the ResizeQuantumMemory method is:</p>
 353
 354 <pre class="code">
 355   void *ResizeQuantumMemory(void *memory,const size_t count,
 356     const size_t quantum)
 357 </pre>
 358
 359 <p>A description of each parameter follows:</p></ol>
 360
 361 <h5>memory</h5>
 362 <ol><p>A pointer to a memory allocation.</p></ol>
 363
 364 <h5>count</h5>
 365 <ol><p>the number of quantum elements to allocate.</p></ol>
 366
 367 <h5>quantum</h5>
 368 <ol><p>the number of bytes in each quantum.</p></ol>
 369
 370  </div>
 371 <h2><a href="http://www.imagemagick.org/api/MagickCore/memory
 372 _8c.html" target="source" name="SetMagickMemoryMethods">SetMagickMemoryMethods</a></h2>
 373 <div class="doc-section">
 374
 375 <p>SetMagickMemoryMethods() sets the methods to acquire, resize, and destroy memory.</p></ol>
 376
 377 <p>The format of the SetMagickMemoryMethods() method is:</p>
 378
 379 <pre class="code">
 380   SetMagickMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
 381     ResizeMemoryHandler resize_memory_handler,
 382     DestroyMemoryHandler destroy_memory_handler)
 383 </pre>
 384
 385 <p>A description of each parameter follows:</p></ol>
 386
 387 <h5>acquire_memory_handler</h5>
 388 <ol><p>method to acquire memory (e.g. malloc).</p></ol>
 389
 390 <h5>resize_memory_handler</h5>
 391 <ol><p>method to resize memory (e.g. realloc).</p></ol>
 392
 393 <h5>destroy_memory_handler</h5>
 394 <ol><p>method to destroy memory (e.g. free).</p></ol>
 395
 396  </div>
 397 \r
 398 </div>\r
 399 \r
 400 <div id="linkbar">\r
 401  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 402     <span id="linkbar-center">\r
 403       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 404     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 405     </span>\r
 406     <span id="linkbar-east">&nbsp;</span>\r
 407   </div>\r
 408   <div class="footer">\r
 409     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 410     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 411   </div>\r
 412   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 413 </body>\r
 414 </html>\r