Files
gimp/devel-docs/libgimp/xml/gimppixbuf.xml
2010-08-11 01:13:56 -04:00

183 lines
8.9 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimppixbuf">
<refmeta>
<refentrytitle>gimppixbuf</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimppixbuf</refname><refpurpose>Get a thumbnail pixbuf for a drawable or image.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
enum <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link>;
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="gimp-image-get-thumbnail">gimp_image_get_thumbnail</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
<link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="gimp-drawable-get-thumbnail">gimp_drawable_get_thumbnail</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
<link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="gimp-drawable-get-sub-thumbnail">gimp_drawable_get_sub_thumbnail</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> src_x,
<link linkend="gint">gint</link> src_y,
<link linkend="gint">gint</link> src_width,
<link linkend="gint">gint</link> src_height,
<link linkend="gint">gint</link> dest_width,
<link linkend="gint">gint</link> dest_height,
<link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Get a thumbnail pixbuf for a drawable or image.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpPixbufTransparency"/>enum GimpPixbufTransparency</title>
<indexterm><primary>GimpPixbufTransparency</primary></indexterm><programlisting>typedef enum
{
GIMP_PIXBUF_KEEP_ALPHA,
GIMP_PIXBUF_SMALL_CHECKS,
GIMP_PIXBUF_LARGE_CHECKS
} GimpPixbufTransparency;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-image-get-thumbnail"/>gimp_image_get_thumbnail ()</title>
<indexterm role="GIMP"><primary>gimp_image_get_thumbnail</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* gimp_image_get_thumbnail (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
<link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);</programlisting>
<para>
Retrieves a thumbnail pixbuf for the image identified by <parameter>image_ID</parameter>.
The thumbnail will be not larger than the requested size.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
<listitem><simpara> the image ID
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> the requested thumbnail width (&lt;= 512 pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> the requested thumbnail height (&lt;= 512 pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alpha</parameter>&nbsp;:</term>
<listitem><simpara> how to handle an alpha channel
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-drawable-get-thumbnail"/>gimp_drawable_get_thumbnail ()</title>
<indexterm role="GIMP"><primary>gimp_drawable_get_thumbnail</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* gimp_drawable_get_thumbnail (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
<link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);</programlisting>
<para>
Retrieves a thumbnail pixbuf for the drawable identified by
<parameter>drawable_ID</parameter>. The thumbnail will be not larger than the requested
size.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter>&nbsp;:</term>
<listitem><simpara> the drawable ID
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> the requested thumbnail width (&lt;= 512 pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> the requested thumbnail height (&lt;= 512 pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alpha</parameter>&nbsp;:</term>
<listitem><simpara> how to handle an alpha channel
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-drawable-get-sub-thumbnail"/>gimp_drawable_get_sub_thumbnail ()</title>
<indexterm role="GIMP"><primary>gimp_drawable_get_sub_thumbnail</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* gimp_drawable_get_sub_thumbnail (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> src_x,
<link linkend="gint">gint</link> src_y,
<link linkend="gint">gint</link> src_width,
<link linkend="gint">gint</link> src_height,
<link linkend="gint">gint</link> dest_width,
<link linkend="gint">gint</link> dest_height,
<link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);</programlisting>
<para>
Retrieves a thumbnail pixbuf for the drawable identified by
<parameter>drawable_ID</parameter>. The thumbnail will be not larger than the requested
size.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter>&nbsp;:</term>
<listitem><simpara> the drawable ID
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src_x</parameter>&nbsp;:</term>
<listitem><simpara> the x coordinate of the area
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src_y</parameter>&nbsp;:</term>
<listitem><simpara> the y coordinate of the area
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src_width</parameter>&nbsp;:</term>
<listitem><simpara> the width of the area
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src_height</parameter>&nbsp;:</term>
<listitem><simpara> the height of the area
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_width</parameter>&nbsp;:</term>
<listitem><simpara> the requested thumbnail width (&lt;= 512 pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_height</parameter>&nbsp;:</term>
<listitem><simpara> the requested thumbnail height (&lt;= 512 pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alpha</parameter>&nbsp;:</term>
<listitem><simpara> how to handle an alpha channel
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>