1 2 3 4 5<!doctype html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1" /> 10 <title>ImageMagick - MagickCore, C API: Transform an Image</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert digital images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="magickcore, c, api:, transform, an, image, image processing software" /> 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-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../../../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="transform.html" rel="canonical" /> 33 <link href="../../../images/wand.png" rel="icon" /> 34 <link href="../../../images/wand.ico" rel="shortcut icon" /> 35 <link href="../../assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> 39 <div class="container-fluid"> 40 <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a> 41 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation"> 42 <span class="navbar-toggler-icon"></span> 43 </button> 44 45 <div class="collapse navbar-collapse" id="magick-navbars"> 46 <ul class="navbar-nav me-auto mb-2 mb-md-0"> 47 <li class="nav-item"> 48 <a class="nav-link " href="../../www/index.html">Home</a> 49 </li> 50 <li class="nav-item"> 51 <a class="nav-link " href="../../www/download.html">Download</a> 52 </li> 53 <li class="nav-item"> 54 <a class="nav-link " href="../../www/command-line-tools.html">Tools</a> 55 </li> 56 <li class="nav-item"> 57 <a class="nav-link " href="../../www/command-line-processing.html">CLI</a> 58 </li> 59 <li class="nav-item"> 60 <a class="nav-link " href="../../www/develop.html">Develop</a> 61 </li> 62 <li class="nav-item"> 63 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a> 64 </li> 65 <li class="nav-item"> 66 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe> 67 </li> 68 </ul> 69 <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php"> 70 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search"> 71 <button class="btn btn-outline-success" type="submit" name="sa">Search</button> 72 </form> 73 </div> 74 </div> 75 </nav> 76 77 <div class="container"> 78 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> 79 <ins class="adsbygoogle" 80 style="display:block" 81 data-ad-client="ca-pub-3129977114552745" 82 data-ad-slot="6345125851" 83 data-full-width-responsive="true" 84 data-ad-format="horizontal"></ins> 85 <script> 86 (adsbygoogle = window.adsbygoogle || []).push({}); 87 </script> 88 89 </div> 90 91 <main class="container"> 92 <div class="magick-template"> 93<div class="magick-header"> 94<p class="text-center"><a href="transform.html#AutoOrientImage">AutoOrientImage</a> • <a href="transform.html#ChopImage">ChopImage</a> • <a href="transform.html#CropImage">CropImage</a> • <a href="transform.html#CropImageToTiles">CropImageToTiles</a> • <a href="transform.html#ExcerptImage">ExcerptImage</a> • <a href="transform.html#ExtentImage">ExtentImage</a> • <a href="transform.html#FlipImage">FlipImage</a> • <a href="transform.html#FlopImage">FlopImage</a> • <a href="transform.html#RollImage">RollImage</a> • <a href="transform.html#ShaveImage">ShaveImage</a> • <a href="transform.html#SpliceImage">SpliceImage</a> • <a href="transform.html#TransformImage">TransformImage</a> • <a href="transform.html#TransposeImage">TransposeImage</a> • <a href="transform.html#TransverseImage">TransverseImage</a> • <a href="transform.html#TrimImage">TrimImage</a></p> 95 96<h2><a href="../../api/MagickCore/transform_8c.html" id="AutoOrientImage">AutoOrientImage</a></h2> 97 98<p>AutoOrientImage() adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p> 99 100<p>The format of the AutoOrientImage method is:</p> 101 102<pre class="text"> 103Image *AutoOrientImage(const Image *image, 104 const OrientationType orientation,ExceptionInfo *exception) 105</pre> 106 107<p>A description of each parameter follows:</p> 108 109<dd> 110</dd> 111 112<dd> </dd> 113<dl class="dl-horizontal"> 114<dt>image</dt> 115<dd>The image. </dd> 116 117<dd> </dd> 118<dt>orientation</dt> 119<dd>Current image orientation. </dd> 120 121<dd> </dd> 122<dt>exception</dt> 123<dd>Return any errors or warnings in this structure. </dd> 124 125<dd> </dd> 126</dl> 127<h2><a href="../../api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2> 128 129<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p> 130 131<p>The format of the ChopImage method is:</p> 132 133<pre class="text"> 134Image *ChopImage(const Image *image,const RectangleInfo *chop_info) 135 ExceptionInfo *exception) 136</pre> 137 138<p>A description of each parameter follows:</p> 139 140<dd> 141</dd> 142 143<dd> </dd> 144<dl class="dl-horizontal"> 145<dt>image</dt> 146<dd>the image. </dd> 147 148<dd> </dd> 149<dt>chop_info</dt> 150<dd>Define the region of the image to chop. </dd> 151 152<dd> </dd> 153<dt>exception</dt> 154<dd>return any errors or warnings in this structure. </dd> 155 156<dd> </dd> 157</dl> 158<h2><a href="../../api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2> 159 160<p>CropImage() extracts a region of the image starting at the offset defined by geometry. Region must be fully defined, and no special handling of geometry flags is performed.</p> 161 162<p>The format of the CropImage method is:</p> 163 164<pre class="text"> 165Image *CropImage(const Image *image,const RectangleInfo *geometry, 166 ExceptionInfo *exception) 167</pre> 168 169<p>A description of each parameter follows:</p> 170 171<dd> 172</dd> 173 174<dd> </dd> 175<dl class="dl-horizontal"> 176<dt>image</dt> 177<dd>the image. </dd> 178 179<dd> </dd> 180<dt>geometry</dt> 181<dd>Define the region of the image to crop with members x, y, width, and height. </dd> 182 183<dd> </dd> 184<dt>exception</dt> 185<dd>return any errors or warnings in this structure. </dd> 186 187<dd> </dd> 188</dl> 189<h2><a href="../../api/MagickCore/transform_8c.html" id="CropImageToTiles">CropImageToTiles</a></h2> 190 191<p>CropImageToTiles() crops a single image, into a possible list of tiles. This may include a single sub-region of the image. This basically applies all the normal geometry flags for Crop.</p> 192 193<p>Image *CropImageToTiles(const Image *image, const RectangleInfo *crop_geometry, ExceptionInfo *exception)</p> 194 195<p>A description of each parameter follows:</p> 196 197<dd> 198</dd> 199 200<dd> </dd> 201<dl class="dl-horizontal"> 202<dt>image</dt> 203<dd>the image The transformed image is returned as this parameter. </dd> 204 205<dd> </dd> 206<dt>crop_geometry</dt> 207<dd>A crop geometry string. </dd> 208 209<dd> </dd> 210<dt>exception</dt> 211<dd>return any errors or warnings in this structure. </dd> 212 213<dd> </dd> 214</dl> 215<h2><a href="../../api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2> 216 217<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p> 218 219<p>The format of the ExcerptImage method is:</p> 220 221<pre class="text"> 222Image *ExcerptImage(const Image *image,const RectangleInfo *geometry, 223 ExceptionInfo *exception) 224</pre> 225 226<p>A description of each parameter follows:</p> 227 228<dd> 229</dd> 230 231<dd> </dd> 232<dl class="dl-horizontal"> 233<dt>image</dt> 234<dd>the image. </dd> 235 236<dd> </dd> 237<dt>geometry</dt> 238<dd>Define the region of the image to extend with members x, y, width, and height. </dd> 239 240<dd> </dd> 241<dt>exception</dt> 242<dd>return any errors or warnings in this structure. </dd> 243 244<dd> </dd> 245</dl> 246<h2><a href="../../api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2> 247 248<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> 249 250<p>The format of the ExtentImage method is:</p> 251 252<pre class="text"> 253Image *ExtentImage(const Image *image,const RectangleInfo *geometry, 254 ExceptionInfo *exception) 255</pre> 256 257<p>A description of each parameter follows:</p> 258 259<dd> 260</dd> 261 262<dd> </dd> 263<dl class="dl-horizontal"> 264<dt>image</dt> 265<dd>the image. </dd> 266 267<dd> </dd> 268<dt>geometry</dt> 269<dd>Define the region of the image to extend with members x, y, width, and height. </dd> 270 271<dd> </dd> 272<dt>exception</dt> 273<dd>return any errors or warnings in this structure. </dd> 274 275<dd> </dd> 276</dl> 277<h2><a href="../../api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2> 278 279<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p> 280 281<p>The format of the FlipImage method is:</p> 282 283<pre class="text"> 284Image *FlipImage(const Image *image,ExceptionInfo *exception) 285</pre> 286 287<p>A description of each parameter follows:</p> 288 289<dd> 290</dd> 291 292<dd> </dd> 293<dl class="dl-horizontal"> 294<dt>image</dt> 295<dd>the image. </dd> 296 297<dd> </dd> 298<dt>exception</dt> 299<dd>return any errors or warnings in this structure. </dd> 300 301<dd> </dd> 302</dl> 303<h2><a href="../../api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2> 304 305<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p> 306 307<p>The format of the FlopImage method is:</p> 308 309<pre class="text"> 310Image *FlopImage(const Image *image,ExceptionInfo *exception) 311</pre> 312 313<p>A description of each parameter follows:</p> 314 315<dd> 316</dd> 317 318<dd> </dd> 319<dl class="dl-horizontal"> 320<dt>image</dt> 321<dd>the image. </dd> 322 323<dd> </dd> 324<dt>exception</dt> 325<dd>return any errors or warnings in this structure. </dd> 326 327<dd> </dd> 328</dl> 329<h2><a href="../../api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2> 330 331<p>RollImage() offsets an image as defined by x_offset and y_offset.</p> 332 333<p>The format of the RollImage method is:</p> 334 335<pre class="text"> 336Image *RollImage(const Image *image,const ssize_t x_offset, 337 const ssize_t y_offset,ExceptionInfo *exception) 338</pre> 339 340<p>A description of each parameter follows:</p> 341 342<dd> 343</dd> 344 345<dd> </dd> 346<dl class="dl-horizontal"> 347<dt>image</dt> 348<dd>the image. </dd> 349 350<dd> </dd> 351<dt>x_offset</dt> 352<dd>the number of columns to roll in the horizontal direction. </dd> 353 354<dd> </dd> 355<dt>y_offset</dt> 356<dd>the number of rows to roll in the vertical direction. </dd> 357 358<dd> </dd> 359<dt>exception</dt> 360<dd>return any errors or warnings in this structure. </dd> 361 362<dd> </dd> 363</dl> 364<h2><a href="../../api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2> 365 366<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> 367 368<p>The format of the ShaveImage method is:</p> 369 370<pre class="text"> 371Image *ShaveImage(const Image *image,const RectangleInfo *shave_info, 372 ExceptionInfo *exception) 373</pre> 374 375<p>A description of each parameter follows:</p> 376 377<dd> 378</dd> 379 380<dd> </dd> 381<dl class="dl-horizontal"> 382<dt>shave_image</dt> 383<dd>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. </dd> 384 385<dd> </dd> 386<dt>image</dt> 387<dd>the image. </dd> 388 389<dd> </dd> 390<dt>shave_info</dt> 391<dd>Specifies a pointer to a RectangleInfo which defines the region of the image to crop. </dd> 392 393<dd> </dd> 394<dt>exception</dt> 395<dd>return any errors or warnings in this structure. </dd> 396 397<dd> </dd> 398</dl> 399<h2><a href="../../api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2> 400 401<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p> 402 403<p>The format of the SpliceImage method is:</p> 404 405<pre class="text"> 406Image *SpliceImage(const Image *image,const RectangleInfo *geometry, 407 ExceptionInfo *exception) 408</pre> 409 410<p>A description of each parameter follows:</p> 411 412<dd> 413</dd> 414 415<dd> </dd> 416<dl class="dl-horizontal"> 417<dt>image</dt> 418<dd>the image. </dd> 419 420<dd> </dd> 421<dt>geometry</dt> 422<dd>Define the region of the image to splice with members x, y, width, and height. </dd> 423 424<dd> </dd> 425<dt>exception</dt> 426<dd>return any errors or warnings in this structure. </dd> 427 428<dd> </dd> 429</dl> 430<h2><a href="../../api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2> 431 432<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 left as is.</p> 433 434<p>This should only be used for single images.</p> 435 436<p>This function destroys what it assumes to be a single image list. If the input image is part of a larger list, all other images in that list will be simply 'lost', not destroyed.</p> 437 438<p>Also if the crop generates a list of images only the first image is resized. And finally if the crop succeeds and the resize failed, you will get a cropped image, as well as a 'false' or 'failed' report.</p> 439 440<p>This function and should probably be deprecated in favor of direct calls to CropImageToTiles() or ResizeImage(), as appropriate.</p> 441 442<p>The format of the TransformImage method is:</p> 443 444<pre class="text"> 445MagickBooleanType TransformImage(Image **image,const char *crop_geometry, 446 const char *image_geometry,ExceptionInfo *exception) 447</pre> 448 449<p>A description of each parameter follows:</p> 450 451<dd> 452</dd> 453 454<dd> </dd> 455<dl class="dl-horizontal"> 456<dt>image</dt> 457<dd>the image The transformed image is returned as this parameter. </dd> 458 459<dd> </dd> 460<dt>crop_geometry</dt> 461<dd>A crop geometry string. This geometry defines a subregion of the image to crop. </dd> 462 463<dd> </dd> 464<dt>image_geometry</dt> 465<dd>An image geometry string. This geometry defines the final size of the image. </dd> 466 467<dd> </dd> 468<dt>exception</dt> 469<dd>return any errors or warnings in this structure. </dd> 470 471<dd> </dd> 472</dl> 473<h2><a href="../../api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2> 474 475<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p> 476 477<p>The format of the TransposeImage method is:</p> 478 479<pre class="text"> 480Image *TransposeImage(const Image *image,ExceptionInfo *exception) 481</pre> 482 483<p>A description of each parameter follows:</p> 484 485<dd> 486</dd> 487 488<dd> </dd> 489<dl class="dl-horizontal"> 490<dt>image</dt> 491<dd>the image. </dd> 492 493<dd> </dd> 494<dt>exception</dt> 495<dd>return any errors or warnings in this structure. </dd> 496 497<dd> </dd> 498</dl> 499<h2><a href="../../api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2> 500 501<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p> 502 503<p>The format of the TransverseImage method is:</p> 504 505<pre class="text"> 506Image *TransverseImage(const Image *image,ExceptionInfo *exception) 507</pre> 508 509<p>A description of each parameter follows:</p> 510 511<dd> 512</dd> 513 514<dd> </dd> 515<dl class="dl-horizontal"> 516<dt>image</dt> 517<dd>the image. </dd> 518 519<dd> </dd> 520<dt>exception</dt> 521<dd>return any errors or warnings in this structure. </dd> 522 523<dd> </dd> 524</dl> 525<h2><a href="../../api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2> 526 527<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> 528 529<p>The format of the TrimImage method is:</p> 530 531<pre class="text"> 532Image *TrimImage(const Image *image,ExceptionInfo *exception) 533</pre> 534 535<p>A description of each parameter follows:</p> 536 537<dd> 538</dd> 539 540<dd> </dd> 541<dl class="dl-horizontal"> 542<dt>image</dt> 543<dd>the image. </dd> 544 545<dd> </dd> 546<dt>exception</dt> 547<dd>return any errors or warnings in this structure. </dd> 548 549<dd> </dd> 550</dl> 551</div> 552 </div> 553 </main><!-- /.container --> 554 <footer class="magick-footer"> 555 <div class="container-fluid"> 556 <a href="../../www/security-policy.html">Security</a> • 557 <a href="../../www/news.html">News</a> 558 559 <a href="transform.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a> 560 561 <a href="../../www/links.html">Related</a> • 562 <a href="../../www/sitemap.html">Sitemap</a> 563 <br/> 564 <a href="../../www/support.html">Sponsor</a> • 565 <a href="../../www/cite.html">Cite</a> • 566 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 567 <a href="../../www/contact.html">Contact Us</a> 568 <br/> 569 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> • 570 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a> 571 <br/> 572 <small>© 1999-2021 ImageMagick Studio LLC</small> 573 </div> 574 </footer> 575 576 <!-- Javascript assets --> 577 <script src="../../assets/magick.js" ></script> 578 </body> 579</html> 580
