← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gdk-pixbuf/maverick

« back to all changes in this revision

Viewing changes to doc/html/gdk-pixbuf-util.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-07-23 11:26:25 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100723112625-owhl395g8ifk2wtn
Tags: 2.21.6-2ubuntu1
* Rebase on Debian
* debian/control, debian/gir1.0-gdkpixbuf-2.0.install, debian/rules:
  - build a gir1.0-gdkpixbuf-2.0 gir binary

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/gdk-pixbuf-util.html
1
 
<HTML
2
 
><HEAD
3
 
><TITLE
4
 
>Utilities</TITLE
5
 
><META
6
 
NAME="GENERATOR"
7
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
 
"><LINK
9
 
REL="HOME"
10
 
TITLE="The gdk-pixbuf Library"
11
 
HREF="index.html"><LINK
12
 
REL="UP"
13
 
TITLE="API Reference"
14
 
HREF="r27.html"><LINK
15
 
REL="PREVIOUS"
16
 
TITLE="Drawables to Pixbufs"
17
 
HREF="gdk-pixbuf-from-drawables.html"><LINK
18
 
REL="NEXT"
19
 
TITLE="Animations"
20
 
HREF="gdk-pixbuf-animation.html"></HEAD
21
 
><BODY
22
 
CLASS="REFENTRY"
23
 
BGCOLOR="#FFFFFF"
24
 
TEXT="#000000"
25
 
LINK="#0000FF"
26
 
VLINK="#840084"
27
 
ALINK="#0000FF"
28
 
><DIV
29
 
CLASS="NAVHEADER"
30
 
><TABLE
31
 
WIDTH="100%"
32
 
BORDER="0"
33
 
BGCOLOR="#000000"
34
 
CELLPADDING="1"
35
 
CELLSPACING="0"
36
 
><TR
37
 
><TH
38
 
COLSPAN="4"
39
 
ALIGN="center"
40
 
><FONT
41
 
COLOR="#FFFFFF"
42
 
SIZE="5"
43
 
>The <SPAN
44
 
CLASS="APPLICATION"
45
 
>gdk-pixbuf</SPAN
46
 
> Library</FONT
47
 
></TH
48
 
></TR
49
 
><TR
50
 
><TD
51
 
WIDTH="25%"
52
 
BGCOLOR="#C00000"
53
 
ALIGN="left"
54
 
><A
55
 
HREF="gdk-pixbuf-from-drawables.html"
56
 
><FONT
57
 
COLOR="#FFFFFF"
58
 
SIZE="3"
59
 
><B
60
 
>&#60;&#60;&#60; Previous Page</B
61
 
></FONT
62
 
></A
63
 
></TD
64
 
><TD
65
 
WIDTH="25%"
66
 
BGCOLOR="#0000C0"
67
 
ALIGN="center"
68
 
><FONT
69
 
COLOR="#FFFFFF"
70
 
SIZE="3"
71
 
><B
72
 
><A
73
 
HREF="index.html"
74
 
><FONT
75
 
COLOR="#FFFFFF"
76
 
SIZE="3"
77
 
><B
78
 
>Home</B
79
 
></FONT
80
 
></A
81
 
></B
82
 
></FONT
83
 
></TD
84
 
><TD
85
 
WIDTH="25%"
86
 
BGCOLOR="#00C000"
87
 
ALIGN="center"
88
 
><FONT
89
 
COLOR="#FFFFFF"
90
 
SIZE="3"
91
 
><B
92
 
><A
93
 
HREF="r27.html"
94
 
><FONT
95
 
COLOR="#FFFFFF"
96
 
SIZE="3"
97
 
><B
98
 
>Up</B
99
 
></FONT
100
 
></A
101
 
></B
102
 
></FONT
103
 
></TD
104
 
><TD
105
 
WIDTH="25%"
106
 
BGCOLOR="#C00000"
107
 
ALIGN="right"
108
 
><A
109
 
