← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimppixbuf.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimppixbuf.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="libgimp-gimppixbuf">
 
6
<refmeta>
 
7
<refentrytitle>gimppixbuf</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimppixbuf</refname><refpurpose>Get a thumbnail pixbuf for a drawable or image.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
enum        <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link>;
 
23
<link linkend="GdkPixbuf">GdkPixbuf</link>*  <link linkend="gimp-image-get-thumbnail">gimp_image_get_thumbnail</link>        (<link linkend="gint32">gint32</link> image_ID,
 
24
                                             <link linkend="gint">gint</link> width,
 
25
                                             <link linkend="gint">gint</link> height,
 
26
                                             <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);
 
27
<link linkend="GdkPixbuf">GdkPixbuf</link>*  <link linkend="gimp-drawable-get-thumbnail">gimp_drawable_get_thumbnail</link>     (<link linkend="gint32">gint32</link> drawable_ID,
 
28
                                             <link linkend="gint">gint</link> width,
 
29
                                             <link linkend="gint">gint</link> height,
 
30
                                             <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);
 
31
<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,
 
32
                                             <link linkend="gint">gint</link> src_x,
 
33
                                             <link linkend="gint">gint</link> src_y,
 
34
                                             <link linkend="gint">gint</link> src_width,
 
35
                                             <link linkend="gint">gint</link> src_height,
 
36
                                             <link linkend="gint">gint</link> dest_width,
 
37
                                             <link linkend="gint">gint</link> dest_height,
 
38
                                             <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);
 
39
</synopsis>
 
40
</refsynopsisdiv>
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
<refsect1>
 
51
<title>Description</title>
 
52
<para>
 
53
Get a thumbnail pixbuf for a drawable or image.
 
54
</para>
 
55
</refsect1>
 
56
 
 
57
<refsect1>
 
58
<title>Details</title>
 
59
<refsect2>
 
60
<title><anchor id="GimpPixbufTransparency"/>enum GimpPixbufTransparency</title>
 
61
<indexterm><primary>GimpPixbufTransparency</primary></indexterm><programlisting>typedef enum
 
62
{
 
63
  GIMP_PIXBUF_KEEP_ALPHA,
 
64
  GIMP_PIXBUF_SMALL_CHECKS,
 
65
  GIMP_PIXBUF_LARGE_CHECKS
 
66
} GimpPixbufTransparency;
 
67
</programlisting>
 
68
<para>
 
69
 
 
70
</para></refsect2>
 
71
<refsect2>
 
72
<title><anchor id="gimp-image-get-thumbnail"/>gimp_image_get_thumbnail ()</title>
 
73
<indexterm role="GIMP 2.2"><primary>gimp_image_get_thumbnail</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>*  gimp_image_get_thumbnail        (<link linkend="gint32">gint32</link> image_ID,
 
74
                                             <link linkend="gint">gint</link> width,
 
75
                                             <link linkend="gint">gint</link> height,
 
76
                                             <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);</programlisting>
 
77
<para>
 
78
Retrieves a thumbnail pixbuf for the image identified by <parameter>image_ID</parameter>.
 
79
The thumbnail will be not larger than the requested size.</para>
 
80
<para>
 
81
 
 
82
</para><variablelist role="params">
 
83
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
 
84
<listitem><simpara> the image ID
 
85
</simpara></listitem></varlistentry>
 
86
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
87
<listitem><simpara>    the requested thumbnail width  (&lt;= 512 pixels)
 
88
</simpara></listitem></varlistentry>
 
89
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
90
<listitem><simpara>   the requested thumbnail height (&lt;= 512 pixels)
 
91
</simpara></listitem></varlistentry>
 
92
<varlistentry><term><parameter>alpha</parameter>&nbsp;:</term>
 
93
<listitem><simpara>    how to handle an alpha channel
 
94
</simpara></listitem></varlistentry>
 
95
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
 
96
 
 
97
</simpara></listitem></varlistentry>
 
98
</variablelist><para>Since  GIMP 2.2
 
99
</para></refsect2>
 
100
<refsect2>
 
101
<title><anchor id="gimp-drawable-get-thumbnail"/>gimp_drawable_get_thumbnail ()</title>
 
