cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 2 | <html lang="en"> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 3 | <head> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 4 | <meta charset="utf-8"> |
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
cristy | ffb69ed | 2010-12-25 00:06:48 +0000 | [diff] [blame] | 7 | <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 8 | <meta http-equiv="content-language" content="en-US"> |
| 9 | <meta http-equiv="content-type" content="text/html; charset=utf-8"> |
| 10 | <meta http-equiv="reply-to" content="magick-users@imagemagick.org"> |
| 11 | <meta name="application-name" content="ImageMagick"> |
| 12 | <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."> |
| 13 | <meta name="application-url" content="http://www.imagemagick.org"> |
| 14 | <meta name="generator" content="PHP"> |
| 15 | <meta name="keywords" content="magickcore, c, api, for, imagemagick:, transform, an, image, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"> |
| 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"> |
cristy | 4e638cd | 2015-05-07 16:47:40 +0000 | [diff] [blame^] | 22 | <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC"> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 23 | <meta name="distribution" content="Global"> |
| 24 | <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"> |
cristy | 2f563d4 | 2015-05-06 23:36:51 +0000 | [diff] [blame] | 25 | <link rel="icon" href="../images/wand.png"> |
| 26 | <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"> |
| 27 | <link rel="stylesheet" href="../css/bootstrap.min.css"> |
| 28 | <link rel="stylesheet" href="../css/magick.css"> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 29 | </head> |
| 30 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 31 | <body> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 32 | <div class="main"> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 33 | <div class="magick-masthead"> |
| 34 | <div class="container"> |
| 35 | <script type="text/javascript"> |
| 36 | <!-- |
| 37 | google_ad_client = "pub-3129977114552745"; |
| 38 | google_ad_slot = "5439289906"; |
| 39 | google_ad_width = 728; |
| 40 | google_ad_height = 90; |
| 41 | //--> |
| 42 | </script> |
| 43 | <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> |
| 44 | </script></center> |
| 45 | <nav class="magick-nav"> |
cristy | 2f563d4 | 2015-05-06 23:36:51 +0000 | [diff] [blame] | 46 | <a class="magick-nav-item " href="../index.html">Home</a> |
| 47 | <a class="magick-nav-item " href="../www/binary-releases.html">Downloads</a> |
| 48 | <a class="magick-nav-item " href="../www/command-line-tools.html">Tools</a> |
| 49 | <a class="magick-nav-item " href="../www/command-line-options.html">Options</a> |
| 50 | <a class="magick-nav-item " href="../www/api.html">Development</a> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 51 | <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a> |
cristy | abed55c | 2015-05-06 17:07:00 +0000 | [diff] [blame] | 52 | <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 53 | </nav> |
| 54 | </div> |
| 55 | </div> |
| 56 | <div class="container"> |
cristy | 4e638cd | 2015-05-07 16:47:40 +0000 | [diff] [blame^] | 57 | <div class="magick-header"> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 58 | <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#TransformImages">TransformImages</a> • <a href="transform.html#TransposeImage">TransposeImage</a> • <a href="transform.html#TransverseImage">TransverseImage</a> • <a href="transform.html#TrimImage">TrimImage</a></p> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 59 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 60 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="AutoOrientImage">AutoOrientImage</a></h2> |
cristy | 6f77f69 | 2011-02-15 15:31:39 +0000 | [diff] [blame] | 61 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 62 | <p>AutoOrientImage() adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p> |
| 63 | |
| 64 | <p>The format of the AutoOrientImage method is:</p> |
| 65 | |
| 66 | <pre class="text"> |
| 67 | Image *AutoOrientImage(const Image *image, |
| 68 | const OrientationType orientation,ExceptionInfo *exception) |
| 69 | </pre> |
| 70 | |
| 71 | <p>A description of each parameter follows:</p> |
| 72 | |
| 73 | <dd> |
| 74 | </dd> |
| 75 | |
| 76 | <dd> </dd> |
| 77 | <dl class="dl-horizontal"> |
| 78 | <dt>image</dt> |
| 79 | <dd>The image. </dd> |
| 80 | |
| 81 | <dd> </dd> |
| 82 | <dt>orientation</dt> |
| 83 | <dd>Current image orientation. </dd> |
| 84 | |
| 85 | <dd> </dd> |
| 86 | <dt>exception</dt> |
| 87 | <dd>Return any errors or warnings in this structure. </dd> |
| 88 | |
| 89 | <dd> </dd> |
| 90 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 91 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 92 | |
| 93 | <p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p> |
| 94 | |
| 95 | <p>The format of the ChopImage method is:</p> |
| 96 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 97 | <pre class="text"> |
| 98 | Image *ChopImage(const Image *image,const RectangleInfo *chop_info) |
| 99 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 100 | </pre> |
| 101 | |
| 102 | <p>A description of each parameter follows:</p> |
| 103 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 104 | <dd> |
| 105 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 106 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 107 | <dd> </dd> |
| 108 | <dl class="dl-horizontal"> |
| 109 | <dt>image</dt> |
| 110 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 111 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 112 | <dd> </dd> |
| 113 | <dt>chop_info</dt> |
| 114 | <dd>Define the region of the image to chop. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 115 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 116 | <dd> </dd> |
| 117 | <dt>exception</dt> |
| 118 | <dd>return any errors or warnings in this structure. </dd> |
| 119 | |
| 120 | <dd> </dd> |
| 121 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 122 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 123 | |
| 124 | <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> |
| 125 | |
| 126 | <p>The format of the CropImage method is:</p> |
| 127 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 128 | <pre class="text"> |
| 129 | Image *CropImage(const Image *image,const RectangleInfo *geometry, |
| 130 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 131 | </pre> |
| 132 | |
| 133 | <p>A description of each parameter follows:</p> |
| 134 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 135 | <dd> |
| 136 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 137 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 138 | <dd> </dd> |
| 139 | <dl class="dl-horizontal"> |
| 140 | <dt>image</dt> |
| 141 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 142 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 143 | <dd> </dd> |
| 144 | <dt>geometry</dt> |
| 145 | <dd>Define the region of the image to crop with members x, y, width, and height. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 146 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 147 | <dd> </dd> |
| 148 | <dt>exception</dt> |
| 149 | <dd>return any errors or warnings in this structure. </dd> |
| 150 | |
| 151 | <dd> </dd> |
| 152 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 153 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImageToTiles">CropImageToTiles</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 154 | |
cristy | eed6cb6 | 2012-01-28 19:38:34 +0000 | [diff] [blame] | 155 | <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> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 156 | |
cristy | eed6cb6 | 2012-01-28 19:38:34 +0000 | [diff] [blame] | 157 | <p>Image *CropImageToTiles(const Image *image, const RectangleInfo *crop_geometry, ExceptionInfo *exception)</p> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 158 | |
| 159 | <p>A description of each parameter follows:</p> |
| 160 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 161 | <dd> |
| 162 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 163 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 164 | <dd> </dd> |
| 165 | <dl class="dl-horizontal"> |
| 166 | <dt>image</dt> |
| 167 | <dd>the image The transformed image is returned as this parameter. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 168 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 169 | <dd> </dd> |
| 170 | <dt>crop_geometry</dt> |
| 171 | <dd>A crop geometry string. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 172 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 173 | <dd> </dd> |
| 174 | <dt>exception</dt> |
| 175 | <dd>return any errors or warnings in this structure. </dd> |
| 176 | |
| 177 | <dd> </dd> |
| 178 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 179 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 180 | |
| 181 | <p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p> |
| 182 | |
| 183 | <p>The format of the ExcerptImage method is:</p> |
| 184 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 185 | <pre class="text"> |
| 186 | Image *ExcerptImage(const Image *image,const RectangleInfo *geometry, |
| 187 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 188 | </pre> |
| 189 | |
| 190 | <p>A description of each parameter follows:</p> |
| 191 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 192 | <dd> |
| 193 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 194 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 195 | <dd> </dd> |
| 196 | <dl class="dl-horizontal"> |
| 197 | <dt>image</dt> |
| 198 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 199 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 200 | <dd> </dd> |
| 201 | <dt>geometry</dt> |
| 202 | <dd>Define the region of the image to extend with members x, y, width, and height. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 203 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 204 | <dd> </dd> |
| 205 | <dt>exception</dt> |
| 206 | <dd>return any errors or warnings in this structure. </dd> |
| 207 | |
| 208 | <dd> </dd> |
| 209 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 210 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 211 | |
| 212 | <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> |
| 213 | |
| 214 | <p>The format of the ExtentImage method is:</p> |
| 215 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 216 | <pre class="text"> |
| 217 | Image *ExtentImage(const Image *image,const RectangleInfo *geometry, |
| 218 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 219 | </pre> |
| 220 | |
| 221 | <p>A description of each parameter follows:</p> |
| 222 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 223 | <dd> |
| 224 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 225 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 226 | <dd> </dd> |
| 227 | <dl class="dl-horizontal"> |
| 228 | <dt>image</dt> |
| 229 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 230 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 231 | <dd> </dd> |
| 232 | <dt>geometry</dt> |
| 233 | <dd>Define the region of the image to extend with members x, y, width, and height. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 234 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 235 | <dd> </dd> |
| 236 | <dt>exception</dt> |
| 237 | <dd>return any errors or warnings in this structure. </dd> |
| 238 | |
| 239 | <dd> </dd> |
| 240 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 241 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 242 | |
| 243 | <p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p> |
| 244 | |
| 245 | <p>The format of the FlipImage method is:</p> |
| 246 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 247 | <pre class="text"> |
| 248 | Image *FlipImage(const Image *image,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 249 | </pre> |
| 250 | |
| 251 | <p>A description of each parameter follows:</p> |
| 252 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 253 | <dd> |
| 254 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 255 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 256 | <dd> </dd> |
| 257 | <dl class="dl-horizontal"> |
| 258 | <dt>image</dt> |
| 259 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 260 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 261 | <dd> </dd> |
| 262 | <dt>exception</dt> |
| 263 | <dd>return any errors or warnings in this structure. </dd> |
| 264 | |
| 265 | <dd> </dd> |
| 266 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 267 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 268 | |
| 269 | <p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p> |
| 270 | |
| 271 | <p>The format of the FlopImage method is:</p> |
| 272 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 273 | <pre class="text"> |
| 274 | Image *FlopImage(const Image *image,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 275 | </pre> |
| 276 | |
| 277 | <p>A description of each parameter follows:</p> |
| 278 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 279 | <dd> |
| 280 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 281 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 282 | <dd> </dd> |
| 283 | <dl class="dl-horizontal"> |
| 284 | <dt>image</dt> |
| 285 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 286 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 287 | <dd> </dd> |
| 288 | <dt>exception</dt> |
| 289 | <dd>return any errors or warnings in this structure. </dd> |
| 290 | |
| 291 | <dd> </dd> |
| 292 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 293 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 294 | |
| 295 | <p>RollImage() offsets an image as defined by x_offset and y_offset.</p> |
| 296 | |
| 297 | <p>The format of the RollImage method is:</p> |
| 298 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 299 | <pre class="text"> |
| 300 | Image *RollImage(const Image *image,const ssize_t x_offset, |
| 301 | const ssize_t y_offset,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 302 | </pre> |
| 303 | |
| 304 | <p>A description of each parameter follows:</p> |
| 305 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 306 | <dd> |
| 307 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 308 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 309 | <dd> </dd> |
| 310 | <dl class="dl-horizontal"> |
| 311 | <dt>image</dt> |
| 312 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 313 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 314 | <dd> </dd> |
| 315 | <dt>x_offset</dt> |
| 316 | <dd>the number of columns to roll in the horizontal direction. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 317 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 318 | <dd> </dd> |
| 319 | <dt>y_offset</dt> |
| 320 | <dd>the number of rows to roll in the vertical direction. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 321 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 322 | <dd> </dd> |
| 323 | <dt>exception</dt> |
| 324 | <dd>return any errors or warnings in this structure. </dd> |
| 325 | |
| 326 | <dd> </dd> |
| 327 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 328 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 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> |
| 331 | |
| 332 | <p>The format of the ShaveImage method is:</p> |
| 333 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 334 | <pre class="text"> |
| 335 | Image *ShaveImage(const Image *image,const RectangleInfo *shave_info, |
| 336 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 337 | </pre> |
| 338 | |
| 339 | <p>A description of each parameter follows:</p> |
| 340 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 341 | <dd> |
| 342 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 343 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 344 | <dd> </dd> |
| 345 | <dl class="dl-horizontal"> |
| 346 | <dt>shave_image</dt> |
| 347 | <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> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 348 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 349 | <dd> </dd> |
| 350 | <dt>image</dt> |
| 351 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 352 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 353 | <dd> </dd> |
| 354 | <dt>shave_info</dt> |
| 355 | <dd>Specifies a pointer to a RectangleInfo which defines the region of the image to crop. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 356 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 357 | <dd> </dd> |
| 358 | <dt>exception</dt> |
| 359 | <dd>return any errors or warnings in this structure. </dd> |
| 360 | |
| 361 | <dd> </dd> |
| 362 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 363 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 364 | |
| 365 | <p>SpliceImage() splices a solid color into the image as defined by the geometry.</p> |
| 366 | |
| 367 | <p>The format of the SpliceImage method is:</p> |
| 368 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 369 | <pre class="text"> |
| 370 | Image *SpliceImage(const Image *image,const RectangleInfo *geometry, |
| 371 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 372 | </pre> |
| 373 | |
| 374 | <p>A description of each parameter follows:</p> |
| 375 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 376 | <dd> |
| 377 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 378 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 379 | <dd> </dd> |
| 380 | <dl class="dl-horizontal"> |
| 381 | <dt>image</dt> |
| 382 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 383 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 384 | <dd> </dd> |
| 385 | <dt>geometry</dt> |
| 386 | <dd>Define the region of the image to splice with members x, y, width, and height. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 387 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 388 | <dd> </dd> |
| 389 | <dt>exception</dt> |
| 390 | <dd>return any errors or warnings in this structure. </dd> |
| 391 | |
| 392 | <dd> </dd> |
| 393 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 394 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 395 | |
| 396 | <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> |
| 397 | |
| 398 | <p>This should only be used for single images.</p> |
| 399 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 400 | <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> |
| 401 | |
| 402 | <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> |
| 403 | |
| 404 | <p>This function and should probably be deprecated in favor of direct calls to CropImageToTiles() or ResizeImage(), as appropriate.</p> |
| 405 | |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 406 | <p>The format of the TransformImage method is:</p> |
| 407 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 408 | <pre class="text"> |
| 409 | MagickBooleanType TransformImage(Image **image,const char *crop_geometry, |
| 410 | const char *image_geometry,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 411 | </pre> |
| 412 | |
| 413 | <p>A description of each parameter follows:</p> |
| 414 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 415 | <dd> |
| 416 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 417 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 418 | <dd> </dd> |
| 419 | <dl class="dl-horizontal"> |
| 420 | <dt>image</dt> |
| 421 | <dd>the image The transformed image is returned as this parameter. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 422 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 423 | <dd> </dd> |
| 424 | <dt>crop_geometry</dt> |
| 425 | <dd>A crop geometry string. This geometry defines a subregion of the image to crop. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 426 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 427 | <dd> </dd> |
| 428 | <dt>image_geometry</dt> |
| 429 | <dd>An image geometry string. This geometry defines the final size of the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 430 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 431 | <dd> </dd> |
| 432 | <dt>exception</dt> |
| 433 | <dd>return any errors or warnings in this structure. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 434 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 435 | <dd> </dd> |
| 436 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 437 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImages">TransformImages</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 438 | |
| 439 | <p>TransformImages() calls TransformImage() on each image of a sequence.</p> |
| 440 | |
| 441 | <p>The format of the TransformImage method is:</p> |
| 442 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 443 | <pre class="text"> |
| 444 | MagickBooleanType TransformImages(Image **image, |
| 445 | const char *crop_geometry,const char *image_geometry, |
| 446 | ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 447 | </pre> |
| 448 | |
| 449 | <p>A description of each parameter follows:</p> |
| 450 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 451 | <dd> |
| 452 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 453 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 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> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 458 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 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> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 462 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 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> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 473 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 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 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 479 | <pre class="text"> |
| 480 | Image *TransposeImage(const Image *image,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 481 | </pre> |
| 482 | |
| 483 | <p>A description of each parameter follows:</p> |
| 484 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 485 | <dd> |
| 486 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 487 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 488 | <dd> </dd> |
| 489 | <dl class="dl-horizontal"> |
| 490 | <dt>image</dt> |
| 491 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 492 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 493 | <dd> </dd> |
| 494 | <dt>exception</dt> |
| 495 | <dd>return any errors or warnings in this structure. </dd> |
| 496 | |
| 497 | <dd> </dd> |
| 498 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 499 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 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 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 505 | <pre class="text"> |
| 506 | Image *TransverseImage(const Image *image,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 507 | </pre> |
| 508 | |
| 509 | <p>A description of each parameter follows:</p> |
| 510 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 511 | <dd> |
| 512 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 513 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 514 | <dd> </dd> |
| 515 | <dl class="dl-horizontal"> |
| 516 | <dt>image</dt> |
| 517 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 518 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 519 | <dd> </dd> |
| 520 | <dt>exception</dt> |
| 521 | <dd>return any errors or warnings in this structure. </dd> |
| 522 | |
| 523 | <dd> </dd> |
| 524 | </dl> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 525 | <h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 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 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 531 | <pre class="text"> |
| 532 | Image *TrimImage(const Image *image,ExceptionInfo *exception) |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 533 | </pre> |
| 534 | |
| 535 | <p>A description of each parameter follows:</p> |
| 536 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 537 | <dd> |
| 538 | </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 539 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 540 | <dd> </dd> |
| 541 | <dl class="dl-horizontal"> |
| 542 | <dt>image</dt> |
| 543 | <dd>the image. </dd> |
cristy | 2039843 | 2011-08-11 01:31:50 +0000 | [diff] [blame] | 544 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 545 | <dd> </dd> |
| 546 | <dt>exception</dt> |
| 547 | <dd>return any errors or warnings in this structure. </dd> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 548 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 549 | <dd> </dd> |
| 550 | </dl> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 551 | </div> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 552 | <footer class="magick-footer"> |
| 553 | <div class="magick-nav-item navbar-left"> |
cristy | 2f563d4 | 2015-05-06 23:36:51 +0000 | [diff] [blame] | 554 | <a href="../www/support.html">Donate</a> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 555 | </div> |
cristy | 2f563d4 | 2015-05-06 23:36:51 +0000 | [diff] [blame] | 556 | <p><a href="../www/sitemap.html">Sitemap</a> • |
| 557 | <a href="../www/links.html">Related</a> • |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 558 | <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> • |
| 559 | <a href="http://jqmagick.imagemagick.org/">JqMagick</a> • |
| 560 | <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> |
| 561 | </p> |
| 562 | <p><a href="transform.html#">Back to top</a> • |
cristy | abed55c | 2015-05-06 17:07:00 +0000 | [diff] [blame] | 563 | <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p> |
cristy | 4e638cd | 2015-05-07 16:47:40 +0000 | [diff] [blame^] | 564 | <p class="small">© 1999-2015 ImageMagick Studio LLC</p> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 565 | </footer> |
| 566 | </div><!-- /.container --> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 567 | |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 568 | <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> |
cristy | 2f563d4 | 2015-05-06 23:36:51 +0000 | [diff] [blame] | 569 | <script src="../js/bootstrap.min.js"></script> |
cristy | 44443b9 | 2015-05-05 00:06:07 +0000 | [diff] [blame] | 570 | <script type="text/javascript"> |
| 571 | /* */ |
| 572 | (function() { |
| 573 | var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0]; |
| 574 | s.type = 'text/javascript'; |
| 575 | s.async = true; |
| 576 | s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto'; |
| 577 | t.parentNode.insertBefore(s, t); |
| 578 | })(); |
| 579 | /* */ |
| 580 | </script> |
cristy | 44cbd48 | 2013-08-04 20:53:36 +0000 | [diff] [blame] | 581 | </div> |
cristy | 06f63f2 | 2012-10-31 00:50:07 +0000 | [diff] [blame] | 582 | </body> |
cristy | 5a367e4 | 2015-05-05 12:39:18 +0000 | [diff] [blame] | 583 | </html> |