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.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 154 _8c.html" target="source" name="Chop">Chop</a></h2>
 155 <div class="doc-section">
 156
 157 <p>Chop() removes a region of an image and collapses the image to occupy the removed portion.</p></ol>
 158
 159 <p>The format of the ChopImage method is:</p>
 160
 161 <pre class="code">
 162   Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
 163     ExceptionInfo *exception)
 164 </pre>
 165
 166 <p>A description of each parameter follows:</p></ol>
 167
 168 <h5>image</h5>
 169 <ol><p>the image.</p></ol>
 170
 171 <h5>chop_info</h5>
 172 <ol><p>Define the region of the image to chop.</p></ol>
 173
 174 <h5>exception</h5>
 175 <ol><p>return any errors or warnings in this structure.</p></ol>
 176
 177  </div>
 178 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 179 _8c.html" target="source" name="CropImage">CropImage</a></h2>
 180 <div class="doc-section">
 181
 182 <p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p></ol>
 183
 184 <p>The format of the CropImage method is:</p>
 185
 186 <pre class="code">
 187   Image *CropImage(const Image *image,const RectangleInfo *geometry,
 188     ExceptionInfo *exception)
 189 </pre>
 190
 191 <p>A description of each parameter follows:</p></ol>
 192
 193 <h5>image</h5>
 194 <ol><p>the image.</p></ol>
 195
 196 <h5>geometry</h5>
 197 <ol><p>Define the region of the image to crop with members x, y, width, and height.</p></ol>
 198
 199 <h5>exception</h5>
 200 <ol><p>return any errors or warnings in this structure.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 204 _8c.html" target="source" name="ExcerptImage">ExcerptImage</a></h2>
 205 <div class="doc-section">
 206
 207 <p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p></ol>
 208
 209 <p>The format of the ExcerptImage method is:</p>
 210
 211 <pre class="code">
 212   Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
 213     ExceptionInfo *exception)
 214 </pre>
 215
 216 <p>A description of each parameter follows:</p></ol>
 217
 218 <h5>image</h5>
 219 <ol><p>the image.</p></ol>
 220
 221 <h5>geometry</h5>
 222 <ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
 223
 224 <h5>exception</h5>
 225 <ol><p>return any errors or warnings in this structure.</p></ol>
 226
 227  </div>
 228 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 229 _8c.html" target="source" name="ExtentImage">ExtentImage</a></h2>
 230 <div class="doc-section">
 231
 232 <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>
 233
 234 <p>The format of the ExtentImage method is:</p>
 235
 236 <pre class="code">
 237   Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
 238     ExceptionInfo *exception)
 239 </pre>
 240
 241 <p>A description of each parameter follows:</p></ol>
 242
 243 <h5>image</h5>
 244 <ol><p>the image.</p></ol>
 245
 246 <h5>geometry</h5>
 247 <ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
 248
 249 <h5>exception</h5>
 250 <ol><p>return any errors or warnings in this structure.</p></ol>
 251
 252  </div>
 253 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 254 _8c.html" target="source" name="FlipImage">FlipImage</a></h2>
 255 <div class="doc-section">
 256
 257 <p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p></ol>
 258
 259 <p>The format of the FlipImage method is:</p>
 260
 261 <pre class="code">
 262   Image *FlipImage(const Image *image,ExceptionInfo *exception)
 263 </pre>
 264
 265 <p>A description of each parameter follows:</p></ol>
 266
 267 <h5>image</h5>
 268 <ol><p>the image.</p></ol>
 269
 270 <h5>exception</h5>
 271 <ol><p>return any errors or warnings in this structure.</p></ol>
 272
 273  </div>
 274 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 275 _8c.html" target="source" name="FlopImage">FlopImage</a></h2>
 276 <div class="doc-section">
 277
 278 <p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p></ol>
 279
 280 <p>The format of the FlopImage method is:</p>
 281
 282 <pre class="code">
 283   Image *FlopImage(const Image *image,ExceptionInfo *exception)
 284 </pre>
 285
 286 <p>A description of each parameter follows:</p></ol>
 287
 288 <h5>image</h5>
 289 <ol><p>the image.</p></ol>
 290
 291 <h5>exception</h5>
 292 <ol><p>return any errors or warnings in this structure.</p></ol>
 293
 294  </div>
 295 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 296 _8c.html" target="source" name="RollImage">RollImage</a></h2>
 297 <div class="doc-section">
 298
 299 <p>RollImage() offsets an image as defined by x_offset and y_offset.</p></ol>
 300
 301 <p>The format of the RollImage method is:</p>
 302
 303 <pre class="code">
 304   Image *RollImage(const Image *image,const long x_offset,
 305     const long y_offset,ExceptionInfo *exception)
 306 </pre>
 307
 308 <p>A description of each parameter follows:</p></ol>
 309
 310 <h5>image</h5>
 311 <ol><p>the image.</p></ol>
 312
 313 <h5>x_offset</h5>
 314 <ol><p>the number of columns to roll in the horizontal direction.</p></ol>
 315
 316 <h5>y_offset</h5>
 317 <ol><p>the number of rows to roll in the vertical direction.</p></ol>
 318
 319 <h5>exception</h5>
 320 <ol><p>return any errors or warnings in this structure.</p></ol>
 321
 322  </div>
 323 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 324 _8c.html" target="source" name="ShaveImage">ShaveImage</a></h2>
 325 <div class="doc-section">
 326
 327 <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>
 328
 329 <p>The format of the ShaveImage method is:</p>
 330
 331 <pre class="code">
 332   Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
 333     ExceptionInfo *exception)
 334 </pre>
 335
 336 <p>A description of each parameter follows:</p></ol>
 337
 338 <h5>shave_image</h5>
 339 <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>
 340
 341 <h5>image</h5>
 342 <ol><p>the image.</p></ol>
 343
 344 <h5>shave_info</h5>
 345 <ol><p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p></ol>
 346
 347 <h5>exception</h5>
 348 <ol><p>return any errors or warnings in this structure.</p></ol>
 349
 350  </div>
 351 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 352 _8c.html" target="source" name="SpliceImage">SpliceImage</a></h2>
 353 <div class="doc-section">
 354
 355 <p>SpliceImage() splices a solid color into the image as defined by the geometry.</p></ol>
 356
 357 <p>The format of the SpliceImage method is:</p>
 358
 359 <pre class="code">
 360   Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
 361     ExceptionInfo *exception)
 362 </pre>
 363
 364 <p>A description of each parameter follows:</p></ol>
 365
 366 <h5>image</h5>
 367 <ol><p>the image.</p></ol>
 368
 369 <h5>geometry</h5>
 370 <ol><p>Define the region of the image to splice with members x, y, width, and height.</p></ol>
 371
 372 <h5>exception</h5>
 373 <ol><p>return any errors or warnings in this structure.</p></ol>
 374
 375  </div>
 376 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 377 _8c.html" target="source" name="TransformImage">TransformImage</a></h2>
 378 <div class="doc-section">
 379
 380 <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>
 381
 382 <p>The format of the TransformImage method is:</p>
 383
 384 <pre class="code">
 385   MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
 386     const char *image_geometry)
 387 </pre>
 388
 389 <p>A description of each parameter follows:</p></ol>
 390
 391 <h5>image</h5>
 392 <ol><p>the image The transformed image is returned as this parameter.</p></ol>
 393
 394 <h5>crop_geometry</h5>
 395 <ol><p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p></ol>
 396
 397 <h5>image_geometry</h5>
 398 <ol><p>An image geometry string.  This geometry defines the final size of the image.</p></ol>
 399
 400  </div>
 401 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 402 _8c.html" target="source" name="TransformImages">TransformImages</a></h2>
 403 <div class="doc-section">
 404
 405 <p>TransformImages() calls TransformImage() on each image of a sequence.</p></ol>
 406
 407 <p>The format of the TransformImage method is:</p>
 408
 409 <pre class="code">
 410   MagickBooleanType TransformImages(Image **image,
 411     const char *crop_geometry,const char *image_geometry)
 412 </pre>
 413
 414 <p>A description of each parameter follows:</p></ol>
 415
 416 <h5>image</h5>
 417 <ol><p>the image The transformed image is returned as this parameter.</p></ol>
 418
 419 <h5>crop_geometry</h5>
 420 <ol><p>A crop geometry string.  This geometry defines a subregion of the image to crop.</p></ol>
 421
 422 <h5>image_geometry</h5>
 423 <ol><p>An image geometry string.  This geometry defines the final size of the image.</p></ol>
 424
 425  </div>
 426 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 427 _8c.html" target="source" name="TransposeImage">TransposeImage</a></h2>
 428 <div class="doc-section">
 429
 430 <p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p></ol>
 431
 432 <p>The format of the TransposeImage method is:</p>
 433
 434 <pre class="code">
 435   Image *TransposeImage(const Image *image,ExceptionInfo *exception)
 436 </pre>
 437
 438 <p>A description of each parameter follows:</p></ol>
 439
 440 <h5>image</h5>
 441 <ol><p>the image.</p></ol>
 442
 443 <h5>exception</h5>
 444 <ol><p>return any errors or warnings in this structure.</p></ol>
 445
 446  </div>
 447 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 448 _8c.html" target="source" name="TransverseImage">TransverseImage</a></h2>
 449 <div class="doc-section">
 450
 451 <p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p></ol>
 452
 453 <p>The format of the TransverseImage method is:</p>
 454
 455 <pre class="code">
 456   Image *TransverseImage(const Image *image,ExceptionInfo *exception)
 457 </pre>
 458
 459 <p>A description of each parameter follows:</p></ol>
 460
 461 <h5>image</h5>
 462 <ol><p>the image.</p></ol>
 463
 464 <h5>exception</h5>
 465 <ol><p>return any errors or warnings in this structure.</p></ol>
 466
 467  </div>
 468 <h2><a href="http://www.imagemagick.org/api/MagickCore/transform
 469 _8c.html" target="source" name="TrimImage">TrimImage</a></h2>
 470 <div class="doc-section">
 471
 472 <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>
 473
 474 <p>The format of the TrimImage method is:</p>
 475
 476 <pre class="code">
 477   Image *TrimImage(const Image *image,ExceptionInfo *exception)
 478 </pre>
 479
 480 <p>A description of each parameter follows:</p></ol>
 481
 482 <h5>image</h5>
 483 <ol><p>the image.</p></ol>
 484
 485 <h5>exception</h5>
 486 <ol><p>return any errors or warnings in this structure.</p></ol>
 487
 488  </div>
 489 \r
 490 </div>\r
 491 \r
 492 <div id="linkbar">\r
 493  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 494     <span id="linkbar-center">\r
 495       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 496       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 497     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 498     </span>\r
 499     <span id="linkbar-east">&nbsp;</span>\r
 500   </div>\r
 501   <div class="footer">\r
 502     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 503     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 504   </div>\r
 505   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 506 </body>\r
 507 </html>\r