102
<indexterm role="GIMP 2.2"><primary>gimp_drawable_get_thumbnail</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>*  gimp_drawable_get_thumbnail     (<link linkend="gint32">gint32</link> drawable_ID,
 
103
                                             <link linkend="gint">gint</link> width,
 
104
                                             <link linkend="gint">gint</link> height,
 
105
                                             <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);</programlisting>
 
106
<para>
 
107
Retrieves a thumbnail pixbuf for the drawable identified by
 
108
<parameter>drawable_ID</parameter>. The thumbnail will be not larger than the requested
 
109
size.</para>
 
110
<para>
 
111
 
 
112
</para><variablelist role="params">
 
113
<varlistentry><term><parameter>drawable_ID</parameter>&nbsp;:</term>
 
114
<listitem><simpara> the drawable ID
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
117
<listitem><simpara>       the requested thumbnail width  (&lt;= 512 pixels)
 
118
</simpara></listitem></varlistentry>
 
119
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
120
<listitem><simpara>      the requested thumbnail height (&lt;= 512 pixels)
 
121
</simpara></listitem></varlistentry>
 
122
<varlistentry><term><parameter>alpha</parameter>&nbsp;:</term>
 
123
<listitem><simpara>       how to handle an alpha channel
 
124
</simpara></listitem></varlistentry>
 
125
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
 
126
 
 
127
</simpara></listitem></varlistentry>
 
128
</variablelist><para>Since  GIMP 2.2
 
129
</para></refsect2>
 
130
<refsect2>
 
131
<title><anchor id="gimp-drawable-get-sub-thumbnail"/>gimp_drawable_get_sub_thumbnail ()</title>
 
132
<indexterm role="GIMP 2.2"><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,
 
133
                                             <link linkend="gint">gint</link> src_x,
 
134
                                             <link linkend="gint">gint</link> src_y,
 
135
                                             <link linkend="gint">gint</link> src_width,
 
136
                                             <link linkend="gint">gint</link> src_height,
 
137
                                             <link linkend="gint">gint</link> dest_width,
 
138
                                             <link linkend="gint">gint</link> dest_height,
 
139
                                             <link linkend="GimpPixbufTransparency">GimpPixbufTransparency</link> alpha);</programlisting>
 
140
<para>
 
141
Retrieves a thumbnail pixbuf for the drawable identified by
 
142
<parameter>drawable_ID</parameter>. The thumbnail will be not larger than the requested
 
143
size.</para>
 
144
<para>
 
145
 
 
146
</para><variablelist role="params">
 
147
<varlistentry><term><parameter>drawable_ID</parameter>&nbsp;:</term>
 
148
<listitem><simpara> the drawable ID
 
149
</simpara></listitem></varlistentry>
 
150
<varlistentry><term><parameter>src_x</parameter>&nbsp;:</term>
 
151
<listitem><simpara>       the x coordinate of the area
 
152
</simpara></listitem></varlistentry>
 
153
<varlistentry><term><parameter>src_y</parameter>&nbsp;:</term>
 
154
<listitem><simpara>       the y coordinate of the area
 
155
</simpara></listitem></varlistentry>
 
156
<varlistentry><term><parameter>src_width</parameter>&nbsp;:</term>
 
157
<listitem><simpara>   the width of the area
 
158
</simpara></listitem></varlistentry>
 
159
<varlistentry><term><parameter>src_height</parameter>&nbsp;:</term>
 
160
<listitem><simpara>  the height of the area
 
161
</simpara></listitem></varlistentry>
 
162
<varlistentry><term><parameter>dest_width</parameter>&nbsp;:</term>
 
163
<listitem><simpara>  the requested thumbnail width  (&lt;= 512 pixels)
 
164
</simpara></listitem></varlistentry>
 
165
<varlistentry><term><parameter>dest_height</parameter>&nbsp;:</term>
 
166
<listitem><simpara> the requested thumbnail height (&lt;= 512 pixels)
 
167
</simpara></listitem></varlistentry>
 
168
<varlistentry><term><parameter>alpha</parameter>&nbsp;:</term>
 
169
<listitem><simpara>       how to handle an alpha channel
 
170
</simpara></listitem></varlistentry>
 
171
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
 
172
 
 
173
</simpara></listitem></varlistentry>
 
174
</variablelist><para>Since  GIMP 2.2
 
175
</para></refsect2>
 
176
 
 
177
</refsect1>
 
178
 
 
179
 
 
180
 
 
181
 
 
182
</refentry>