File: libgimp-gimptile.html

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (233 lines) | stat: -rw-r--r-- 9,133 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimptile</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimptexttool.html" title="gimptexttool">
<link rel="next" href="libgimp-gimptools.html" title="gimptools">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#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 all 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;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</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="libgimp-gimptexttool.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.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="libgimp-gimptools.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="#id2562486" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2618678" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimptile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2562486"></a><span class="refentrytitle">gimptile</span>
</h2>
<p>gimptile &#8212; Functions for working with tiles.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



            <a href="libgimp-gimptile.html#GimpTile">GimpTile</a>;
void        <a href="libgimp-gimptile.html#gimp-tile-ref">gimp_tile_ref</a>                   (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile);
void        <a href="libgimp-gimptile.html#gimp-tile-ref-zero">gimp_tile_ref_zero</a>              (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile);
void        <a href="libgimp-gimptile.html#gimp-tile-unref">gimp_tile_unref</a>                 (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile,
                                             gboolean dirty);
void        <a href="libgimp-gimptile.html#gimp-tile-flush">gimp_tile_flush</a>                 (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile);
void        <a href="libgimp-gimptile.html#gimp-tile-cache-size">gimp_tile_cache_size</a>            (gulong kilobytes);
void        <a href="libgimp-gimptile.html#gimp-tile-cache-ntiles">gimp_tile_cache_ntiles</a>          (gulong ntiles);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2618678"></a><h2>Description</h2>
<p>
Functions for working with tiles.

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2618694"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2618704"></a><h3>
<a name="GimpTile"></a>GimpTile</h3>
<a class="indexterm" name="id2618716"></a><pre class="programlisting">typedef struct {
  guint         ewidth;     /* the effective width of the tile */
  guint         eheight;    /* the effective height of the tile */
  guint         bpp;        /* the bytes per pixel (1, 2, 3 or 4 ) */
  guint         tile_num;   /* the number of this tile within the drawable */
  guint16       ref_count;  /* reference count for the tile */
  guint         dirty : 1;  /* is the tile dirty? has it been modified? */
  guint         shadow: 1;  /* is this a shadow tile */
  guchar       *data;       /* the pixel data for the tile */
  GimpDrawable *drawable;   /* the drawable this tile came from */
} GimpTile;
</pre>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536610"></a><h3>
<a name="gimp-tile-ref"></a>gimp_tile_ref ()</h3>
<a class="indexterm" name="id2526878"></a><pre class="programlisting">void        gimp_tile_ref                   (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>tile</code></em>&#160;:</span></td>
<td>


</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623849"></a><h3>
<a name="gimp-tile-ref-zero"></a>gimp_tile_ref_zero ()</h3>
<a class="indexterm" name="id2623860"></a><pre class="programlisting">void        gimp_tile_ref_zero              (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>tile</code></em>&#160;:</span></td>
<td>


</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623904"></a><h3>
<a name="gimp-tile-unref"></a>gimp_tile_unref ()</h3>
<a class="indexterm" name="id2623915"></a><pre class="programlisting">void        gimp_tile_unref                 (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile,
                                             gboolean dirty);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>tile</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>dirty</code></em>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623981"></a><h3>
<a name="gimp-tile-flush"></a>gimp_tile_flush ()</h3>
<a class="indexterm" name="id2623993"></a><pre class="programlisting">void        gimp_tile_flush                 (<a href="libgimp-gimptile.html#GimpTile">GimpTile</a> *tile);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>tile</code></em>&#160;:</span></td>
<td>


</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623510"></a><h3>
<a name="gimp-tile-cache-size"></a>gimp_tile_cache_size ()</h3>
<a class="indexterm" name="id2623521"></a><pre class="programlisting">void        gimp_tile_cache_size            (gulong kilobytes);</pre>
<p>
Sets the size of the tile cache on the plug-in side. The tile cache
is used to reduce the number of tiles exchanged between the GIMP core
and the plug-in. See also <a href="libgimp-gimptile.html#gimp-tile-cache-ntiles"><code class="function">gimp_tile_cache_ntiles()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>kilobytes</code></em>&#160;:</span></td>
<td> new cache size in kilobytes
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623580"></a><h3>
<a name="gimp-tile-cache-ntiles"></a>gimp_tile_cache_ntiles ()</h3>
<a class="indexterm" name="id2623592"></a><pre class="programlisting">void        gimp_tile_cache_ntiles          (gulong ntiles);</pre>
<p>
Sets the size of the tile cache on the plug-in side. This function
is similar to <a href="libgimp-gimptile.html#gimp-tile-cache-size"><code class="function">gimp_tile_cache_size()</code></a> but allows to specify the
number of tiles directly.
</p>
<p>
If your plug-in access pixels tile-by-tile, it doesn't need a tile
cache at all. If however the plug-in accesses drawable pixel data
row-by-row, it should set the tile cache large enough to hold the
number of tiles per row. Double this size if your plug-in uses
shadow tiles.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>ntiles</code></em>&#160;:</span></td>
<td> number of tiles that should fit into the cache
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>