Files
gimp/devel-docs/libgimp/html/libgimp-gimppixbuf.html
2010-08-11 01:21:39 -04:00

352 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppixbuf</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="prev" href="GimpImageComboBox.html" title="gimpimagecombobox">
<link rel="next" href="GimpProgressBar.html" title="GimpProgressBar">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GimpImageComboBox.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="GimpProgressBar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2578281" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2711662" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppixbuf"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2578281"></a><span class="refentrytitle">gimppixbuf</span>
</h2>
<p>gimppixbuf &#8212; Get a thumbnail pixbuf for a drawable or image.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
enum <a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a>;
GdkPixbuf* <a href="libgimp-gimppixbuf.html#gimp-image-get-thumbnail">gimp_image_get_thumbnail</a> (gint32 image_ID,
gint width,
gint height,
<a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a> alpha);
GdkPixbuf* <a href="libgimp-gimppixbuf.html#gimp-drawable-get-thumbnail">gimp_drawable_get_thumbnail</a> (gint32 drawable_ID,
gint width,
gint height,
<a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a> alpha);
GdkPixbuf* <a href="libgimp-gimppixbuf.html#gimp-drawable-get-sub-thumbnail">gimp_drawable_get_sub_thumbnail</a> (gint32 drawable_ID,
gint src_x,
gint src_y,
gint src_width,
gint src_height,
gint dest_width,
gint dest_height,
<a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a> alpha);
gint32 <a href="libgimp-gimppixbuf.html#gimp-layer-new-from-pixbuf">gimp_layer_new_from_pixbuf</a> (gint32 image_ID,
const gchar *name,
GdkPixbuf *pixbuf,
gdouble opacity,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode,
gdouble progress_start,
gdouble progress_end);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2711662"></a><h2>Description</h2>
<p>
Get a thumbnail pixbuf for a drawable or image.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2715762"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2715772"></a><h3>
<a name="GimpPixbufTransparency"></a>enum GimpPixbufTransparency</h3>
<a class="indexterm" name="id2715783"></a><pre class="programlisting">typedef enum
{
GIMP_PIXBUF_KEEP_ALPHA,
GIMP_PIXBUF_SMALL_CHECKS,
GIMP_PIXBUF_LARGE_CHECKS
} GimpPixbufTransparency;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2715800"></a><h3>
<a name="gimp-image-get-thumbnail"></a>gimp_image_get_thumbnail ()</h3>
<a class="indexterm" name="id2715813"></a><pre class="programlisting">GdkPixbuf* gimp_image_get_thumbnail (gint32 image_ID,
gint width,
gint height,
<a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a> alpha);</pre>
<p>
Retrieves a thumbnail pixbuf for the image identified by <em class="parameter"><code>image_ID</code></em>.
The thumbnail will be not larger than the requested size.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> the image ID
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> the requested thumbnail width (&lt;= 1024 pixels)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> the requested thumbnail height (&lt;= 1024 pixels)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>alpha</code></em>&#160;:</span></td>
<td> how to handle an alpha channel
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GdkPixbuf</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2718937"></a><h3>
<a name="gimp-drawable-get-thumbnail"></a>gimp_drawable_get_thumbnail ()</h3>
<a class="indexterm" name="id2718950"></a><pre class="programlisting">GdkPixbuf* gimp_drawable_get_thumbnail (gint32 drawable_ID,
gint width,
gint height,
<a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a> alpha);</pre>
<p>
Retrieves a thumbnail pixbuf for the drawable identified by
<em class="parameter"><code>drawable_ID</code></em>. The thumbnail will be not larger than the requested
size.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
<td> the drawable ID
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> the requested thumbnail width (&lt;= 1024 pixels)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> the requested thumbnail height (&lt;= 1024 pixels)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>alpha</code></em>&#160;:</span></td>
<td> how to handle an alpha channel
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GdkPixbuf</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2719095"></a><h3>
<a name="gimp-drawable-get-sub-thumbnail"></a>gimp_drawable_get_sub_thumbnail ()</h3>
<a class="indexterm" name="id2719108"></a><pre class="programlisting">GdkPixbuf* gimp_drawable_get_sub_thumbnail (gint32 drawable_ID,
gint src_x,
gint src_y,
gint src_width,
gint src_height,
gint dest_width,
gint dest_height,
<a href="libgimp-gimppixbuf.html#GimpPixbufTransparency">GimpPixbufTransparency</a> alpha);</pre>
<p>
Retrieves a thumbnail pixbuf for the drawable identified by
<em class="parameter"><code>drawable_ID</code></em>. The thumbnail will be not larger than the requested
size.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
<td> the drawable ID
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>src_x</code></em>&#160;:</span></td>
<td> the x coordinate of the area
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>src_y</code></em>&#160;:</span></td>
<td> the y coordinate of the area
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>src_width</code></em>&#160;:</span></td>
<td> the width of the area
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>src_height</code></em>&#160;:</span></td>
<td> the height of the area
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>dest_width</code></em>&#160;:</span></td>
<td> the requested thumbnail width (&lt;= 1024 pixels)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>dest_height</code></em>&#160;:</span></td>
<td> the requested thumbnail height (&lt;= 1024 pixels)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>alpha</code></em>&#160;:</span></td>
<td> how to handle an alpha channel
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GdkPixbuf</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2716226"></a><h3>
<a name="gimp-layer-new-from-pixbuf"></a>gimp_layer_new_from_pixbuf ()</h3>
<a class="indexterm" name="id2716239"></a><pre class="programlisting">gint32 gimp_layer_new_from_pixbuf (gint32 image_ID,
const gchar *name,
GdkPixbuf *pixbuf,
gdouble opacity,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode,
gdouble progress_start,
gdouble progress_end);</pre>
<p>
Create a new layer from a <code class="literal">GdkPixbuf</code>.
</p>
<p>
This procedure creates a new layer from the given <code class="literal">GdkPixbuf</code>. The
image has to be an RGB image and just like with <a href="libgimp-gimplayer.html#gimp-layer-new"><code class="function">gimp_layer_new()</code></a>
you will still need to add the layer to it.
</p>
<p>
If you pass <em class="parameter"><code>progress_end</code></em> &gt; <em class="parameter"><code>progress_start</code></em> to this function,
@<a href="libgimp-gimpprogress.html#gimp-progress-update"><code class="function">gimp_progress_update()</code></a> will be called for. You have to call
@<a href="libgimp-gimpprogress.html#gimp-progress-init"><code class="function">gimp_progress_init()</code></a> beforehand.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The RGB image to which to add the layer.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The layer name.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pixbuf</code></em>&#160;:</span></td>
<td> A GdkPixbuf.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The layer opacity.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mode</code></em>&#160;:</span></td>
<td> The layer combination mode.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>progress_start</code></em>&#160;:</span></td>
<td> start of progress
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>progress_end</code></em>&#160;:</span></td>
<td> end of progress
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The newly created layer.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>