Files
gimp/devel-docs/libgimp/html/libgimp-gimptransformtools.html
2021-07-18 14:31:43 -04:00

457 lines
20 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimptransformtools: 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-gimpselectiontools.html" title="gimpselectiontools">
<link rel="next" href="libgimp-gimpvectors.html" title="gimpvectors">
<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-gimptransformtools.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-gimpselectiontools.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpvectors.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimptransformtools"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimptransformtools.top_of_page"></a>gimptransformtools</span></h2>
<p>gimptransformtools — Access to toolbox transform tools.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimptransformtools.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">gint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimptransformtools.html#gimp-flip" title="gimp_flip ()">gimp_flip</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimptransformtools.html#gimp-perspective" title="gimp_perspective ()">gimp_perspective</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimptransformtools.html#gimp-rotate" title="gimp_rotate ()">gimp_rotate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimptransformtools.html#gimp-scale" title="gimp_scale ()">gimp_scale</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimptransformtools.html#gimp-shear" title="gimp_shear ()">gimp_shear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimptransformtools.html#gimp-transform-2d" title="gimp_transform_2d ()">gimp_transform_2d</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimptransformtools.description"></a><h2>Description</h2>
<p>Functions giving access to toolbox transform tools.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimptransformtools.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-flip"></a><h3>gimp_flip ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_flip (<em class="parameter"><code><span class="type">gint32</span> drawable_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>
<div class="warning">
<p><code class="literal">gimp_flip</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-flip-simple" title="gimp_item_transform_flip_simple ()"><code class="function">gimp_item_transform_flip_simple()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-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>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</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-flip.returns"></a><h4>Returns</h4>
<p> The flipped drawable.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-perspective"></a><h3>gimp_perspective ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_perspective (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> interpolation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x0</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y0</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x2</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y2</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x3</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y3</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_perspective</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-perspective" title="gimp_item_transform_perspective ()"><code class="function">gimp_item_transform_perspective()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-perspective.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>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpolation</p></td>
<td class="parameter_description"><p>Whether to use interpolation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x0</p></td>
<td class="parameter_description"><p>The new x coordinate of upper-left corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y0</p></td>
<td class="parameter_description"><p>The new y coordinate of upper-left corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x1</p></td>
<td class="parameter_description"><p>The new x coordinate of upper-right corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y1</p></td>
<td class="parameter_description"><p>The new y coordinate of upper-right corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x2</p></td>
<td class="parameter_description"><p>The new x coordinate of lower-left corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y2</p></td>
<td class="parameter_description"><p>The new y coordinate of lower-left corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x3</p></td>
<td class="parameter_description"><p>The new x coordinate of lower-right corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y3</p></td>
<td class="parameter_description"><p>The new y coordinate of lower-right corner of original bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-perspective.returns"></a><h4>Returns</h4>
<p> The newly mapped drawable.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-rotate"></a><h3>gimp_rotate ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_rotate (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> interpolation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> angle</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_rotate</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-rotate" title="gimp_item_transform_rotate ()"><code class="function">gimp_item_transform_rotate()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-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>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpolation</p></td>
<td class="parameter_description"><p>Whether to use interpolation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>angle</p></td>
<td class="parameter_description"><p>The angle of rotation (radians).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-rotate.returns"></a><h4>Returns</h4>
<p> The rotated drawable.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-scale"></a><h3>gimp_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_scale (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> interpolation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x0</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y0</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y1</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_scale</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-scale" title="gimp_item_transform_scale ()"><code class="function">gimp_item_transform_scale()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-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>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpolation</p></td>
<td class="parameter_description"><p>Whether to use interpolation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x0</p></td>
<td class="parameter_description"><p>The new x coordinate of the upper-left corner of the scaled region.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y0</p></td>
<td class="parameter_description"><p>The new y coordinate of the upper-left corner of the scaled region.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x1</p></td>
<td class="parameter_description"><p>The new x coordinate of the lower-right corner of the scaled region.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y1</p></td>
<td class="parameter_description"><p>The new y coordinate of the lower-right corner of the scaled region.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-scale.returns"></a><h4>Returns</h4>
<p> The scaled drawable.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-shear"></a><h3>gimp_shear ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_shear (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> interpolation</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpOrientationType"><span class="type">GimpOrientationType</span></a> shear_type</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> magnitude</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_shear</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-shear" title="gimp_item_transform_shear ()"><code class="function">gimp_item_transform_shear()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-shear.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>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpolation</p></td>
<td class="parameter_description"><p>Whether to use interpolation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>shear_type</p></td>
<td class="parameter_description"><p>Type of shear.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>magnitude</p></td>
<td class="parameter_description"><p>The magnitude of the shear.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-shear.returns"></a><h4>Returns</h4>
<p> The sheared drawable.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-transform-2d"></a><h3>gimp_transform_2d ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_transform_2d (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> interpolation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> source_x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> source_y</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> scale_x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> scale_y</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> angle</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> dest_x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> dest_y</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_transform_2d</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-2d" title="gimp_item_transform_2d ()"><code class="function">gimp_item_transform_2d()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-transform-2d.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>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpolation</p></td>
<td class="parameter_description"><p>Whether to use interpolation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_x</p></td>
<td class="parameter_description"><p>X coordinate of the transformation center.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_y</p></td>
<td class="parameter_description"><p>Y coordinate of the transformation center.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>scale_x</p></td>
<td class="parameter_description"><p>Amount to scale in x direction.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>scale_y</p></td>
<td class="parameter_description"><p>Amount to scale in y direction.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>angle</p></td>
<td class="parameter_description"><p>The angle of rotation (radians).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_x</p></td>
<td class="parameter_description"><p>X coordinate of where the centre goes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_y</p></td>
<td class="parameter_description"><p>Y coordinate of where the centre goes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-transform-2d.returns"></a><h4>Returns</h4>
<p> The transformed drawable.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>