blob: c208376a3be6de3b2a30d4df2f8ec76e26eb9165 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<style type="text/css" media="all">
@import url("../../www/magick.css");
</style>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
<title>ImageMagick: MagickCore, C API for ImageMagick: Transform an Image</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<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."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<a href="../../index.html">
<img src="../../images/script.png" alt="[ImageMagick]"
style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
<a href="http://www.networkredux.com">
<img src="../../images/networkredux.png" alt="[sponsor]"
style="margin: 45px auto; border: 0px; float: left;" /></a>
<a href="http://www.imagemagick.org/discourse-server/">
<img src="../../images/logo.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="eastbar">
<div class="menu">
<a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map"href="../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links"href="../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
<div class="sponsbox">
<div class="sponsor">
<a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
</div>
<div class="sponsor">
<a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
</div>
<div class="sponsor">
<a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
</div>
<div class="sponsor">
<a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
</div>
<div class="sponsor">
<a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
</div>
<div class="sponsor">
<a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
</div>
<div class="sponsor">
<a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20111001000240 -->
</div>
</div>
</div>
</div>
<div class="main">
<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>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="ChopImage">ChopImage</a></h2>
<div class="doc-section">
<p>ChopImage() removes a region of an image and collapses the image to occupy the removed portion.</p></ol>
<p>The format of the ChopImage method is:</p>
<pre class="code">
Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>chop_info</h5>
<ol><p>Define the region of the image to chop.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="CropImage">CropImage</a></h2>
<div class="doc-section">
<p>CropImage() extracts a region of the image starting at the offset defined by geometry.</p></ol>
<p>The format of the CropImage method is:</p>
<pre class="code">
Image *CropImage(const Image *image,const RectangleInfo *geometry,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>geometry</h5>
<ol><p>Define the region of the image to crop with members x, y, width, and height.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="ExcerptImage">ExcerptImage</a></h2>
<div class="doc-section">
<p>ExcerptImage() returns a excerpt of the image as defined by the geometry.</p></ol>
<p>The format of the ExcerptImage method is:</p>
<pre class="code">
Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>geometry</h5>
<ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="ExtentImage">ExtentImage</a></h2>
<div class="doc-section">
<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>
<p>The format of the ExtentImage method is:</p>
<pre class="code">
Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>geometry</h5>
<ol><p>Define the region of the image to extend with members x, y, width, and height.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="FlipImage">FlipImage</a></h2>
<div class="doc-section">
<p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p></ol>
<p>The format of the FlipImage method is:</p>
<pre class="code">
Image *FlipImage(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="FlopImage">FlopImage</a></h2>
<div class="doc-section">
<p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p></ol>
<p>The format of the FlopImage method is:</p>
<pre class="code">
Image *FlopImage(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="RollImage">RollImage</a></h2>
<div class="doc-section">
<p>RollImage() offsets an image as defined by x_offset and y_offset.</p></ol>
<p>The format of the RollImage method is:</p>
<pre class="code">
Image *RollImage(const Image *image,const ssize_t x_offset,
const ssize_t y_offset,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x_offset</h5>
<ol><p>the number of columns to roll in the horizontal direction.</p></ol>
<h5>y_offset</h5>
<ol><p>the number of rows to roll in the vertical direction.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="ShaveImage">ShaveImage</a></h2>
<div class="doc-section">
<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>
<p>The format of the ShaveImage method is:</p>
<pre class="code">
Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>shave_image</h5>
<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>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>shave_info</h5>
<ol><p>Specifies a pointer to a RectangleInfo which defines the region of the image to crop.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="SpliceImage">SpliceImage</a></h2>
<div class="doc-section">
<p>SpliceImage() splices a solid color into the image as defined by the geometry.</p></ol>
<p>The format of the SpliceImage method is:</p>
<pre class="code">
Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>geometry</h5>
<ol><p>Define the region of the image to splice with members x, y, width, and height.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="TransformImage">TransformImage</a></h2>
<div class="doc-section">
<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>
<p>The format of the TransformImage method is:</p>
<pre class="code">
MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
const char *image_geometry)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image The transformed image is returned as this parameter.</p></ol>
<h5>crop_geometry</h5>
<ol><p>A crop geometry string. This geometry defines a subregion of the image to crop.</p></ol>
<h5>image_geometry</h5>
<ol><p>An image geometry string. This geometry defines the final size of the image.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="TransformImages">TransformImages</a></h2>
<div class="doc-section">
<p>TransformImages() calls TransformImage() on each image of a sequence.</p></ol>
<p>The format of the TransformImage method is:</p>
<pre class="code">
MagickBooleanType TransformImages(Image **image,
const char *crop_geometry,const char *image_geometry)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image The transformed image is returned as this parameter.</p></ol>
<h5>crop_geometry</h5>
<ol><p>A crop geometry string. This geometry defines a subregion of the image to crop.</p></ol>
<h5>image_geometry</h5>
<ol><p>An image geometry string. This geometry defines the final size of the image.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="TransposeImage">TransposeImage</a></h2>
<div class="doc-section">
<p>TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.</p></ol>
<p>The format of the TransposeImage method is:</p>
<pre class="code">
Image *TransposeImage(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="TransverseImage">TransverseImage</a></h2>
<div class="doc-section">
<p>TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.</p></ol>
<p>The format of the TransverseImage method is:</p>
<pre class="code">
Image *TransverseImage(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/transform
_8c.html" target="source" name="TrimImage">TrimImage</a></h2>
<div class="doc-section">
<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>
<p>The format of the TrimImage method is:</p>
<pre class="code">
Image *TrimImage(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
</div>
<div id="linkbar">
<!-- <span id="linkbar-west">&nbsp;</span> -->
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
<a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>