diff options
Diffstat (limited to 'www/api/transform.html')
| -rw-r--r-- | www/api/transform.html | 304 |
1 files changed, 147 insertions, 157 deletions
diff --git a/www/api/transform.html b/www/api/transform.html index 297ff91..7778cef 100644 --- a/www/api/transform.html +++ b/www/api/transform.html @@ -1,12 +1,14 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!DOCTYPE html> +<html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" /> -<title>transform</title> -<link rel="stylesheet" href="../docutils-api.css" type="text/css" /> + <meta charset="utf-8"> + <meta content="en" name="language"> + <title>transform</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet"> + </head> + <body> <div class="banner"> @@ -19,6 +21,7 @@ </form> </div> + <div class="navmenu"> <ul> <li><a href="../index.html">Home</a></li> @@ -32,52 +35,51 @@ <li><a href="../reference.html">Reference</a></li> </ul> </div> + <div class="document" id="transform"> <h1 class="title">transform</h1> -<h2 class="subtitle" id="crop-flip-flop-roll-coalesce-etc">Crop, flip, flop, roll, coalesce, etc.</h2> - +<p class="subtitle" id="crop-flip-flop-roll-coalesce-etc">Crop, flip, flop, roll, coalesce, etc.</p> <div class="contents topic" id="contents"> <p class="topic-title">Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#chopimage" id="id23">ChopImage</a></li> -<li><a class="reference internal" href="#coalesceimages" id="id24">CoalesceImages</a></li> -<li><a class="reference internal" href="#cropimage" id="id25">CropImage</a></li> -<li><a class="reference internal" href="#deconstructimages" id="id26">DeconstructImages</a></li> -<li><a class="reference internal" href="#extentimage" id="id27">ExtentImage</a></li> -<li><a class="reference internal" href="#flattenimage" id="id28">FlattenImage</a></li> -<li><a class="reference internal" href="#flipimage" id="id29">FlipImage</a></li> -<li><a class="reference internal" href="#flopimage" id="id30">FlopImage</a></li> -<li><a class="reference internal" href="#mosaicimages" id="id31">MosaicImages</a></li> -<li><a class="reference internal" href="#rollimage" id="id32">RollImage</a></li> -<li><a class="reference internal" href="#shaveimage" id="id33">ShaveImage</a></li> -<li><a class="reference internal" href="#transformimage" id="id34">TransformImage</a></li> +<li><p><a class="reference internal" href="#chopimage" id="id23">ChopImage</a></p></li> +<li><p><a class="reference internal" href="#coalesceimages" id="id24">CoalesceImages</a></p></li> +<li><p><a class="reference internal" href="#cropimage" id="id25">CropImage</a></p></li> +<li><p><a class="reference internal" href="#deconstructimages" id="id26">DeconstructImages</a></p></li> +<li><p><a class="reference internal" href="#extentimage" id="id27">ExtentImage</a></p></li> +<li><p><a class="reference internal" href="#flattenimage" id="id28">FlattenImage</a></p></li> +<li><p><a class="reference internal" href="#flipimage" id="id29">FlipImage</a></p></li> +<li><p><a class="reference internal" href="#flopimage" id="id30">FlopImage</a></p></li> +<li><p><a class="reference internal" href="#mosaicimages" id="id31">MosaicImages</a></p></li> +<li><p><a class="reference internal" href="#rollimage" id="id32">RollImage</a></p></li> +<li><p><a class="reference internal" href="#shaveimage" id="id33">ShaveImage</a></p></li> +<li><p><a class="reference internal" href="#transformimage" id="id34">TransformImage</a></p></li> </ul> </div> <div class="section" id="chopimage"> <h1><a class="toc-backref" href="#id23">ChopImage</a></h1> <div class="section" id="synopsis"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ChopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, - const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *chop_info <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ChopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, + const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *chop_info <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="description"> <h2>Description</h2> <p>Chop() removes a region of an image and collapses the image to occupy the removed portion.</p> <p>The format of the ChopImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ChopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, - const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *chop_info <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ChopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, + const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *chop_info <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>chop_info:</dt> -<dd>Define the region of the image to chop.</dd> +<dd><p>Define the region of the image to chop.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -85,9 +87,7 @@ removed portion.</p> <h1><a class="toc-backref" href="#id24">CoalesceImages</a></h1> <div class="section" id="id1"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *CoalesceImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *CoalesceImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id2"> <h2>Description</h2> @@ -98,15 +98,15 @@ varies in size and offset. CoalesceImages() returns a new sequence where each image in the sequence is the same size as the first and composited with the next image in the sequence.</p> <p>The format of the CoalesceImages method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *CoalesceImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *CoalesceImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image sequence.</dd> +<dd><p>The image sequence.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -114,10 +114,8 @@ composited with the next image in the sequence.</p> <h1><a class="toc-backref" href="#id25">CropImage</a></h1> <div class="section" id="id3"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *CropImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *CropImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id4"> <h2>Description</h2> @@ -126,18 +124,19 @@ defined by geometry. As a special feature, if the geometry "0x0" is is passed, GetImageBoundingBox() is used to locate the edges of the image and the image is cropped ("trimmed") to that boundary.</p> <p>The format of the CropImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *CropImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *CropImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>geometry:</dt> -<dd>Define the region of the image to crop with members -x, y, width, and height.</dd> +<dd><p>Define the region of the image to crop with members +x, y, width, and height.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -145,24 +144,22 @@ x, y, width, and height.</dd> <h1><a class="toc-backref" href="#id26">DeconstructImages</a></h1> <div class="section" id="id5"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *DeconstructImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *DeconstructImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id6"> <h2>Description</h2> <p>DeconstructImages() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.</p> <p>The format of the DeconstructImages method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *DeconstructImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *DeconstructImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -170,10 +167,8 @@ returns the maximum bounding region of any pixel differences it discovers.</p> <h1><a class="toc-backref" href="#id27">ExtentImage</a></h1> <div class="section" id="id7"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ExtentImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ExtentImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id8"> <h2>Description</h2> @@ -183,19 +178,20 @@ specified by geometry x and y using the image compose method. Existing image content which falls outside the bounds of the new image dimensions is discarded.</p> <p>The format of the ExtentImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ExtentImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ExtentImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *geometry, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>geometry:</dt> -<dd>Define the new image dimension with width and height, and +<dd><p>Define the new image dimension with width and height, and the top left coordinate to place the existing image content with -x and y.</dd> +x and y.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -203,24 +199,22 @@ x and y.</dd> <h1><a class="toc-backref" href="#id28">FlattenImage</a></h1> <div class="section" id="id9"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *FlattenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FlattenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id10"> <h2>Description</h2> <p>Method FlattenImage merges a sequence of images. This is useful for combining Photoshop layers into a single image.</p> <p>The format of the FlattenImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *FlattenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FlattenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image sequence.</dd> +<dd><p>The image sequence.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -228,24 +222,22 @@ combining Photoshop layers into a single image.</p> <h1><a class="toc-backref" href="#id29">FlipImage</a></h1> <div class="section" id="id11"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *FlipImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FlipImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id12"> <h2>Description</h2> <p>FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p> <p>The format of the FlipImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *FlipImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FlipImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -253,24 +245,22 @@ around the central x-axis.</p> <h1><a class="toc-backref" href="#id30">FlopImage</a></h1> <div class="section" id="id13"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *FlopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FlopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id14"> <h2>Description</h2> <p>FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p> <p>The format of the FlopImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *FlopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FlopImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -278,9 +268,7 @@ around the central y-axis.</p> <h1><a class="toc-backref" href="#id31">MosaicImages</a></h1> <div class="section" id="id15"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *MosaicImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MosaicImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id16"> <h2>Description</h2> @@ -288,15 +276,15 @@ around the central y-axis.</p> It returns a single image with each image in the sequence composited at the location defined by the page member of the image structure.</p> <p>The format of the MosaicImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *MosaicImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MosaicImages( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -304,28 +292,28 @@ the location defined by the page member of the image structure.</p> <h1><a class="toc-backref" href="#id32">RollImage</a></h1> <div class="section" id="id17"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *RollImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x_offset, const long y_offset, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RollImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x_offset, const long y_offset, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id18"> <h2>Description</h2> <p>RollImage() offsets an image as defined by x_offset and y_offset.</p> <p>The format of the RollImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *RollImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x_offset, const long y_offset, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *RollImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x_offset, const long y_offset, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x_offset:</dt> -<dd>The number of columns to roll in the horizontal direction.</dd> +<dd><p>The number of columns to roll in the horizontal direction.</p> +</dd> <dt>y_offset:</dt> -<dd>The number of rows to roll in the vertical direction.</dd> +<dd><p>The number of rows to roll in the vertical direction.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -333,10 +321,8 @@ the location defined by the page member of the image structure.</p> <h1><a class="toc-backref" href="#id33">ShaveImage</a></h1> <div class="section" id="id19"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ShaveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *shave_info, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ShaveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *shave_info, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id20"> <h2>Description</h2> @@ -344,22 +330,24 @@ the location defined by the page member of the image structure.</p> memory necessary for the new Image structure and returns a pointer to the new image.</p> <p>The format of the ShaveImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ShaveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *shave_info, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ShaveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *shave_info, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>shave_image:</dt> -<dd>Method ShaveImage returns a pointer to the shaved +<dd><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.</dd> +if the image width or height is zero.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>shave_info:</dt> -<dd>Specifies a pointer to a RectangleInfo which defines the -region of the image to shave.</dd> +<dd><p>Specifies a pointer to a RectangleInfo which defines the +region of the image to shave.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -367,10 +355,8 @@ region of the image to shave.</dd> <h1><a class="toc-backref" href="#id34">TransformImage</a></h1> <div class="section" id="id21"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail TransformImage( <a class="reference external" href="../api/types.html#image">Image</a> ** image, const char *crop_geometry, - const char *image_geometry ); -</pre> +<pre class="literal-block">MagickPassFail TransformImage( <a class="reference external" href="../api/types.html#image">Image</a> ** image, const char *crop_geometry, + const char *image_geometry );</pre> </div> <div class="section" id="id22"> <h2>Description</h2> @@ -379,28 +365,32 @@ CropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, the original image handle is returned.</p> <p>The format of the TransformImage method is:</p> -<pre class="literal-block"> -MagickPassFail TransformImage( <a class="reference external" href="../api/types.html#image">Image</a> ** image, const char *crop_geometry, - const char *image_geometry ); -</pre> -<dl class="docutils"> +<pre class="literal-block">MagickPassFail TransformImage( <a class="reference external" href="../api/types.html#image">Image</a> ** image, const char *crop_geometry, + const char *image_geometry );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image to transform. The resulting transformed image is -returned via this parameter.</dd> +<dd><p>The image to transform. The resulting transformed image is +returned via this parameter.</p> +</dd> <dt>crop_geometry:</dt> -<dd>A crop geometry string. This geometry defines a -subregion of the image to crop.</dd> +<dd><p>A crop geometry string. This geometry defines a +subregion of the image to crop.</p> +</dd> <dt>image_geometry:</dt> -<dd>An image geometry string. This geometry defines the -final size of the image.</dd> +<dd><p>An image geometry string. This geometry defines the +final size of the image.</p> +</dd> </dl> </div> </div> </div> + <hr class="docutils"> <div class="document"> - <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p> + <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p> +</div> + </div> </body> </html> |