Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 68169a5b02e5d2b36003f4cc0db02a8fabf26c77 / . / www / api / transform.html
blob: 41cfddd731f9f1533ade075622e5eea52dafe32d [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]16 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]19 <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, Image, Processing, Automagically"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]32 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]34 <style type="text/css" media="all">
35 @import url("../../www/magick.css");
36 </style>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]37 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]38 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]39 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]40 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]54<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]68 <img src="../../images/logo.jpg"
69 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]70 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]71<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]72 <img src="../../images/sprite.jpg"
73 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]74 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]77<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]78
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]83 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
84</div>
85<div class="sub">
86 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
90</div>
91<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]92 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]93</div>
94<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]95 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
96</div>
97<div class="sep"></div>
98<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]114 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]117 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]123 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134 </div>
135<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]138<div class="menu">
139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
140</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]150 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
152<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]153 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]155<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]157 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]159<a href="http://www.networkredux.com">
160 <img src="../../images/networkredux.png" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]162<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]163<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
165</div>
166<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]167 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
168</div>
169<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]170 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
171</div>
172<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
174</div>
175<div class="sponsor">
176 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
177</div>
178<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]179 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]180</div>
181<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]182 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]183</div>
184<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]185 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]188 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]191 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]197 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]198</div>
199<div class="sponsor">
cristyd48f07c2011-07-09 23:09:26 +0000[diff] [blame]200 <a rel="follow" title="Kaffeevollautomaten Reparatur Kundendienst Berlin" href="http://www.kaffeemaschinen-center.de">Kaffeevollautomaten Reparatur Berlin</a><!-- 2011090100025 c.karule-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]201</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]202</div>
203</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]204</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]205
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]206<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]207<div style="margin: 9pt 9pt 9pt 9pt;">
208 <div class="g-plusone" data-size="standard" data-count="false"></div>
209</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]210</div>
211
212<div class="main">
213
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]214<h1>Module transform Methods</h1>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]215<p class="navigation-index">[<a href="#ChopImage">ChopImage</a> &bull; <a href="#CropImage">CropImage</a> &bull; <a href="#CropImageToTiles">CropImageToTiles</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="#to CropImageToTiles">to CropImageToTiles</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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]217<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ChopImage">ChopImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]218<div class="doc-section">
219
220<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p>
221
222<p>The format of the ChopImage method is:</p>
223
224<pre class="code">
225 Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
226 ExceptionInfo *exception)
227</pre>
228
229<p>A description of each parameter follows:</p>
230
231<h5>image</h5>
232<p>the image.</p>
233
234<h5>chop_info</h5>
235<p>Define the region of the image to chop.</p>
236
237<h5>exception</h5>
238<p>return any errors or warnings in this structure.</p>
239
240 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]241<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImage">CropImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]242<div class="doc-section">
243
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]244<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>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]245
246<p>The format of the CropImage method is:</p>
247
248<pre class="code">
249 Image *CropImage(const Image *image,const RectangleInfo *geometry,
250 ExceptionInfo *exception)
251</pre>
252
253<p>A description of each parameter follows:</p>
254
255<h5>image</h5>
256<p>the image.</p>
257
258<h5>geometry</h5>
259<p>Define the region of the image to crop with members x, y, width, and height.</p>
260
261<h5>exception</h5>
262<p>return any errors or warnings in this structure.</p>
263
264 </div>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]265<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="CropImageToTiles">CropImageToTiles</a></h2>
266<div class="doc-section">
267
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]268<p>CropImageToTiles() will crop 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>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]269
270<p>Image *CropImageToTiles(const Image *image,const RectangleInfo *crop_geometry, ExceptionInfo *exception)</p>
271
272<p>A description of each parameter follows:</p>
273
274<h5>image</h5>
275<p>the image The transformed image is returned as this parameter.</p>
276
277<h5>crop_geometry</h5>
278<p>A crop geometry string.</p>
279
280<h5>exception</h5>
281<p>return any errors or warnings in this structure.</p>
282
283 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]284<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExcerptImage">ExcerptImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]285<div class="doc-section">
286
287<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p>
288
289<p>The format of the ExcerptImage method is:</p>
290
291<pre class="code">
292 Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
293 ExceptionInfo *exception)
294</pre>
295
296<p>A description of each parameter follows:</p>
297
298<h5>image</h5>
299<p>the image.</p>
300
301<h5>geometry</h5>
302<p>Define the region of the image to extend with members x, y, width, and height.</p>
303
304<h5>exception</h5>
305<p>return any errors or warnings in this structure.</p>
306
307 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]308<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ExtentImage">ExtentImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]309<div class="doc-section">
310
311<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>
312
313<p>The format of the ExtentImage method is:</p>
314
315<pre class="code">
316 Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
317 ExceptionInfo *exception)
318</pre>
319
320<p>A description of each parameter follows:</p>
321
322<h5>image</h5>
323<p>the image.</p>
324
325<h5>geometry</h5>
326<p>Define the region of the image to extend with members x, y, width, and height.</p>
327
328<h5>exception</h5>
329<p>return any errors or warnings in this structure.</p>
330
331 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]332<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlipImage">FlipImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]333<div class="doc-section">
334
335<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
336
337<p>The format of the FlipImage method is:</p>
338
339<pre class="code">
340 Image *FlipImage(const Image *image,ExceptionInfo *exception)
341</pre>
342
343<p>A description of each parameter follows:</p>
344
345<h5>image</h5>
346<p>the image.</p>
347
348<h5>exception</h5>
349<p>return any errors or warnings in this structure.</p>
350
351 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]352<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="FlopImage">FlopImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]353<div class="doc-section">
354
355<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
356
357<p>The format of the FlopImage method is:</p>
358
359<pre class="code">
360 Image *FlopImage(const Image *image,ExceptionInfo *exception)
361</pre>
362
363<p>A description of each parameter follows:</p>
364
365<h5>image</h5>
366<p>the image.</p>
367
368<h5>exception</h5>
369<p>return any errors or warnings in this structure.</p>
370
371 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]372<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="RollImage">RollImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]373<div class="doc-section">
374
375<p>RollImage() offsets an image as defined by x_offset and y_offset.</p>
376
377<p>The format of the RollImage method is:</p>
378
379<pre class="code">
380 Image *RollImage(const Image *image,const ssize_t x_offset,
381 const ssize_t y_offset,ExceptionInfo *exception)
382</pre>
383
384<p>A description of each parameter follows:</p>
385
386<h5>image</h5>
387<p>the image.</p>
388
389<h5>x_offset</h5>
390<p>the number of columns to roll in the horizontal direction.</p>
391
392<h5>y_offset</h5>
393<p>the number of rows to roll in the vertical direction.</p>
394
395<h5>exception</h5>
396<p>return any errors or warnings in this structure.</p>
397
398 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]399<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="ShaveImage">ShaveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]400<div class="doc-section">
401
402<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>
403
404<p>The format of the ShaveImage method is:</p>
405
406<pre class="code">
407 Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
408 ExceptionInfo *exception)
409</pre>
410
411<p>A description of each parameter follows:</p>
412
413<h5>shave_image</h5>
414<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>
415
416<h5>image</h5>
417<p>the image.</p>
418
419<h5>shave_info</h5>
420<p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p>
421
422<h5>exception</h5>
423<p>return any errors or warnings in this structure.</p>
424
425 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]426<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="SpliceImage">SpliceImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]427<div class="doc-section">
428
429<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p>
430
431<p>The format of the SpliceImage method is:</p>
432
433<pre class="code">
434 Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
435 ExceptionInfo *exception)
436</pre>
437
438<p>A description of each parameter follows:</p>
439
440<h5>image</h5>
441<p>the image.</p>
442
443<h5>geometry</h5>
444<p>Define the region of the image to splice with members x, y, width, and height.</p>
445
446<h5>exception</h5>
447<p>return any errors or warnings in this structure.</p>
448
449 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]450<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImage">TransformImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]451<div class="doc-section">
452
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]453<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>
454
455<p>This should only be used for single images.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]456
457<p>The format of the TransformImage method is:</p>
458
459<pre class="code">
460 MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
461 const char *image_geometry)
462</pre>
463
464<p>A description of each parameter follows:</p>
465
466<h5>image</h5>
467<p>the image The transformed image is returned as this parameter.</p>
468
469<h5>crop_geometry</h5>
470<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
471
472<h5>image_geometry</h5>
473<p>An image geometry string. This geometry defines the final size of the image.</p>
474
475 </div>
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]476<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="to_CropImageToTiles">to CropImageToTiles</a></h2>
477<div class="doc-section">
478
479<p>to CropImageToTiles() or ResizeImage(), as appropriate.</p>
480
481 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]482<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransformImages">TransformImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]483<div class="doc-section">
484
485<p>TransformImages() calls TransformImage() on each image of a sequence.</p>
486
487<p>The format of the TransformImage method is:</p>
488
489<pre class="code">
490 MagickBooleanType TransformImages(Image **image,
491 const char *crop_geometry,const char *image_geometry)
492</pre>
493
494<p>A description of each parameter follows:</p>
495
496<h5>image</h5>
497<p>the image The transformed image is returned as this parameter.</p>
498
499<h5>crop_geometry</h5>
500<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
501
502<h5>image_geometry</h5>
503<p>An image geometry string. This geometry defines the final size of the image.</p>
504
505 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]506<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransposeImage">TransposeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]507<div class="doc-section">
508
509<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p>
510
511<p>The format of the TransposeImage method is:</p>
512
513<pre class="code">
514 Image *TransposeImage(const Image *image,ExceptionInfo *exception)
515</pre>
516
517<p>A description of each parameter follows:</p>
518
519<h5>image</h5>
520<p>the image.</p>
521
522<h5>exception</h5>
523<p>return any errors or warnings in this structure.</p>
524
525 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]526<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TransverseImage">TransverseImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]527<div class="doc-section">
528
529<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p>
530
531<p>The format of the TransverseImage method is:</p>
532
533<pre class="code">
534 Image *TransverseImage(const Image *image,ExceptionInfo *exception)
535</pre>
536
537<p>A description of each parameter follows:</p>
538
539<h5>image</h5>
540<p>the image.</p>
541
542<h5>exception</h5>
543<p>return any errors or warnings in this structure.</p>
544
545 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]546<h2><a href="http://www.imagemagick.org/api/MagickCore/transform_8c.html" id="TrimImage">TrimImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]547<div class="doc-section">
548
549<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>
550
551<p>The format of the TrimImage method is:</p>
552
553<pre class="code">
554 Image *TrimImage(const Image *image,ExceptionInfo *exception)
555</pre>
556
557<p>A description of each parameter follows:</p>
558
559<h5>image</h5>
560<p>the image.</p>
561
562<h5>exception</h5>
563<p>return any errors or warnings in this structure.</p>
564
565 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]566
567</div>
568
569<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]570 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]571 <span id="linkbar-center">
572 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]573 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]574 </span>
575 <span id="linkbar-east">&nbsp;</span>
576 </div>
577 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]578 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]579 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
580 </div>
581 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]582 <script type="text/javascript">
583 var _gaq = _gaq || [];
584 _gaq.push(['_setAccount', 'UA-17690367-1']);
585 _gaq.push(['_trackPageview']);
586
587 (function() {
588 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
589 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
590 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
591 })();
592 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]593</body>
594</html>