HREF="gdk-pixbuf-animation.html"
110
 
><FONT
111
 
COLOR="#FFFFFF"
112
 
SIZE="3"
113
 
><B
114
 
>Next Page &#62;&#62;&#62;</B
115
 
></FONT
116
 
></A
117
 
></TD
118
 
></TR
119
 
></TABLE
120
 
></DIV
121
 
><H1
122
 
><A
123
 
NAME="GDK-PIXBUF-UTIL">Utilities</H1
124
 
><DIV
125
 
CLASS="REFNAMEDIV"
126
 
><A
127
 
NAME="AEN1539"
128
 
></A
129
 
><H2
130
 
>Name</H2
131
 
>Utilities&nbsp;--&nbsp;Utility and miscellaneous convenience functions.</DIV
132
 
><DIV
133
 
CLASS="REFSYNOPSISDIV"
134
 
><A
135
 
NAME="AEN1542"><H2
136
 
>Synopsis</H2
137
 
><TABLE
138
 
BORDER="0"
139
 
BGCOLOR="#D6E8FF"
140
 
WIDTH="100%"
141
 
CELLPADDING="6"
142
 
><TR
143
 
><TD
144
 
><PRE
145
 
CLASS="SYNOPSIS"
146
 
>&#13;#include &lt;gdk-pixbuf/gdk-pixbuf.h&gt;
147
 
 
148
 
 
149
 
GdkPixbuf*  <A
150
 
HREF="gdk-pixbuf-util.html#GDK-PIXBUF-ADD-ALPHA"
151
 
>gdk_pixbuf_add_alpha</A
152
 
>            (const GdkPixbuf *pixbuf,
153
 
                                             gboolean substitute_color,
154
 
                                             guchar r,
155
 
                                             guchar g,
156
 
                                             guchar b);
157
 
void        <A
158
 
HREF="gdk-pixbuf-util.html#GDK-PIXBUF-COPY-AREA"
159
 
>gdk_pixbuf_copy_area</A
160
 
>            (const GdkPixbuf *src_pixbuf,
161
 
                                             int src_x,
162
 
                                             int src_y,
163
 
                                             int width,
164
 
                                             int height,
165
 
                                             GdkPixbuf *dest_pixbuf,
166
 
                                             int dest_x,
167
 
                                             int dest_y);</PRE
168
 
></TD
169
 
></TR
170
 
></TABLE
171
 
></DIV
172
 
><DIV
173
 
CLASS="REFSECT1"
174
 
><A
175
 
NAME="AEN1555"
176
 
></A
177
 
><H2
178
 
>Description</H2
179
 
><P
180
 
>    These functions provide miscellaneous utilities for manipulating
181
 
    pixbufs.  The pixel data in pixbufs may of course be manipulated
182
 
    directly by applications, but several common operations can be
183
 
    performed by these functions instead.
184
 
  </P
185
 
></DIV
186
 
><DIV
187
 
CLASS="REFSECT1"
188
 
><A
189
 
NAME="AEN1558"
190
 
></A
191
 
><H2
192
 
>Details</H2
193
 
><DIV
194
 
CLASS="REFSECT2"
195
 
><A
196
 
NAME="AEN1560"
197
 
></A
198
 
><H3
199
 
><A
200
 
NAME="GDK-PIXBUF-ADD-ALPHA"
201
 
></A
202
 
>gdk_pixbuf_add_alpha ()</H3
203
 
><TABLE
204
 
BORDER="0"
205
 
BGCOLOR="#D6E8FF"
206
 
WIDTH="100%"
207
 
CELLPADDING="6"
208
 
><TR
209
 
><TD
210
 
><PRE
211
 
CLASS="PROGRAMLISTING"
212
 
>GdkPixbuf*  gdk_pixbuf_add_alpha            (const GdkPixbuf *pixbuf,
213
 
                                             gboolean substitute_color,
214
 
                                             guchar r,
215
 
                                             guchar g,
216
 
                                             guchar b);</PRE
