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
<!ENTITY version SYSTEM "version.xml">
7
<refentry id="goffice-06-go-pixbuf">
9
<refentrytitle role="top_of_page" id="goffice-06-go-pixbuf.top_of_page">go-pixbuf</refentrytitle>
10
<manvolnum>3</manvolnum>
11
<refmiscinfo>GOFFICE-0.6 Library</refmiscinfo>
15
<refname>go-pixbuf</refname>
16
<refpurpose></refpurpose>
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
20
<refsynopsisdiv id="goffice-06-go-pixbuf.synopsis" role="synopsis">
21
<title role="synopsis.title">Synopsis</title>
24
<link linkend="GdkPixbuf">GdkPixbuf</link> * <link linkend="go-pixbuf-intelligent-scale">go_pixbuf_intelligent_scale</link> (<link linkend="GdkPixbuf">GdkPixbuf</link> *buf,
25
<link linkend="guint">guint</link> width,
26
<link linkend="guint">guint</link> height);
27
<link linkend="GdkPixbuf">GdkPixbuf</link> * <link linkend="go-pixbuf-new-from-file">go_pixbuf_new_from_file</link> (<link linkend="char">char</link> const *filename);
28
<link linkend="GdkPixbuf">GdkPixbuf</link> * <link linkend="go-pixbuf-get-from-cache">go_pixbuf_get_from_cache</link> (<link linkend="char">char</link> const *filename);
29
<link linkend="GdkPixbuf">GdkPixbuf</link> * <link linkend="go-pixbuf-tile">go_pixbuf_tile</link> (<link linkend="GdkPixbuf">GdkPixbuf</link> const *src,
30
<link linkend="guint">guint</link> w,
31
<link linkend="guint">guint</link> h);
43
<refsect1 id="goffice-06-go-pixbuf.description" role="desc">
44
<title role="desc.title">Description</title>
50
<refsect1 id="goffice-06-go-pixbuf.details" role="details">
51
<title role="details.title">Details</title>
52
<refsect2 id="go-pixbuf-intelligent-scale" role="function">
53
<title>go_pixbuf_intelligent_scale ()</title>
54
<indexterm zone="go-pixbuf-intelligent-scale"><primary>go_pixbuf_intelligent_scale</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link> * go_pixbuf_intelligent_scale (<link linkend="GdkPixbuf">GdkPixbuf</link> *buf,
55
<link linkend="guint">guint</link> width,
56
<link linkend="guint">guint</link> height);</programlisting>
58
Intelligent pixbuf scaling.</para>
61
</para><variablelist role="params">
62
<varlistentry><term><parameter>buf</parameter> :</term>
63
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
64
</simpara></listitem></varlistentry>
65
<varlistentry><term><parameter>width</parameter> :</term>
66
<listitem><simpara> new width
67
</simpara></listitem></varlistentry>
68
<varlistentry><term><parameter>height</parameter> :</term>
69
<listitem><simpara> new height
70
</simpara></listitem></varlistentry>
71
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new GdkPixbuf reference.
72
</simpara></listitem></varlistentry>
73
</variablelist></refsect2>
74
<refsect2 id="go-pixbuf-new-from-file" role="function">
75
<title>go_pixbuf_new_from_file ()</title>
76
<indexterm zone="go-pixbuf-new-from-file"><primary>go_pixbuf_new_from_file</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link> * go_pixbuf_new_from_file (<link linkend="char">char</link> const *filename);</programlisting>
78
Utility routine to create pixbufs from file <parameter>name</parameter> in the goffice_icon_dir.</para>
81
</para><variablelist role="params">
82
<varlistentry><term><parameter>filename</parameter> :</term>
83
<listitem><simpara> pixbuf filename
84
</simpara></listitem></varlistentry>
85
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GdkPixbuf that the caller is responsible for.
86
</simpara></listitem></varlistentry>
87
</variablelist></refsect2>
88
<refsect2 id="go-pixbuf-get-from-cache" role="function">
89
<title>go_pixbuf_get_from_cache ()</title>
90
<indexterm zone="go-pixbuf-get-from-cache"><primary>go_pixbuf_get_from_cache</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link> * go_pixbuf_get_from_cache (<link linkend="char">char</link> const *filename);</programlisting>
92
Retrieves a pixbuf from the image cache, loading it from the file
93
<parameter>filename</parameter> located in goffice_icon_dir if not cached yet.</para>
96
</para><variablelist role="params">
97
<varlistentry><term><parameter>filename</parameter> :</term>
98
<listitem><simpara> pixbuf filename
99
</simpara></listitem></varlistentry>
100
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GdkPixbuf, NULL on error.
101
</simpara></listitem></varlistentry>
102
</variablelist></refsect2>
103
<refsect2 id="go-pixbuf-tile" role="function">
104
<title>go_pixbuf_tile ()</title>
105
<indexterm zone="go-pixbuf-tile"><primary>go_pixbuf_tile</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link> * go_pixbuf_tile (<link linkend="GdkPixbuf">GdkPixbuf</link> const *src,
106
<link linkend="guint">guint</link> w,
107
<link linkend="guint">guint</link> h);</programlisting>
112
</para><variablelist role="params">
113
<varlistentry><term><parameter>src</parameter> :</term>
114
<listitem><simpara> source pixbuf
115
</simpara></listitem></varlistentry>
116
<varlistentry><term><parameter>w</parameter> :</term>
117
<listitem><simpara> desired width
118
</simpara></listitem></varlistentry>
119
<varlistentry><term><parameter>h</parameter> :</term>
120
<listitem><simpara> desired height
121
</simpara></listitem></varlistentry>
122
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new pixbuf consisting of the source pixbuf tiled
123
enough times to fill out the space needed.
125
The fractional tiles are spead evenly left-right and top-bottom.
126
</simpara></listitem></varlistentry>
127
</variablelist></refsect2>
added
removed
docs/reference/xml/go-pixbuf.xml
