← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimptile.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-gimptile">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimp-gimptile.top_of_page">gimptile</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimptile</refname>
14
 
<refpurpose>Functions for working with tiles.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimp-gimptile.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
                    <link linkend="GimpTile">GimpTile</link>;
22
 
<link linkend="void">void</link>                <link linkend="gimp-tile-ref">gimp_tile_ref</link>                       (<link linkend="GimpTile">GimpTile</link> *tile);
23
 
<link linkend="void">void</link>                <link linkend="gimp-tile-ref-zero">gimp_tile_ref_zero</link>                  (<link linkend="GimpTile">GimpTile</link> *tile);
24
 
<link linkend="void">void</link>                <link linkend="gimp-tile-unref">gimp_tile_unref</link>                     (<link linkend="GimpTile">GimpTile</link> *tile,
25
 
                                                         <link linkend="gboolean">gboolean</link> dirty);
26
 
<link linkend="void">void</link>                <link linkend="gimp-tile-flush">gimp_tile_flush</link>                     (<link linkend="GimpTile">GimpTile</link> *tile);
27
 
<link linkend="void">void</link>                <link linkend="gimp-tile-cache-size">gimp_tile_cache_size</link>                (<link linkend="gulong">gulong</link> kilobytes);
28
 
<link linkend="void">void</link>                <link linkend="gimp-tile-cache-ntiles">gimp_tile_cache_ntiles</link>              (<link linkend="gulong">gulong</link> ntiles);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
<refsect1 id="libgimp-gimptile.description" role="desc">
41
 
<title role="desc.title">Description</title>
42
 
<para>
43
 
Functions for working with tiles.
44
 
</para>
45
 
</refsect1>
46
 
 
47
 
<refsect1 id="libgimp-gimptile.details" role="details">
48
 
<title role="details.title">Details</title>
49
 
<refsect2 id="GimpTile" role="struct">
50
 
<title>GimpTile</title>
51
 
<indexterm zone="GimpTile"><primary sortas="GimpTile">GimpTile</primary></indexterm><programlisting>typedef struct {
52
 
  guint         ewidth;     /* the effective width of the tile */
53
 
  guint         eheight;    /* the effective height of the tile */
54
 
  guint         bpp;        /* the bytes per pixel (1, 2, 3 or 4 ) */
55
 
  guint         tile_num;   /* the number of this tile within the drawable */
56
 
  guint16       ref_count;  /* reference count for the tile */
57
 
  guint         dirty : 1;  /* is the tile dirty? has it been modified? */
58
 
  guint         shadow: 1;  /* is this a shadow tile */
59
 
  guchar       *data;       /* the pixel data for the tile */
60
 
  GimpDrawable *drawable;   /* the drawable this tile came from */
61
 
} GimpTile;
62
 
</programlisting>
63
 
<para>
64
 
</para></refsect2>
65
 
<refsect2 id="gimp-tile-ref" role="function">
66
 
<title>gimp_tile_ref ()</title>
67
 
<indexterm zone="gimp-tile-ref"><primary sortas="gimp_tile_ref">gimp_tile_ref</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_tile_ref                       (<link linkend="GimpTile">GimpTile</link> *tile);</programlisting>
68
 
<para>
69
 
</para><variablelist role="params">
70
 
<varlistentry><term><parameter>tile</parameter>&#160;:</term>
71
 
<listitem><simpara>
72
 
</simpara></listitem></varlistentry>
73
 
</variablelist></refsect2>
74
 
<refsect2 id="gimp-tile-ref-zero" role="function">
75
 
<title>gimp_tile_ref_zero ()</title>
76
 
<indexterm zone="gimp-tile-ref-zero"><primary sortas="gimp_tile_ref_zero">gimp_tile_ref_zero</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_tile_ref_zero                  (<link linkend="GimpTile">GimpTile</link> *tile);</programlisting>
77
 
<para>
78
 
</para><variablelist role="params">
79
 
<varlistentry><term><parameter>tile</parameter>&#160;:</term>
80
 