217
 
></TD
218
 
></TR
219
 
></TABLE
220
 
><P
221
 
>Takes an existing pixbuf and adds an alpha channel to it.  If the original
222
 
pixbuf already had alpha information, then the contents of the new pixbuf are
223
 
exactly the same as the original's.  Otherwise, the new pixbuf will have all
224
 
pixels with full opacity if <TT
225
 
CLASS="PARAMETER"
226
 
><I
227
 
>substitute_color</I
228
 
></TT
229
 
> is FALSE.  If
230
 
<TT
231
 
CLASS="PARAMETER"
232
 
><I
233
 
>substitute_color</I
234
 
></TT
235
 
> is TRUE, then the color specified by (<TT
236
 
CLASS="PARAMETER"
237
 
><I
238
 
>r</I
239
 
></TT
240
 
>, <TT
241
 
CLASS="PARAMETER"
242
 
><I
243
 
>g</I
244
 
></TT
245
 
>, <TT
246
 
CLASS="PARAMETER"
247
 
><I
248
 
>b</I
249
 
></TT
250
 
>) will be
251
 
substituted for zero opacity.</P
252
 
><P
253
 
></P
254
 
><DIV
255
 
CLASS="INFORMALTABLE"
256
 
><A
257
 
NAME="AEN1579"><P
258
 
></P
259
 
><TABLE
260
 
BORDER="0"
261
 
WIDTH="100%"
262
 
BGCOLOR="#FFD0D0"
263
 
CELLSPACING="0"
264
 
CELLPADDING="4"
265
 
CLASS="CALSTABLE"
266
 
><TBODY
267
 
><TR
268
 
><TD
269
 
WIDTH="20%"
270
 
ALIGN="RIGHT"
271
 
VALIGN="TOP"
272
 
><TT
273
 
CLASS="PARAMETER"
274
 
><I
275
 
>pixbuf</I
276
 
></TT
277
 
>&nbsp;:</TD
278
 
><TD
279
 
WIDTH="80%"
280
 
ALIGN="LEFT"
281
 
VALIGN="TOP"
282
 
> A pixbuf.</TD
283
 
></TR
284
 
><TR
285
 
><TD
286
 
WIDTH="20%"
287
 
ALIGN="RIGHT"
288
 
VALIGN="TOP"
289
 
><TT
290
 
CLASS="PARAMETER"
291
 
><I
292
 
>substitute_color</I
293
 
></TT
294
 
>&nbsp;:</TD
295
 
><TD
296
 
WIDTH="80%"
297
 
ALIGN="LEFT"
298
 
VALIGN="TOP"
299
 
> Whether to substitute a color for zero opacity.  If this
300
 
is FALSE, then the (<TT
301
 
CLASS="PARAMETER"
302
 
><I
303
 
>r</I
304
 
></TT
305
 
>, <TT
306
 
CLASS="PARAMETER"
307
 
><I
308
 
>g</I
309
 
></TT
310
 
>, <TT
311
 
CLASS="PARAMETER"
312
 
><I
313
 
>b</I
314
 
></TT
315
 
>) arguments will be ignored.</TD
316
 
></TR
317
 
><TR
318
 
><TD
319
 
WIDTH="20%"
320
 
ALIGN="RIGHT"
321
 
VALIGN="TOP"
322
 
><TT
323
 
CLASS="PARAMETER"
324
 
><I
325
 
>r</I
326
 
></TT
327
 
>&nbsp;:</TD
328
 
><TD
329
 
WIDTH="80%"
330
 
ALIGN="LEFT"
331
 
VALIGN="TOP"
332
 
> Red value to substitute.</TD
333
 
></TR
334
 
><TR
335
 
><TD
336
 
WIDTH="20%"
337
 
ALIGN="RIGHT"
338
 
VALIGN="TOP"
339
 
><TT
340
 
CLASS="PARAMETER"
341
 
><I
342
 
