<?xml version="1.0"?>
<page id="Gimp.Drawable.edit_gradient_fill"
      type="topic"
      style="method"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="Gimp.Drawable" group="method" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>bool</api:type>
      </api:returns>
      <api:name>gimp_drawable_edit_gradient_fill</api:name>
      <api:arg>
        <api:type>Gimp.Drawable</api:type>
        <api:name>self</api:name>
      </api:arg>
      <api:arg>
        <api:type>Gimp.GradientType</api:type>
        <api:name>gradient_type</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>offset</api:name>
      </api:arg>
      <api:arg>
        <api:type>bool</api:type>
        <api:name>supersample</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>supersample_max_depth</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>supersample_threshold</api:name>
      </api:arg>
      <api:arg>
        <api:type>bool</api:type>
        <api:name>dither</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>x1</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>y1</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>x2</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>y2</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.Drawable.edit_gradient_fill</title>
  <synopsis><code mime="text/x-python">
@accepts(Gimp.Drawable, Gimp.GradientType, float, bool, int, float, bool, float, float, float, float)
@returns(bool)
def edit_gradient_fill(self, gradient_type, offset, supersample, supersample_max_depth, supersample_threshold, dither, x1, y1, x2, y2):
    # Python wrapper for gimp_drawable_edit_gradient_fill()
  </code></synopsis>
  <p>Draw a gradient between the starting and ending coordinates with the
specified gradient type.</p>  <p>This tool requires information on the gradient type. It creates the
specified variety of gradient using the starting and ending
coordinates as defined for each gradient type. For shapeburst
gradient types, the context's distance metric is also relevant and
can be updated with <link xref="Gimp.context_set_distance_metric"/>.</p>  <p>This procedure is affected by the following context setters:
<link xref="Gimp.context_set_opacity"/>, <link xref="Gimp.context_set_paint_mode"/>,
<link xref="Gimp.context_set_foreground"/>, <link xref="Gimp.context_set_background"/>,
<link xref="Gimp.context_set_gradient"/> and all gradient property settings,
<link xref="Gimp.context_set_distance_metric"/>.</p>
  <p>Since 2.10</p>
<terms>
<item>
<title><code>self</code></title>
  <p>The affected drawable.</p>
</item>
<item>
<title><code>gradient_type</code></title>
  <p>The type of gradient.</p>
</item>
<item>
<title><code>offset</code></title>
  <p>Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent.</p>
</item>
<item>
<title><code>supersample</code></title>
  <p>Do adaptive supersampling.</p>
</item>
<item>
<title><code>supersample_max_depth</code></title>
  <p>Maximum recursion levels for supersampling.</p>
</item>
<item>
<title><code>supersample_threshold</code></title>
  <p>Supersampling threshold.</p>
</item>
<item>
<title><code>dither</code></title>
  <p>Use dithering to reduce banding.</p>
</item>
<item>
<title><code>x1</code></title>
  <p>The x coordinate of this gradient's starting point.</p>
</item>
<item>
<title><code>y1</code></title>
  <p>The y coordinate of this gradient's starting point.</p>
</item>
<item>
<title><code>x2</code></title>
  <p>The x coordinate of this gradient's ending point.</p>
</item>
<item>
<title><code>y2</code></title>
  <p>The y coordinate of this gradient's ending point.</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
