<?xml version="1.0"?>
<page id="Gimp.ExportOptions.get_image"
      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.ExportOptions" group="method" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>Gimp.ExportReturn</api:type>
      </api:returns>
      <api:name>gimp_export_options_get_image</api:name>
      <api:arg>
        <api:type>Gimp.ExportOptions</api:type>
        <api:name>self</api:name>
      </api:arg>
      <api:arg>
        <api:type>Gimp.Image</api:type>
        <api:name>image</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.ExportOptions.get_image</title>
  <synopsis><code mime="text/x-python">
@accepts(Gimp.ExportOptions, Gimp.Image)
@returns(Gimp.ExportReturn)
def get_image(self, image):
    # Python wrapper for gimp_export_options_get_image()
  </code></synopsis>
  <p>Takes an image to be exported, possibly creating a temporary copy
modified according to export settings in <code>self</code> (such as the
capabilities of the export format).</p>  <p>If necessary, a copy is created, converted and modified, <code>image</code>
changed to point to the new image and the procedure returns
[enum@Gimp.ExportReturn.EXPORT].
In this case, you must take care of deleting the created image using
[method@Image.delete] once the image has been exported, unless you
were planning to display it with [ctor@Display.new], or you will leak
memory.</p>  <p>If [enum@Gimp.ExportReturn.IGNORE] is returned, then <code>image</code> is still the
original image. You should neither modify it, nor should you delete
it in the end. If you wish to temporarily modify the image before
export anyway, call [method@Image.duplicate] when
[enum@Gimp.ExportReturn.IGNORE] was returned.</p>
  <p>Since 3.0</p>
<terms>
<item>
<title><code>self</code></title>
  <p>The <link xref="Gimp.ExportOptions"/> object.</p>
</item>
<item>
<title><code>image</code></title>
  <p>the image.</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
