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