<?xml version="1.0"?>
<page id="Gimp.Selection.float"
      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="Gimp.Selection" group="function" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>Gimp.Layer</api:type>
      </api:returns>
      <api:name>gimp_selection_float</api:name>
      <api:arg>
        <api:type>Gimp.Image</api:type>
        <api:name>image</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>n_drawables</api:name>
      </api:arg>
      <api:arg>
        <api:type>[Gimp.Drawable]</api:type>
        <api:name>drawables</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>offx</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>offy</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.Selection.float</title>
  <synopsis><code mime="text/x-python">
@accepts(Gimp.Image, int, [Gimp.Drawable], int, int)
@returns(Gimp.Layer)
def float(image, n_drawables, drawables, offx, offy):
    # Python wrapper for gimp_selection_float()
  </code></synopsis>
  <p>Float the selection from the specified drawable with initial offsets
as specified.</p>  <p>This procedure determines the region of the specified drawable that
lies beneath the current selection. The region is then cut from the
drawable and the resulting data is made into a new layer which is
instantiated as a floating selection. The offsets allow initial
positioning of the new floating selection.</p>

<terms>
<item>
<title><code>image</code></title>
  <p>ignored</p>
</item>
<item>
<title><code>n_drawables</code></title>
  <p>Size of <code>drawables</code>.</p>
</item>
<item>
<title><code>drawables</code></title>
  <p>The drawables from which to
              float selection.</p>
</item>
<item>
<title><code>offx</code></title>
  <p>x offset for translation.</p>
</item>
<item>
<title><code>offy</code></title>
  <p>y offset for translation.</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
