~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/libgimpwidgets-GimpCairoUtils.html

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gimpcairo-utils</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
9
9
<link rel="prev" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
10
10
<link rel="next" href="libgimpwidgets-GimpHelpUI.html" title="GimpHelpUI">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="libgimpwidgets-GimpHelpUI.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
36
36
</tr>
37
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimpwidgets-GimpCairoUtils.synopsis" class="shortcut">Top</a>
38
 
                   | 
39
 
                  <a href="#libgimpwidgets-GimpCairoUtils.description" class="shortcut">Description</a></nobr></td></tr>
 
37
<tr><td colspan="5" class="shortcuts">
 
38
<a href="#libgimpwidgets-GimpCairoUtils.synopsis" class="shortcut">Top</a>
 
39
                 | 
 
40
                <a href="#libgimpwidgets-GimpCairoUtils.description" class="shortcut">Description</a>
 
41
</td></tr>
40
42
</table>
41
 
<div class="refentry" lang="en">
 
43
<div class="refentry" title="gimpcairo-utils">
42
44
<a name="libgimpwidgets-GimpCairoUtils"></a><div class="titlepage"></div>
43
45
<div class="refnamediv"><table width="100%"><tr>
44
46
<td valign="top">
47
49
</td>
48
50
<td valign="top" align="right"></td>
49
51
</tr></table></div>
50
 
<div class="refsynopsisdiv">
 
52
<div class="refsynopsisdiv" title="Synopsis">
51
53
<a name="libgimpwidgets-GimpCairoUtils.synopsis"></a><h2>Synopsis</h2>
52
54
<pre class="synopsis">
53
55
void                <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-set-source-rgb" title="gimp_cairo_set_source_rgb ()">gimp_cairo_set_source_rgb</a>           (<a
54
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
56
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
55
57
>cairo_t</a> *cr,
56
58
                                                         const <a
57
59
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
58
60
>GimpRGB</a> *color);
59
61
void                <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-set-source-rgba" title="gimp_cairo_set_source_rgba ()">gimp_cairo_set_source_rgba</a>          (<a
60
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
62
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
61
63
>cairo_t</a> *cr,
62
64
                                                         const <a
63
65
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
65
67
<a
66
68
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
67
69
>gboolean</a>            <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-set-focus-line-pattern" title="gimp_cairo_set_focus_line_pattern ()">gimp_cairo_set_focus_line_pattern</a>   (<a
68
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
70
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
69
71
>cairo_t</a> *cr,
70
72
                                                         <a
71
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
73
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
72
74
>GtkWidget</a> *widget);
73
75
<a
74
 
href="/usr/share/gtk-doc/html/cairo/cairo-Patterns.html#cairo-pattern-t"
75
 
>cairo_pattern_t</a>*    <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-checkerboard-create" title="gimp_cairo_checkerboard_create ()">gimp_cairo_checkerboard_create</a>      (<a
76
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
76
href="/usr/share/gtk-doc/html/cairo/cairo-pattern.html#cairo-pattern-t"
 
77
>cairo_pattern_t</a> *   <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-checkerboard-create" title="gimp_cairo_checkerboard_create ()">gimp_cairo_checkerboard_create</a>      (<a
 
78
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
77
79
>cairo_t</a> *cr,
78
80
                                                         <a
79
81
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
85
87
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
86
88
>GimpRGB</a> *dark);
87
89
<a
88
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"
89
 
>cairo_surface_t</a>*    <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-surface-create-from-pixbuf" title="gimp_cairo_surface_create_from_pixbuf ()">gimp_cairo_surface_create_from_pixbuf</a>
 
90
href="/usr/share/gtk-doc/html/cairo/cairo-surface.html#cairo-surface-t"
 
91
>cairo_surface_t</a> *   <a class="link" href="libgimpwidgets-GimpCairoUtils.html#gimp-cairo-surface-create-from-pixbuf" title="gimp_cairo_surface_create_from_pixbuf ()">gimp_cairo_surface_create_from_pixbuf</a>
90
92
                                                        (<a
91
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
93
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
92
94
>GdkPixbuf</a> *pixbuf);
93
 