>g</I
343
 
></TT
344
 
>&nbsp;:</TD
345
 
><TD
346
 
WIDTH="80%"
347
 
ALIGN="LEFT"
348
 
VALIGN="TOP"
349
 
> Green value to substitute.</TD
350
 
></TR
351
 
><TR
352
 
><TD
353
 
WIDTH="20%"
354
 
ALIGN="RIGHT"
355
 
VALIGN="TOP"
356
 
><TT
357
 
CLASS="PARAMETER"
358
 
><I
359
 
>b</I
360
 
></TT
361
 
>&nbsp;:</TD
362
 
><TD
363
 
WIDTH="80%"
364
 
ALIGN="LEFT"
365
 
VALIGN="TOP"
366
 
> Blue value to substitute.</TD
367
 
></TR
368
 
><TR
369
 
><TD
370
 
WIDTH="20%"
371
 
ALIGN="RIGHT"
372
 
VALIGN="TOP"
373
 
><SPAN
374
 
CLASS="emphasis"
375
 
><I
376
 
CLASS="EMPHASIS"
377
 
>Returns</I
378
 
></SPAN
379
 
> :</TD
380
 
><TD
381
 
WIDTH="80%"
382
 
ALIGN="LEFT"
383
 
VALIGN="TOP"
384
 
> A newly-created pixbuf with a reference count of 1.</TD
385
 
></TR
386
 
></TBODY
387
 
></TABLE
388
 
><P
389
 
></P
390
 
></DIV
391
 
></DIV
392
 
><HR><DIV
393
 
CLASS="REFSECT2"
394
 
><A
395
 
NAME="AEN1612"
396
 
></A
397
 
><H3
398
 
><A
399
 
NAME="GDK-PIXBUF-COPY-AREA"
400
 
></A
401
 
>gdk_pixbuf_copy_area ()</H3
402
 
><TABLE
403
 
BORDER="0"
404
 
BGCOLOR="#D6E8FF"
405
 
WIDTH="100%"
406
 
CELLPADDING="6"
407
 
><TR
408
 
><TD
409
 
><PRE
410
 
CLASS="PROGRAMLISTING"
411
 
>void        gdk_pixbuf_copy_area            (const GdkPixbuf *src_pixbuf,
412
 
                                             int src_x,
413
 
                                             int src_y,
414
 
                                             int width,
415
 
                                             int height,
416
 
                                             GdkPixbuf *dest_pixbuf,
417
 
                                             int dest_x,
418
 
                                             int dest_y);</PRE
419
 
></TD
420
 
></TR
421
 
></TABLE
422
 
><P
423
 
>Copies a rectangular area from <TT
424
 
CLASS="PARAMETER"
425
 
><I
426
 
>src_pixbuf</I
427
 
></TT
428
 
> to <TT
429
 
CLASS="PARAMETER"
430
 
><I
431
 
>dest_pixbuf</I
432
 
></TT
433
 
>.  Conversion of
434
 
pixbuf formats is done automatically.</P
435
 
><P
436
 
></P
437
 
><DIV
438
 
CLASS="INFORMALTABLE"
439
 
><A
440
 
NAME="AEN1622"><P
441
 
></P
442
 
><TABLE
443
 
BORDER="0"
444
 
WIDTH="100%"
445
 
BGCOLOR="#FFD0D0"
446
 
CELLSPACING="0"
447
 
CELLPADDING="4"
448
 
CLASS="CALSTABLE"
449
 
><TBODY
450
 
><TR
451
 
><TD
452
 
WIDTH="20%"
453
 
ALIGN="RIGHT"
454
 
VALIGN="TOP"
455
 
><TT
456
 
CLASS="PARAMETER"
457
 
><I
458
 
>src_pixbuf</I
459
 
></TT
460
 
>&nbsp;:</TD
461
 
><TD
462
 
WIDTH="80%"
463
 
ALIGN="LEFT"
464
 
VALIGN="TOP"
465
 
