granicus.if.org Git - imagemagick/blob - www/api/transform.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 name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</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="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, transform, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#Chop">Chop</a> &bull; <a href="#CropImage">CropImage</a> &bull; <a href="#ExcerptImage">ExcerptImage</a> &bull; <a href="#ExtentImage">ExtentImage</a> &bull; <a href="#FlipImage">FlipImage</a> &bull; <a href="#FlopImage">FlopImage</a> &bull; <a href="#RollImage">RollImage</a> &bull; <a href="#ShaveImage">ShaveImage</a> &bull; <a href="#SpliceImage">SpliceImage</a> &bull; <a href="#TransformImage">TransformImage</a> &bull; <a href="#TransformImages">TransformImages</a> &bull; <a href="#TransposeImage">TransposeImage</a> &bull; <a href="#TransverseImage">TransverseImage</a> &bull; <a href="#TrimImage">TrimImage</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 157 _8c.html" target="source" name="Chop">Chop</a></h2>
 158 <div class="doc-section">
 159
 160 <p>Chop() removes a region of an image and collapses the image to occupy the removed portion.</p></ol>
 161
 162 <p>The format of the ChopImage method is:</p>
 163
 164 <pre class="code">
 165   Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
 166     ExceptionInfo *exception)
 167 </pre>
 168
 169 <p>A description of each parameter follows:</p></ol>
 170
 171 <h5>image</h5>
 172 <ol><p>the image.</p></ol>
 173
 174 <h5>chop_info</h5>
 175 <ol><p>Define the region of the image to chop.</p></ol>
 176
 177 <h5>exception</h5>
 178 <ol><p>return any errors or warnings in this structure.</p></ol>
 179
 180  </div>
 181 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 182 _8c.html" target="source" name="CropImage">CropImage</a></h2>
 183 <div class="doc-section">
 184
 185 <p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p></ol>
 186
 187 <p>The format of the CropImage method is:</p>
 188
 189 <pre class="code">
 190   Image *CropImage(const Image *image,const RectangleInfo *geometry,
 191     ExceptionInfo *exception)
 192 </pre>
 193
 194 <p>A description of each parameter follows:</p></ol>
 195
 196 <h5>image</h5>
 197 <ol><p>the image.</p></ol>
 198
 199 <h5>geometry</h5>
 200 <ol><p>Define the region of the image to crop with members x, y, width, and height.</p></ol>
 201
 202 <h5>exception</h5>
 203 <ol><p>return any errors or warnings in this structure.</p></ol>
 204
 205  </div>
 206 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 207 _8c.html" target="source" name="ExcerptImage">ExcerptImage</a></h2>
 208 <div class="doc-section">
 209
 210 <p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p></ol>
 211
 212 <p>The format of the ExcerptImage method is:</p>
 213
 214 <pre class="code">
 215   Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
 216     ExceptionInfo *exception)
 217 </pre>
 218
 219 <p>A description of each parameter follows:</p></ol>
 220
 221 <h5>image</h5>
 222 <ol><p>the image.</p></ol>
 223
 224 <h5>geometry</h5>
 225 <ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
 226
 227 <h5>exception</h5>
 228 <ol><p>return any errors or warnings in this structure.</p></ol>
 229
 230  </div>
 231 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 232 _8c.html" target="source" name="ExtentImage">ExtentImage</a></h2>
 233 <div class="doc-section">
 234
 235 <p>ExtentImage() extends the image as defined by the geometry, gravity, and image background color.  Set the (x,y) offset of the geometry to move the original image relative to the extended image.</p></ol>
 236
 237 <p>The format of the ExtentImage method is:</p>
 238
 239 <pre class="code">
 240   Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
 241     ExceptionInfo *exception)
 242 </pre>
 243
 244 <p>A description of each parameter follows:</p></ol>
 245
 246 <h5>image</h5>
 247 <ol><p>the image.</p></ol>
 248
 249 <h5>geometry</h5>
 250 <ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
 251
 252 <h5>exception</h5>
 253 <ol><p>return any errors or warnings in this structure.</p></ol>
 254
 255  </div>
 256 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 257 _8c.html" target="source" name="FlipImage">FlipImage</a></h2>
 258 <div class="doc-section">
 259
 260 <p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p></ol>
 261
 262 <p>The format of the FlipImage method is:</p>
 263
 264 <pre class="code">
 265   Image *FlipImage(const Image *image,ExceptionInfo *exception)
 266 </pre>
 267
 268 <p>A description of each parameter follows:</p></ol>
 269
 270 <h5>image</h5>
 271 <ol><p>the image.</p></ol>
 272
 273 <h5>exception</h5>
 274 <ol><p>return any errors or warnings in this structure.</p></ol>
 275
 276  </div>
 277 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 278 _8c.html" target="source" name="FlopImage">FlopImage</a></h2>
 279 <div class="doc-section">
 280
 281 <p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p></ol>
 282
 283 <p>The format of the FlopImage method is:</p>
 284
 285 <pre class="code">
 286   Image *FlopImage(const Image *image,ExceptionInfo *exception)
 287 </pre>
 288
 289 <p>A description of each parameter follows:</p></ol>
 290
 291 <h5>image</h5>
 292 <ol><p>the image.</p></ol>
 293
 294 <h5>exception</h5>
 295 <ol><p>return any errors or warnings in this structure.</p></ol>
 296
 297  </div>
 298 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 299 _8c.html" target="source" name="RollImage">RollImage</a></h2>
 300 <div class="doc-section">
 301
 302 <p>RollImage() offsets an image as defined by x_offset and y_offset.</p></ol>
 303
 304 <p>The format of the RollImage method is:</p>
 305
 306 <pre class="code">
 307   Image *RollImage(const Image *image,const long x_offset,
 308     const long y_offset,ExceptionInfo *exception)
 309 </pre>
 310
 311 <p>A description of each parameter follows:</p></ol>
 312
 313 <h5>image</h5>
 314 <ol><p>the image.</p></ol>
 315
 316 <h5>x_offset</h5>
 317 <ol><p>the number of columns to roll in the horizontal direction.</p></ol>
 318
 319 <h5>y_offset</h5>
 320 <ol><p>the number of rows to roll in the vertical direction.</p></ol>
 321
 322 <h5>exception</h5>
 323 <ol><p>return any errors or warnings in this structure.</p></ol>
 324
 325  </div>
 326 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 327 _8c.html" target="source" name="ShaveImage">ShaveImage</a></h2>
 328 <div class="doc-section">
 329
 330 <p>ShaveImage() shaves pixels from the image edges.  It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p></ol>
 331
 332 <p>The format of the ShaveImage method is:</p>
 333
 334 <pre class="code">
 335   Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
 336     ExceptionInfo *exception)
 337 </pre>
 338
 339 <p>A description of each parameter follows:</p></ol>
 340
 341 <h5>shave_image</h5>
 342 <ol><p>Method ShaveImage returns a pointer to the shaved image.  A null image is returned if there is a memory shortage or if the image width or height is zero.</p></ol>
 343
 344 <h5>image</h5>
 345 <ol><p>the image.</p></ol>
 346
 347 <h5>shave_info</h5>
 348 <ol><p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p></ol>
 349
 350 <h5>exception</h5>
 351 <ol><p>return any errors or warnings in this structure.</p></ol>
 352
 353  </div>
 354 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 355 _8c.html" target="source" name="SpliceImage">SpliceImage</a></h2>
 356 <div class="doc-section">
 357
 358 <p>SpliceImage() splices a solid color into the image as defined by the geometry.</p></ol>
 359
 360 <p>The format of the SpliceImage method is:</p>
 361
 362 <pre class="code">
 363   Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
 364     ExceptionInfo *exception)
 365 </pre>
 366
 367 <p>A description of each parameter follows:</p></ol>
 368
 369 <h5>image</h5>
 370 <ol><p>the image.</p></ol>
 371
 372 <h5>geometry</h5>
 373 <ol><p>Define the region of the image to splice with members x, y, width, and height.</p></ol>
 374
 375 <h5>exception</h5>
 376 <ol><p>return any errors or warnings in this structure.</p></ol>
 377
 378  </div>
 379 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 380 _8c.html" target="source" name="TransformImage">TransformImage</a></h2>
 381 <div class="doc-section">
 382
 383 <p>TransformImage() is a convenience method that behaves like ResizeImage() or CropImage() but accepts scaling and/or cropping information as a region geometry specification.  If the operation fails, the original image handle is returned.</p></ol>
 384
 385 <p>The format of the TransformImage method is:</p>
 386
 387 <pre class="code">
 388   MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
 389     const char *image_geometry)
 390 </pre>
 391
 392 <p>A description of each parameter follows:</p></ol>
 393
 394 <h5>image</h5>
 395 <ol><p>the image The transformed image is returned as this parameter.</p></ol>
 396
 397 <h5>crop_geometry</h5>
 398 <ol><p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p></ol>
 399
 400 <h5>image_geometry</h5>
 401 <ol><p>An image geometry string.  This geometry defines the final size of the image.</p></ol>
 402
 403  </div>
 404 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 405 _8c.html" target="source" name="TransformImages">TransformImages</a></h2>
 406 <div class="doc-section">
 407
 408 <p>TransformImages() calls TransformImage() on each image of a sequence.</p></ol>
 409
 410 <p>The format of the TransformImage method is:</p>
 411
 412 <pre class="code">
 413   MagickBooleanType TransformImages(Image **image,
 414     const char *crop_geometry,const char *image_geometry)
 415 </pre>
 416
 417 <p>A description of each parameter follows:</p></ol>
 418
 419 <h5>image</h5>
 420 <ol><p>the image The transformed image is returned as this parameter.</p></ol>
 421
 422 <h5>crop_geometry</h5>
 423 <ol><p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p></ol>
 424
 425 <h5>image_geometry</h5>
 426 <ol><p>An image geometry string.  This geometry defines the final size of the image.</p></ol>
 427
 428  </div>
 429 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 430 _8c.html" target="source" name="TransposeImage">TransposeImage</a></h2>
 431 <div class="doc-section">
 432
 433 <p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p></ol>
 434
 435 <p>The format of the TransposeImage method is:</p>
 436
 437 <pre class="code">
 438   Image *TransposeImage(const Image *image,ExceptionInfo *exception)
 439 </pre>
 440
 441 <p>A description of each parameter follows:</p></ol>
 442
 443 <h5>image</h5>
 444 <ol><p>the image.</p></ol>
 445
 446 <h5>exception</h5>
 447 <ol><p>return any errors or warnings in this structure.</p></ol>
 448
 449  </div>
 450 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 451 _8c.html" target="source" name="TransverseImage">TransverseImage</a></h2>
 452 <div class="doc-section">
 453
 454 <p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p></ol>
 455
 456 <p>The format of the TransverseImage method is:</p>
 457
 458 <pre class="code">
 459   Image *TransverseImage(const Image *image,ExceptionInfo *exception)
 460 </pre>
 461
 462 <p>A description of each parameter follows:</p></ol>
 463
 464 <h5>image</h5>
 465 <ol><p>the image.</p></ol>
 466
 467 <h5>exception</h5>
 468 <ol><p>return any errors or warnings in this structure.</p></ol>
 469
 470  </div>
 471 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 472 _8c.html" target="source" name="TrimImage">TrimImage</a></h2>
 473 <div class="doc-section">
 474
 475 <p>TrimImage() trims pixels from the image edges.  It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p></ol>
 476
 477 <p>The format of the TrimImage method is:</p>
 478
 479 <pre class="code">
 480   Image *TrimImage(const Image *image,ExceptionInfo *exception)
 481 </pre>
 482
 483 <p>A description of each parameter follows:</p></ol>
 484
 485 <h5>image</h5>
 486 <ol><p>the image.</p></ol>
 487
 488 <h5>exception</h5>
 489 <ol><p>return any errors or warnings in this structure.</p></ol>
 490
 491  </div>
 492 \r
 493 </div>\r
 494 \r
 495 <div id="linkbar">\r
 496  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 497     <span id="linkbar-center">\r
 498       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 499       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 500     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 501     </span>\r
 502     <span id="linkbar-east">&nbsp;</span>\r
 503   </div>\r
 504   <div class="footer">\r
 505     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 506     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 507   </div>\r
 508   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 509 </body>\r
 510 </html>\r