<listitem><simpara>
81
 
</simpara></listitem></varlistentry>
82
 
</variablelist></refsect2>
83
 
<refsect2 id="gimp-tile-unref" role="function">
84
 
<title>gimp_tile_unref ()</title>
85
 
<indexterm zone="gimp-tile-unref"><primary sortas="gimp_tile_unref">gimp_tile_unref</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_tile_unref                     (<link linkend="GimpTile">GimpTile</link> *tile,
86
 
                                                         <link linkend="gboolean">gboolean</link> dirty);</programlisting>
87
 
<para>
88
 
</para><variablelist role="params">
89
 
<varlistentry><term><parameter>tile</parameter>&#160;:</term>
90
 
<listitem><simpara>
91
 
</simpara></listitem></varlistentry>
92
 
<varlistentry><term><parameter>dirty</parameter>&#160;:</term>
93
 
<listitem><simpara>
94
 
</simpara></listitem></varlistentry>
95
 
</variablelist></refsect2>
96
 
<refsect2 id="gimp-tile-flush" role="function">
97
 
<title>gimp_tile_flush ()</title>
98
 
<indexterm zone="gimp-tile-flush"><primary sortas="gimp_tile_flush">gimp_tile_flush</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_tile_flush                     (<link linkend="GimpTile">GimpTile</link> *tile);</programlisting>
99
 
<para>
100
 
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>tile</parameter>&#160;:</term>
102
 
<listitem><simpara>
103
 
</simpara></listitem></varlistentry>
104
 
</variablelist></refsect2>
105
 
<refsect2 id="gimp-tile-cache-size" role="function">
106
 
<title>gimp_tile_cache_size ()</title>
107
 
<indexterm zone="gimp-tile-cache-size"><primary sortas="gimp_tile_cache_size">gimp_tile_cache_size</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_tile_cache_size                (<link linkend="gulong">gulong</link> kilobytes);</programlisting>
108
 
<para>
109
 
Sets the size of the tile cache on the plug-in side. The tile cache
110
 
is used to reduce the number of tiles exchanged between the GIMP core
111
 
and the plug-in. See also <link linkend="gimp-tile-cache-ntiles"><function>gimp_tile_cache_ntiles()</function></link>.</para>
112
 
<para>
113
 
</para><variablelist role="params">
114
 
<varlistentry><term><parameter>kilobytes</parameter>&#160;:</term>
115
 
<listitem><simpara> new cache size in kilobytes
116
 
</simpara></listitem></varlistentry>
117
 
</variablelist></refsect2>
118
 
<refsect2 id="gimp-tile-cache-ntiles" role="function">
119
 
<title>gimp_tile_cache_ntiles ()</title>
120
 
<indexterm zone="gimp-tile-cache-ntiles"><primary sortas="gimp_tile_cache_ntiles">gimp_tile_cache_ntiles</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_tile_cache_ntiles              (<link linkend="gulong">gulong</link> ntiles);</programlisting>
121
 
<para>
122
 
Sets the size of the tile cache on the plug-in side. This function
123
 
is similar to <link linkend="gimp-tile-cache-size"><function>gimp_tile_cache_size()</function></link> but allows to specify the
124
 
number of tiles directly.
125
 
</para>
126
 
<para>
127
 
If your plug-in access pixels tile-by-tile, it doesn't need a tile
128
 
cache at all. If however the plug-in accesses drawable pixel data
129
 
row-by-row, it should set the tile cache large enough to hold the
130
 
number of tiles per row. Double this size if your plug-in uses
131
 
shadow tiles.</para>
132
 
<para>
133
 
</para><variablelist role="params">
134
 
<varlistentry><term><parameter>ntiles</parameter>&#160;:</term>
135
 
<listitem><simpara> number of tiles that should fit into the cache
136
 
</simpara></listitem></varlistentry>
137
 
</variablelist></refsect2>
138
 
 
139
 
</refsect1>
140
 
 
141
 
 
142
 
 
143
 
 
144
 
</refentry>