> Source pixbuf.</TD
466
 
></TR
467
 
><TR
468
 
><TD
469
 
WIDTH="20%"
470
 
ALIGN="RIGHT"
471
 
VALIGN="TOP"
472
 
><TT
473
 
CLASS="PARAMETER"
474
 
><I
475
 
>src_x</I
476
 
></TT
477
 
>&nbsp;:</TD
478
 
><TD
479
 
WIDTH="80%"
480
 
ALIGN="LEFT"
481
 
VALIGN="TOP"
482
 
> Source X coordinate within <TT
483
 
CLASS="PARAMETER"
484
 
><I
485
 
>src_pixbuf</I
486
 
></TT
487
 
>.</TD
488
 
></TR
489
 
><TR
490
 
><TD
491
 
WIDTH="20%"
492
 
ALIGN="RIGHT"
493
 
VALIGN="TOP"
494
 
><TT
495
 
CLASS="PARAMETER"
496
 
><I
497
 
>src_y</I
498
 
></TT
499
 
>&nbsp;:</TD
500
 
><TD
501
 
WIDTH="80%"
502
 
ALIGN="LEFT"
503
 
VALIGN="TOP"
504
 
> Source Y coordinate within <TT
505
 
CLASS="PARAMETER"
506
 
><I
507
 
>src_pixbuf</I
508
 
></TT
509
 
>.</TD
510
 
></TR
511
 
><TR
512
 
><TD
513
 
WIDTH="20%"
514
 
ALIGN="RIGHT"
515
 
VALIGN="TOP"
516
 
><TT
517
 
CLASS="PARAMETER"
518
 
><I
519
 
>width</I
520
 
></TT
521
 
>&nbsp;:</TD
522
 
><TD
523
 
WIDTH="80%"
524
 
ALIGN="LEFT"
525
 
VALIGN="TOP"
526
 
> Width of the area to copy.</TD
527
 
></TR
528
 
><TR
529
 
><TD
530
 
WIDTH="20%"
531
 
ALIGN="RIGHT"
532
 
VALIGN="TOP"
533
 
><TT
534
 
CLASS="PARAMETER"
535
 
><I
536
 
>height</I
537
 
></TT
538
 
>&nbsp;:</TD
539
 
><TD
540
 
WIDTH="80%"
541
 
ALIGN="LEFT"
542
 
VALIGN="TOP"
543
 
> Height of the area to copy.</TD
544
 
></TR
545
 
><TR
546
 
><TD
547
 
WIDTH="20%"
548
 
ALIGN="RIGHT"
549
 
VALIGN="TOP"
550
 
><TT
551
 
CLASS="PARAMETER"
552
 
><I
553
 
>dest_pixbuf</I
554
 
></TT
555
 
>&nbsp;:</TD
556
 
><TD
557
 
WIDTH="80%"
558
 
ALIGN="LEFT"
559
 
VALIGN="TOP"
560
 
> Destination pixbuf.</TD
561
 
></TR
562
 
><TR
563
 
><TD
564
 
WIDTH="20%"
565
 
ALIGN="RIGHT"
566
 
VALIGN="TOP"
567
 
><TT
568
 
CLASS="PARAMETER"
569
 
><I
570
 
>dest_x</I
571
 
></TT
572
 
>&nbsp;:</TD
573
 
><TD
574
 
WIDTH="80%"
575
 
ALIGN="LEFT"
576
 
VALIGN="TOP"
577
 
> X coordinate within <TT
578
 
CLASS="PARAMETER"
579
 
><I
580
 
>dest_pixbuf</I
581
 
></TT
582
 
>.</TD
583
 
></TR
584
 
><TR
585
 
><TD
586
 
WIDTH="20%"
587
 
ALIGN="RIGHT"
588
 
VALIGN="TOP"
589
 
><TT
590
 
CLASS="PARAMETER"
591
 
><I
592
 
>dest_y</I
593
 
></TT
594
 