#define             <a class="link" href="libgimpwidgets-GimpCairoUtils.html#GIMP-CAIRO-RGB24-SET-PIXEL:CAPS" title="GIMP_CAIRO_RGB24_SET_PIXEL()">GIMP_CAIRO_RGB24_SET_PIXEL</a>          (d, r, g, b)
94
 
#define             <a class="link" href="libgimpwidgets-GimpCairoUtils.html#GIMP-CAIRO-ARGB32-SET-PIXEL:CAPS" title="GIMP_CAIRO_ARGB32_SET_PIXEL()">GIMP_CAIRO_ARGB32_SET_PIXEL</a>         (d, r, g, b, a)
 
95
#define             <a class="link" href="libgimpwidgets-GimpCairoUtils.html#GIMP-CAIRO-RGB24-SET-PIXEL--CAPS" title="GIMP_CAIRO_RGB24_SET_PIXEL()">GIMP_CAIRO_RGB24_SET_PIXEL</a>          (d, r, g, b)
 
96
#define             <a class="link" href="libgimpwidgets-GimpCairoUtils.html#GIMP-CAIRO-ARGB32-SET-PIXEL--CAPS" title="GIMP_CAIRO_ARGB32_SET_PIXEL()">GIMP_CAIRO_ARGB32_SET_PIXEL</a>         (d, r, g, b, a)
95
97
</pre>
96
98
</div>
97
 
<div class="refsect1" lang="en">
 
99
<div class="refsect1" title="Description">
98
100
<a name="libgimpwidgets-GimpCairoUtils.description"></a><h2>Description</h2>
99
101
<p>
100
 
 
101
102
</p>
102
103
</div>
103
 
<div class="refsect1" lang="en">
 
104
<div class="refsect1" title="Details">
104
105
<a name="libgimpwidgets-GimpCairoUtils.details"></a><h2>Details</h2>
105
 
<div class="refsect2" lang="en">
 
