Imported Upstream version 2.8.6

This commit is contained in:
Ari Pollak
2013-07-01 20:23:15 -04:00
parent 08fdee2b19
commit a7debe0231
613 changed files with 76756 additions and 58854 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpcontext</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-gimpbuffer.html" title="gimpbuffer">
@ -150,8 +150,11 @@ This procedure creates a new context by copying the current context.
This copy becomes the new current context for the calling plug-in
until it is popped again using <a class="link" href="libgimp-gimpcontext.html#gimp-context-pop" title="gimp_context_pop ()"><code class="function">gimp_context_pop()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
@ -172,8 +175,11 @@ context stack. The context that was active before the corresponding
call to <a class="link" href="libgimp-gimpcontext.html#gimp-context-push" title="gimp_context_push ()"><code class="function">gimp_context_push()</code></a> becomes the new current context of the
plug-in.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
@ -195,8 +201,11 @@ context push so that a script which calls procedures affected by
context settings will not be affected by changes in the global
context.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
@ -216,8 +225,11 @@ This procedure returns the current GIMP foreground color. The
foreground color is used in a variety of tools such as paint tools,
blending, and bucket fill.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>foreground</code></em> :</span></p></td>
@ -243,8 +255,11 @@ This procedure sets the current GIMP foreground color. After this is
set, operations which use foreground such as paint tools, blending,
and bucket fill will use the new value.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>foreground</code></em> :</span></p></td>
@ -270,8 +285,11 @@ This procedure returns the current GIMP background color. The
background color is used in a variety of tools such as blending,
erasing (with non-alpha images), and image filling.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>background</code></em> :</span></p></td>
@ -298,8 +316,11 @@ set, operations which use background such as blending, filling
images, clearing, and erasing (in non-alpha images) will use the new
value.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>background</code></em> :</span></p></td>
@ -325,8 +346,11 @@ white.
This procedure sets the current GIMP foreground and background
colors to their initial default values, black and white.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
@ -346,8 +370,11 @@ This procedure swaps the current GIMP foreground and background
colors, so that the new foreground color becomes the old background
color and vice versa.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
@ -366,8 +393,11 @@ Get the opacity.
This procedure returns the opacity setting. The return value is a
floating point number between 0 and 100.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The opacity.</td>
@ -386,8 +416,11 @@ Set the opacity.
This procedure modifies the opacity setting. The value should be a
floating point number between 0 and 100.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>opacity</code></em> :</span></p></td>
@ -413,8 +446,11 @@ This procedure returns the paint-mode setting. The return value is
an integer which corresponds to the values listed in the argument
description.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The paint mode.</td>
@ -432,8 +468,11 @@ Set the paint mode.
<p>
This procedure modifies the paint_mode setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></p></td>
@ -459,8 +498,11 @@ This procedure returns the name of the currently active brush. All
paint operations and stroke operations use this brush to control the
application of paint to the image.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active brush.</td>
@ -482,8 +524,11 @@ names of the installed brushes. If there is no matching brush found,
this procedure will return an error. Otherwise, the specified brush
becomes active and will be used in all subsequent paint operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -507,8 +552,11 @@ Get brush angle in degrees.
<p>
Set the angle in degrees for brush based paint tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>angle in degrees.</td>
@ -526,8 +574,11 @@ Set brush angle in degrees.
<p>
Set the angle in degrees for brush based paint tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
@ -551,8 +602,11 @@ Get brush aspect ratio.
<p>
Set the aspect ratio for brush based paint tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>aspect ratio.</td>
@ -570,8 +624,11 @@ Set brush aspect ratio.
<p>
Set the aspect ratio for brush based paint tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>aspect</code></em> :</span></p></td>
@ -595,8 +652,11 @@ Get brush size in pixels.
<p>
Get the brush size in pixels for brush based paint tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>brush size in pixels.</td>
@ -614,8 +674,11 @@ Set brush size in pixels.
<p>
Set the brush size in pixels for brush based paint tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
@ -640,8 +703,11 @@ Set brush size to its default.
Set the brush size to the default (max of width and height) for
paintbrush, airbrush, or pencil tools.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
@ -661,8 +727,11 @@ This procedure returns the name of the currently active paint
dynamics. All paint operations and stroke operations use this paint
dynamics to control the application of paint to the image.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active paint dynamics.</td>
@ -685,8 +754,11 @@ matching paint dynamics found, this procedure will return an error.
Otherwise, the specified paint dynamics becomes active and will be
used in all subsequent paint operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -712,8 +784,11 @@ This procedure returns name of the the currently active pattern. All
clone and bucket-fill operations with patterns will use this pattern
to control the application of paint to the image.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active pattern.</td>
@ -736,8 +811,11 @@ found, this procedure will return an error. Otherwise, the specified
pattern becomes active and will be used in all subsequent paint
operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -761,8 +839,11 @@ Retrieve the currently active gradient.
<p>
This procedure returns the name of the currently active gradient.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active gradient.</td>
@ -785,8 +866,11 @@ procedure will return an error. Otherwise, the specified gradient
will become active and will be used for subsequent custom gradient
operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -810,8 +894,11 @@ Retrieve the currently active palette.
<p>
This procedure returns the name of the the currently active palette.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active palette.</td>
@ -834,8 +921,11 @@ this procedure will return an error. Otherwise, the specified
palette becomes active and will be used in all subsequent palette
operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -859,8 +949,11 @@ Retrieve the currently active font.
<p>
This procedure returns the name of the currently active font.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active font.</td>
@ -882,8 +975,11 @@ names of the installed fonts. If no matching font is found, this
procedure will return an error. Otherwise, the specified font
becomes active and will be used in all subsequent font operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -908,8 +1004,11 @@ Retrieve the currently active paint method.
This procedure returns the name of the currently active paint
method.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the active paint method.</td>
@ -932,8 +1031,11 @@ matching method found, this procedure will return an error.
Otherwise, the specified method becomes active and will be used in
all subsequent paint operations.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
@ -959,8 +1061,11 @@ Lists the available paint methods.
This procedure lists the names of the available paint methods. Any
of the results can be used for <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-method" title="gimp_context_set_paint_method ()"><code class="function">gimp_context_set_paint_method()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_paint_methods</code></em> :</span></p></td>
@ -988,8 +1093,11 @@ Get the antialias setting.
<p>
This procedure returns the antialias setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The antialias setting.</td>
@ -1014,8 +1122,11 @@ selection is wanted. This settings affects the following procedures:
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-round-rectangle" title="gimp_image_select_round_rectangle ()"><code class="function">gimp_image_select_round_rectangle()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-ellipse" title="gimp_image_select_ellipse ()"><code class="function">gimp_image_select_ellipse()</code></a>,
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-polygon" title="gimp_image_select_polygon ()"><code class="function">gimp_image_select_polygon()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-item" title="gimp_image_select_item ()"><code class="function">gimp_image_select_item()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>antialias</code></em> :</span></p></td>
@ -1039,8 +1150,11 @@ Get the feather setting.
<p>
This procedure returns the feather setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The feather setting.</td>
@ -1065,8 +1179,11 @@ following procedures: <a class="link" href="libgimp-gimpimageselect.html#gimp-im
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-round-rectangle" title="gimp_image_select_round_rectangle ()"><code class="function">gimp_image_select_round_rectangle()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-ellipse" title="gimp_image_select_ellipse ()"><code class="function">gimp_image_select_ellipse()</code></a>,
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-polygon" title="gimp_image_select_polygon ()"><code class="function">gimp_image_select_polygon()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-item" title="gimp_image_select_item ()"><code class="function">gimp_image_select_item()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>feather</code></em> :</span></p></td>
@ -1091,8 +1208,11 @@ Get the feather radius setting.
<p>
This procedure returns the feather radius setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>feather_radius_x</code></em> :</span></p></td>
@ -1123,8 +1243,11 @@ This procedure modifies the feather radius setting. This setting
affects all procedures that are affected by
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>feather_radius_x</code></em> :</span></p></td>
@ -1152,8 +1275,11 @@ Get the sample merged setting.
<p>
This procedure returns the sample merged setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The sample merged setting.</td>
@ -1178,8 +1304,11 @@ is equivalent to sampling for colors after merging all visible
layers). This setting affects the following procedures:
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-color" title="gimp_image_select_color ()"><code class="function">gimp_image_select_color()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-contiguous-color" title="gimp_image_select_contiguous_color ()"><code class="function">gimp_image_select_contiguous_color()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_merged</code></em> :</span></p></td>
@ -1203,8 +1332,11 @@ Get the sample criterion setting.
<p>
This procedure returns the sample criterion setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The sample criterion setting.</td>
@ -1227,8 +1359,11 @@ similarity is determined. SELECT_CRITERION_COMPOSITE is the default
value. This setting affects the following procedures:
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-color" title="gimp_image_select_color ()"><code class="function">gimp_image_select_color()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-contiguous-color" title="gimp_image_select_contiguous_color ()"><code class="function">gimp_image_select_contiguous_color()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_criterion</code></em> :</span></p></td>
@ -1252,8 +1387,11 @@ Get the sample threshold setting.
<p>
This procedure returns the sample threshold setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The sample threshold setting.</td>
@ -1278,8 +1416,11 @@ set in gimprc will be used. This setting affects the following
procedures: <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-color" title="gimp_image_select_color ()"><code class="function">gimp_image_select_color()</code></a>,
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-contiguous-color" title="gimp_image_select_contiguous_color ()"><code class="function">gimp_image_select_contiguous_color()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_threshold</code></em> :</span></p></td>
@ -1305,8 +1446,11 @@ Get the sample threshold setting as an integer value.
This procedure returns the sample threshold setting as an integer
value. See <a class="link" href="libgimp-gimpcontext.html#gimp-context-get-sample-threshold" title="gimp_context_get_sample_threshold ()"><code class="function">gimp_context_get_sample_threshold()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The sample threshold setting.</td>
@ -1326,8 +1470,11 @@ Set the sample threshold setting as an integer value.
This procedure modifies the sample threshold setting as an integer
value. See <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-sample-threshold" title="gimp_context_set_sample_threshold ()"><code class="function">gimp_context_set_sample_threshold()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_threshold</code></em> :</span></p></td>
@ -1351,8 +1498,11 @@ Get the sample transparent setting.
<p>
This procedure returns the sample transparent setting.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The sample transparent setting.</td>
@ -1376,8 +1526,11 @@ this setting is TRUE, transparent areas can be selected or filled.
This setting affects the following procedures:
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-color" title="gimp_image_select_color ()"><code class="function">gimp_image_select_color()</code></a>, <a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-contiguous-color" title="gimp_image_select_contiguous_color ()"><code class="function">gimp_image_select_contiguous_color()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_transparent</code></em> :</span></p></td>
@ -1405,8 +1558,11 @@ description. If the interpolation has not been set explicitly by
<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>, the default interpolation set in
gimprc will be used.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The interpolation type.</td>
@ -1430,8 +1586,11 @@ affects affects the following procedures:
<a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-matrix" title="gimp_item_transform_matrix ()"><code class="function">gimp_item_transform_matrix()</code></a>, <a class="link" href="libgimp-gimpimage.html#gimp-image-scale" title="gimp_image_scale ()"><code class="function">gimp_image_scale()</code></a>,
<a class="link" href="libgimp-gimplayer.html#gimp-layer-scale" title="gimp_layer_scale ()"><code class="function">gimp_layer_scale()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>interpolation</code></em> :</span></p></td>
@ -1458,8 +1617,11 @@ This procedure returns the transform direction. The return value is
an integer which corresponds to the values listed in the argument
description.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The transform direction.</td>
@ -1483,8 +1645,11 @@ setting affects affects the following procedures:
<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>, <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>,
<a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-matrix" title="gimp_item_transform_matrix ()"><code class="function">gimp_item_transform_matrix()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>transform_direction</code></em> :</span></p></td>
@ -1510,8 +1675,11 @@ This procedure returns the transform resize setting. The return
value is an integer which corresponds to the values listed in the
argument description.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The transform resize type.</td>
@ -1538,8 +1706,11 @@ following procedures: <a class="link" href="libgimp-gimpitemtransform.html#gimp-
<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>, <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>,
<a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-matrix" title="gimp_item_transform_matrix ()"><code class="function">gimp_item_transform_matrix()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>transform_resize</code></em> :</span></p></td>
@ -1564,8 +1735,11 @@ Get the transform supersampling recursion.
<p>
This procedure returns the transform supersampling recursion level.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The transform recursion level.</td>
@ -1591,8 +1765,11 @@ the following procedures: <a class="link" href="libgimp-gimpitemtransform.html#g
<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>, <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>,
<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>, <a class="link" href="libgimp-gimpitemtransform.html#gimp-item-transform-matrix" title="gimp_item_transform_matrix ()"><code class="function">gimp_item_transform_matrix()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>transform_recursion</code></em> :</span></p></td>
@ -1616,8 +1793,11 @@ Get ink angle in degrees.
<p>
Get the ink angle in degrees for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink angle in degrees.</td>
@ -1635,8 +1815,11 @@ Set ink angle in degrees.
<p>
Set the ink angle in degrees for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
@ -1660,8 +1843,11 @@ Get ink blob angle in degrees.
<p>
Get the ink blob angle in degrees for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink blob angle in degrees.</td>
@ -1679,8 +1865,11 @@ Set ink blob angle in degrees.
<p>
Set the ink blob angle in degrees for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
@ -1705,8 +1894,11 @@ Get ink blob aspect ratio.
<p>
Get the ink blob aspect ratio for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink blob aspect ratio.</td>
@ -1725,8 +1917,11 @@ Set ink blob aspect ratio.
<p>
Set the ink blob aspect ratio for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>aspect</code></em> :</span></p></td>
@ -1750,8 +1945,11 @@ Get ink blob type.
<p>
Get the ink blob type for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Ink blob type.</td>
@ -1769,8 +1967,11 @@ Set ink blob type.
<p>
Set the ink blob type for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
@ -1794,8 +1995,11 @@ Get ink blob size in pixels.
<p>
Get the ink blob size in pixels for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink blob size in pixels.</td>
@ -1813,8 +2017,11 @@ Set ink blob size in pixels.
<p>
Set the ink blob size in pixels for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
@ -1839,8 +2046,11 @@ Get ink size sensitivity.
<p>
Get the ink size sensitivity for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink size sensitivity.</td>
@ -1859,8 +2069,11 @@ Set ink size sensitivity.
<p>
Set the ink size sensitivity for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
@ -1885,8 +2098,11 @@ Get ink speed sensitivity.
<p>
Get the ink speed sensitivity for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink speed sensitivity.</td>
@ -1905,8 +2121,11 @@ Set ink speed sensitivity.
<p>
Set the ink speed sensitivity for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>speed</code></em> :</span></p></td>
@ -1931,8 +2150,11 @@ Get ink tilt sensitivity.
<p>
Get the ink tilt sensitivity for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>ink tilt sensitivity.</td>
@ -1951,8 +2173,11 @@ Set ink tilt sensitivity.
<p>
Set the ink tilt sensitivity for ink tool.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tilt</code></em> :</span></p></td>