424 lines
18 KiB
HTML
424 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>gimpimagetransform: GIMP Library Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
||
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
|
||
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
|
||
<link rel="prev" href="libgimp-gimpimageselect.html" title="gimpimageselect">
|
||
<link rel="next" href="libgimp-gimpimageundo.html" title="gimpimageundo">
|
||
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#libgimp-gimpimagetransform.description" class="shortcut">Description</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="libgimp-gimpimageselect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="libgimp-gimpimageundo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="libgimp-gimpimagetransform"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="libgimp-gimpimagetransform.top_of_page"></a>gimpimagetransform</span></h2>
|
||
<p>gimpimagetransform — Transformations on images.</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpimagetransform.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_proto_type">
|
||
<col class="functions_proto_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-resize" title="gimp_image_resize ()">gimp_image_resize</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-resize-to-layers" title="gimp_image_resize_to_layers ()">gimp_image_resize_to_layers</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-scale" title="gimp_image_scale ()">gimp_image_scale</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-scale-full" title="gimp_image_scale_full ()">gimp_image_scale_full</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-crop" title="gimp_image_crop ()">gimp_image_crop</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-flip" title="gimp_image_flip ()">gimp_image_flip</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpimagetransform.html#gimp-image-rotate" title="gimp_image_rotate ()">gimp_image_rotate</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpimagetransform.description"></a><h2>Description</h2>
|
||
<p>Operations to scale, resize, crop, flip and rotate images.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpimagetransform.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-resize"></a><h3>gimp_image_resize ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_resize (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
|
||
<p>Resize the image to the specified extents.</p>
|
||
<p>This procedure resizes the image so that it's new width and height
|
||
are equal to the supplied parameters. Offsets are also provided
|
||
which describe the position of the previous image's content. All
|
||
channels within the image are resized according to the specified
|
||
parameters; this includes the image selection mask. All layers
|
||
within the image are repositioned according to the specified
|
||
offsets.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-resize.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_width</p></td>
|
||
<td class="parameter_description"><p>New image width.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_height</p></td>
|
||
<td class="parameter_description"><p>New image height.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>offx</p></td>
|
||
<td class="parameter_description"><p>x offset between upper left corner of old and new images: (new - old).</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>offy</p></td>
|
||
<td class="parameter_description"><p>y offset between upper left corner of old and new images: (new - old).</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-resize.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-resize-to-layers"></a><h3>gimp_image_resize_to_layers ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_resize_to_layers (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre>
|
||
<p>Resize the image to fit all layers.</p>
|
||
<p>This procedure resizes the image to the bounding box of all layers
|
||
of the image. All channels within the image are resized to the new
|
||
size; this includes the image selection mask. All layers within the
|
||
image are repositioned to the new image area.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-resize-to-layers.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-resize-to-layers.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-scale"></a><h3>gimp_image_scale ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_scale (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>);</pre>
|
||
<p>Scale the image using the default interpolation method.</p>
|
||
<p>This procedure scales the image so that its new width and height are
|
||
equal to the supplied parameters. All layers and channels within the
|
||
image are scaled according to the specified parameters; this
|
||
includes the image selection mask. The interpolation method used can
|
||
be set with <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-interpolation" title="gimp_context_set_interpolation ()"><code class="function">gimp_context_set_interpolation()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-scale.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_width</p></td>
|
||
<td class="parameter_description"><p>New image width.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_height</p></td>
|
||
<td class="parameter_description"><p>New image height.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-scale.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-scale-full"></a><h3>gimp_image_scale_full ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_scale_full (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpInterpolationType"><span class="type">GimpInterpolationType</span></a> interpolation</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gimp_image_scale_full</code> is deprecated and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="libgimp-gimpimagetransform.html#gimp-image-scale" title="gimp_image_scale ()"><code class="function">gimp_image_scale()</code></a> instead.</p>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-scale-full.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_width</p></td>
|
||
<td class="parameter_description"><p>New image width.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_height</p></td>
|
||
<td class="parameter_description"><p>New image height.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>interpolation</p></td>
|
||
<td class="parameter_description"><p>Type of interpolation.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-scale-full.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-crop"></a><h3>gimp_image_crop ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_crop (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
|
||
<p>Crop the image to the specified extents.</p>
|
||
<p>This procedure crops the image so that it's new width and height are
|
||
equal to the supplied parameters. Offsets are also provided which
|
||
describe the position of the previous image's content. All channels
|
||
and layers within the image are cropped to the new image extents;
|
||
this includes the image selection mask. If any parameters are out of
|
||
range, an error is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-crop.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_width</p></td>
|
||
<td class="parameter_description"><p>New image width: (0 < new_width <= width).</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_height</p></td>
|
||
<td class="parameter_description"><p>New image height: (0 < new_height <= height).</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>offx</p></td>
|
||
<td class="parameter_description"><p>X offset: (0 <= offx <= (width - new_width)).</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>offy</p></td>
|
||
<td class="parameter_description"><p>Y offset: (0 <= offy <= (height - new_height)).</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-crop.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-flip"></a><h3>gimp_image_flip ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_flip (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpOrientationType"><span class="type">GimpOrientationType</span></a> flip_type</code></em>);</pre>
|
||
<p>Flips the image horizontally or vertically.</p>
|
||
<p>This procedure flips (mirrors) the image.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-flip.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>flip_type</p></td>
|
||
<td class="parameter_description"><p>Type of flip.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-flip.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-rotate"></a><h3>gimp_image_rotate ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gimp_image_rotate (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpRotationType"><span class="type">GimpRotationType</span></a> rotate_type</code></em>);</pre>
|
||
<p>Rotates the image by the specified degrees.</p>
|
||
<p>This procedure rotates the image.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-rotate.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>image_ID</p></td>
|
||
<td class="parameter_description"><p>The image.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>rotate_type</p></td>
|
||
<td class="parameter_description"><p>Angle of rotation.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-image-rotate.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.33.1</div>
|
||
</body>
|
||
</html> |