106
<div class="refsect2" title="gimp_cairo_set_source_rgb ()">
106
107
<a name="gimp-cairo-set-source-rgb"></a><h3>gimp_cairo_set_source_rgb ()</h3>
107
108
<pre class="programlisting">void                gimp_cairo_set_source_rgb           (<a
108
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
109
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
109
110
>cairo_t</a> *cr,
110
111
                                                         const <a
111
112
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
116
117
</p>
117
118
<p>
118
119
This function calls <a
119
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-set-source-rgb"
 
120
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-set-source-rgb"
120
121
><code class="function">cairo_set_source_rgb()</code></a> for you.</p>
121
122
<p>
122
 
 
123
123
</p>
124
124
<div class="variablelist"><table border="0">
125
125
<col align="left" valign="top">
136
136
</tr>
137
137
</tbody>
138
138
</table></div>
139
 
<p class="since">Since  GIMP 2.6
140
 
</p>
 
139
<p class="since">Since GIMP 2.6</p>
141
140
</div>
142
141
<hr>
143
 
<div class="refsect2" lang="en">
 
142
<div class="refsect2" title="gimp_cairo_set_source_rgba ()">
144
143
<a name="gimp-cairo-set-source-rgba"></a><h3>gimp_cairo_set_source_rgba ()</h3>
145
144
<pre class="programlisting">void                gimp_cairo_set_source_rgba          (<a
146
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
145
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
147
146
>cairo_t</a> *cr,
148
147
                                                         const <a
149
148
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
154
153
</p>
155
154
<p>
156
155
This function calls <a
157
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-set-source-rgba"
 
156
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-set-source-rgba"
158
157
><code class="function">cairo_set_source_rgba()</code></a> for you.</p>
159
158
<p>
160
 
 
161
159
</p>
162
160
<div class="variablelist"><table border="0">
163
161
<col align="left" valign="top">
174
172
</tr>
175
173
</tbody>
176
174
</table></div>
177
 
<p class="since">Since  GIMP 2.6
178
 
</p>
 
175
<p class="since">Since GIMP 2.6</p>
179
176
</div>
180
177
<hr>
181
 
<div class="refsect2" lang="en">
 
178
<div class="refsect2" title="gimp_cairo_set_focus_line_pattern ()">
182
179
<a name="gimp-cairo-set-focus-line-pattern"></a><h3>gimp_cairo_set_focus_line_pattern ()</h3>
183
180
<pre class="programlisting"><a
184
181
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
185
182
>gboolean</a>            gimp_cairo_set_focus_line_pattern   (<a
186
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
183
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
187
184
>cairo_t</a> *cr,
188
185
                                                         <a
189
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
186
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
190
187
>GtkWidget</a> *widget);</pre>
191
188
<p>
192
189
Sets color and dash pattern for stroking a focus line on the given
193
190
<em class="parameter"><code>cr</code></em>. The line pattern is taken from <em class="parameter"><code>widget</code></em>.</p>
194
191
<p>
195
 
 
196
192
</p>
197
193
<div class="variablelist"><table border="0">
198
194
<col align="left" valign="top">
210
206
<tr>
211
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
212
208
<td> <a
213
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
209
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
214
210
><code class="literal">TRUE</code></a> if the widget style has a focus line pattern,
215
211
              <a
216
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
212
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
217
213
><code class="literal">FALSE</code></a> otherwise
218
214
 
219
215
</td>
220
216
</tr>
221
217
</tbody>
222
218
</table></div>
223
 
<p class="since">Since  GIMP 2.6
224
 
</p>
 
219
<p class="since">Since GIMP 2.6</p>
225
220
</div>
226
221
<hr>
227
 
<div class="refsect2" lang="en">
 
222
<div class="refsect2" title="gimp_cairo_checkerboard_create ()">
228
223
<a name="gimp-cairo-checkerboard-create"></a><h3>gimp_cairo_checkerboard_create ()</h3>
229
224
<pre class="programlisting"><a
230
 
href="/usr/share/gtk-doc/html/cairo/cairo-Patterns.html#cairo-pattern-t"
231
 
>cairo_pattern_t</a>*    gimp_cairo_checkerboard_create      (<a
232
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"
 
225
href="/usr/share/gtk-doc/html/cairo/cairo-pattern.html#cairo-pattern-t"
 
226
>cairo_pattern_t</a> *   gimp_cairo_checkerboard_create      (<a
 
227
href="/usr/share/gtk-doc/html/cairo/cairo-context.html#cairo-t"
233
228
>cairo_t</a> *cr,
234
229
                                                         <a
235
230
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
243
238
<p>
244
239
Create a repeating checkerboard pattern.</p>
245
240
<p>
246
 
 
247
241
</p>
248
242
<div class="variablelist"><table border="0">
249
243
<col align="left" valign="top">
261
255
<tr>
262
256
<td><p><span class="term"><em class="parameter"><code>light</code></em> :</span></p></td>
263
257
<td> light check color or <a
264
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
 
258
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
265
259
><code class="literal">NULL</code></a> to use the default light gray
266
260
</td>
267
261
</tr>
268
262
<tr>
269
263
<td><p><span class="term"><em class="parameter"><code>dark</code></em> :</span></p></td>
270
264
<td>  dark check color or <a
271
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
 
265
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
272
266
><code class="literal">NULL</code></a> to use the default dark gray
273
267
</td>
274
268
</tr>
280
274
</tr>
281
275
</tbody>
282
276
</table></div>
283
 
<p class="since">Since  GIMP 2.6
284
 
</p>
 
277
<p class="since">Since GIMP 2.6</p>
285
278
</div>
286
279
<hr>
287
 
<div class="refsect2" lang="en">
 
280
<div class="refsect2" title="gimp_cairo_surface_create_from_pixbuf ()">
288
281
<a name="gimp-cairo-surface-create-from-pixbuf"></a><h3>gimp_cairo_surface_create_from_pixbuf ()</h3>
289
282
<pre class="programlisting"><a
290
 
href="/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"
291
 
>cairo_surface_t</a>*    gimp_cairo_surface_create_from_pixbuf
 
283
href="/usr/share/gtk-doc/html/cairo/cairo-surface.html#cairo-surface-t"
 
284
>cairo_surface_t</a> *   gimp_cairo_surface_create_from_pixbuf
292
285
                                                        (<a
293
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
286
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
294
287
>GdkPixbuf</a> *pixbuf);</pre>
295
288
<p>
296
289
Create a Cairo image surface from a GdkPixbuf.
299
292
You should avoid calling this function as there are probably more
300
293
efficient ways of achieving the result you are looking for.</p>
301
294
<p>
302
 
 
303
295
</p>
304
296
<div class="variablelist"><table border="0">
305
297
<col align="left" valign="top">
312
304
<tr>
313
305
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
314
306
<td>
315
 
 
316
 
 
317
307
</td>
318
308
</tr>
319
309
</tbody>
320
310
</table></div>
321
 
<p class="since">Since  GIMP 2.6
322
 
</p>
 
311
<p class="since">Since GIMP 2.6</p>
323
312
</div>
324
313
<hr>
325
 
<div class="refsect2" lang="en">
326
 
<a name="GIMP-CAIRO-RGB24-SET-PIXEL:CAPS"></a><h3>GIMP_CAIRO_RGB24_SET_PIXEL()</h3>
 
314
<div class="refsect2" title="GIMP_CAIRO_RGB24_SET_PIXEL()">
 
315
<a name="GIMP-CAIRO-RGB24-SET-PIXEL--CAPS"></a><h3>GIMP_CAIRO_RGB24_SET_PIXEL()</h3>
327
316
<pre class="programlisting">#define             GIMP_CAIRO_RGB24_SET_PIXEL(d, r, g, b)</pre>
328
317
<p>
329
 
Sets a single pixel in an Cairo image surface in <a
330
 
href="/usr/share/gtk-doc/html/cairo/cairo-Image-Surfaces.html#CAIRO-FORMAT-RGB24:CAPS"
331
 
><code class="literal">CAIRO_FORMAT_RGB24</code></a>.</p>
 
318
Sets a single pixel in an Cairo image surface in <code class="literal">CAIRO_FORMAT_RGB24</code>.</p>
332
319
<p>
333
 
 
334
320
</p>
335
321
<div class="variablelist"><table border="0">
336
322
<col align="left" valign="top">
357
343
</tr>
358
344
</tbody>
359
345
</table></div>
360
 
<p class="since">Since  GIMP 2.6
361
 
</p>
 
346
<p class="since">Since GIMP 2.6</p>
362
347
</div>
363
348
<hr>
364
 
<div class="refsect2" lang="en">
365
 
<a name="GIMP-CAIRO-ARGB32-SET-PIXEL:CAPS"></a><h3>GIMP_CAIRO_ARGB32_SET_PIXEL()</h3>
 
349
<div class="refsect2" title="GIMP_CAIRO_ARGB32_SET_PIXEL()">
 
350
<a name="GIMP-CAIRO-ARGB32-SET-PIXEL--CAPS"></a><h3>GIMP_CAIRO_ARGB32_SET_PIXEL()</h3>
366
351
<pre class="programlisting">#define             GIMP_CAIRO_ARGB32_SET_PIXEL(d, r, g, b, a)</pre>
367
352
<p>
368
 
Sets a single pixel in an Cairo image surface in <a
369
 
href="/usr/share/gtk-doc/html/cairo/cairo-Image-Surfaces.html#CAIRO-FORMAT-ARGB32:CAPS"
370
 
><code class="literal">CAIRO_FORMAT_ARGB32</code></a>.</p>
 
353
Sets a single pixel in an Cairo image surface in <code class="literal">CAIRO_FORMAT_ARGB32</code>.</p>
371
354
<p>
372
 
 
373
355
</p>
374
356
<div class="variablelist"><table border="0">
375
357
<col align="left" valign="top">
401
383
</tr>
402
384
</tbody>
403
385
</table></div>
404
 
<p class="since">Since  GIMP 2.6
405
 
</p>
 
386
<p class="since">Since GIMP 2.6</p>
406
387
</div>
407
388
</div>
408
389
</div>
409
390
<div class="footer">
410
391
<hr>
411
 
          Generated by GTK-Doc V1.10</div>
 
392
          Generated by GTK-Doc V1.11</div>
412
393
</body>
413
394
</html>