>&nbsp;:</TD
595
 
><TD
596
 
WIDTH="80%"
597
 
ALIGN="LEFT"
598
 
VALIGN="TOP"
599
 
> Y coordinate within <TT
600
 
CLASS="PARAMETER"
601
 
><I
602
 
>dest_pixbuf</I
603
 
></TT
604
 
>.</TD
605
 
></TR
606
 
></TBODY
607
 
></TABLE
608
 
><P
609
 
></P
610
 
></DIV
611
 
></DIV
612
 
></DIV
613
 
><DIV
614
 
CLASS="REFSECT1"
615
 
><A
616
 
NAME="AEN1663"
617
 
></A
618
 
><H2
619
 
>See Also</H2
620
 
><P
621
 
>    GdkPixbuf
622
 
  </P
623
 
></DIV
624
 
><DIV
625
 
CLASS="NAVFOOTER"
626
 
><BR
627
 
CLEAR="all"><BR><TABLE
628
 
WIDTH="100%"
629
 
BORDER="0"
630
 
BGCOLOR="#000000"
631
 
CELLPADDING="1"
632
 
CELLSPACING="0"
633
 
><TR
634
 
><TD
635
 
WIDTH="25%"
636
 
BGCOLOR="#C00000"
637
 
ALIGN="left"
638
 
><A
639
 
HREF="gdk-pixbuf-from-drawables.html"
640
 
><FONT
641
 
COLOR="#FFFFFF"
642
 
SIZE="3"
643
 
><B
644
 
>&#60;&#60;&#60; Previous Page</B
645
 
></FONT
646
 
></A
647
 
></TD
648
 
><TD
649
 
WIDTH="25%"
650
 
BGCOLOR="#0000C0"
651
 
ALIGN="center"
652
 
><FONT
653
 
COLOR="#FFFFFF"
654
 
SIZE="3"
655
 
><B
656
 
><A
657
 
HREF="index.html"
658
 
><FONT
659
 
COLOR="#FFFFFF"
660
 
SIZE="3"
661
 
><B
662
 
>Home</B
663
 
></FONT
664
 
></A
665
 
></B
666
 
></FONT
667
 
></TD
668
 
><TD
669
 
WIDTH="25%"
670
 
BGCOLOR="#00C000"
671
 
ALIGN="center"
672
 
><FONT
673
 
COLOR="#FFFFFF"
674
 
SIZE="3"
675
 
><B
676
 
><A
677
 
HREF="r27.html"
678
 
><FONT
679
 
COLOR="#FFFFFF"
680
 
SIZE="3"
681
 
><B
682
 
>Up</B
683
 
></FONT
684
 
></A
685
 
></B
686
 
></FONT
687
 
></TD
688
 
><TD
689
 
WIDTH="25%"
690
 
BGCOLOR="#C00000"
691
 
ALIGN="right"
692
 
><A
693
 
HREF="gdk-pixbuf-animation.html"
694
 
><FONT
695
 
COLOR="#FFFFFF"
696
 
SIZE="3"
697
 
><B
698
 
>Next Page &#62;&#62;&#62;</B
699
 
></FONT
700
 
></A
701
 
></TD
702
 
></TR
703
 
><TR
704
 
><TD
705
 
COLSPAN="2"
706
 
ALIGN="left"
707
 
><FONT
708
 
COLOR="#FFFFFF"
709
 
SIZE="3"
710
 
><B
711
 
>Drawables to Pixbufs</B
712
 
></FONT
713
 
></TD
714
 
><TD
715
 
COLSPAN="2"
716
 
ALIGN="right"
717
 
><FONT
718
 
COLOR="#FFFFFF"
719
 
SIZE="3"
720
 
><B
721
 
>Animations</B
722
 
></FONT
723
 
></TD
724
 
></TR
725
 
></TABLE
726
 
></DIV
727
 
></BODY
728
 
></HTML
729
 
>
 
 
b'\\ No newline at end of file'