<?xml version="1.0"?>
<page id="Gimp.paintbrush_default"
      type="topic"
      style="function"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="index" group="function" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>bool</api:type>
      </api:returns>
      <api:name>gimp_paintbrush_default</api:name>
      <api:arg>
        <api:type>Gimp.Drawable</api:type>
        <api:name>drawable</api:name>
      </api:arg>
      <api:arg>
        <api:type>gsize</api:type>
        <api:name>num_strokes</api:name>
      </api:arg>
      <api:arg>
        <api:type>[float]</api:type>
        <api:name>strokes</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.paintbrush_default</title>
  <synopsis><code mime="text/x-python">
@accepts(Gimp.Drawable, gsize, [float])
@returns(bool)
def paintbrush_default(drawable, num_strokes, strokes):
    # Python wrapper for gimp_paintbrush_default()
  </code></synopsis>
  <p>Paint in the current brush. The fade out parameter and pull colors
from a gradient parameter are set from the paintbrush options
dialog. If this dialog has not been activated then the dialog
defaults will be used.</p>  <p>This tool is similar to the standard paintbrush. It draws linearly
interpolated lines through the specified stroke coordinates. It
operates on the specified drawable in the foreground color with the
active brush. The 'fade-out' parameter is measured in pixels and
allows the brush stroke to linearly fall off (value obtained from
the option dialog). The pressure is set to the maximum at the
beginning of the stroke. As the distance of the stroke nears the
fade-out value, the pressure will approach zero. The gradient-length
(value obtained from the option dialog) is the distance to spread
the gradient over. It is measured in pixels. If the gradient-length
is 0, no gradient is used.</p>

<terms>
<item>
<title><code>drawable</code></title>
  <p>The affected drawable.</p>
</item>
<item>
<title><code>num_strokes</code></title>
  <p>Number of stroke control points (count each coordinate as 2 points).</p>
</item>
<item>
<title><code>strokes</code></title>
  <p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
