← Back to branch summary

~ubuntu-branches/ubuntu/precise/gdk-pixbuf/precise-proposed

« back to all changes in this revision

Viewing changes to doc/tmpl/rendering.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2004-10-06 22:10:04 UTC
  • Revision ID: james.westby@ubuntu.com-20041006221004-rma9deknj8qctu67
Tags: upstream-0.22.0
Import upstream version 0.22.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/tmpl/rendering.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
Rendering
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
Rendering a pixbuf to a GDK drawable.
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
  <para>
 
9
    The &gdk-pixbuf; library provides several convenience functions to
 
10
    render pixbufs to GDK drawables.  It uses the GdkRGB to render the
 
11
    image data.
 
12
  </para>
 
13
 
 
14
  <para>
 
15
    At this point there is not a standard alpha channel extension for
 
16
    the X Window System, so it is not possible to use full opacity
 
17
    information when painting images to arbitrary drawables.  The
 
18
    &gdk-pixbuf; convenience functions will threshold the opacity
 
19
    information to create a bi-level clipping mask (black and white),
 
20
    and use that to draw the image onto a drawable.
 
21
  </para>
 
22
 
 
23
  <important>
 
24
    <para>
 
25
      Since these functions use GdkRGB for rendering, you must
 
26
      initialize GdkRGB before using any of them.  You can do this by
 
27
      calling gdk_rgb_init() near the beginning of your program.
 
28
    </para>
 
29
  </important>
 
30
 
 
31
<!-- ##### SECTION See_Also ##### -->
 
32
  <para>
 
33
    GdkRGB
 
34
  </para>
 
35
 
 
36
<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
 
37
  <para>
 
38
    These values can be passed to
 
39
    gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
 
40
    chanel of an image should be handled.  This function can create a
 
41
    bilevel clipping mask (black and white) and use it while painting
 
42
    the image.  In the future, when the X Window System gets an alpha
 
43
    channel extension, it will be possible to do full alpha
 
44
    compositing onto arbitrary drawables.  For now both cases fall
 
45
    back to a bilevel clipping mask.
 
46
  </para>
 
47
 
 
48
@GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
 
49
will be created and used to draw the image.  Pixels below 0.5 opacity
 
50
will be considered fully transparent, and all others will be
 
51
considered fully opaque.
 
52
@GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
 
53
In the future it will do full alpha compositing.
 
54
 
 
55
<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable_alpha ##### -->
 
56
<para>
 
57
 
 
58
</para>
 
59
 
 
60
@pixbuf: 
 
61
@drawable: 
 
62
@src_x: 
 
63
@src_y: 
 
64
@dest_x: 
 
65
@dest_y: 
 
66
@width: 
 
67
@height: 
 
68
@alpha_mode: 
 
69
@alpha_threshold: 
 
70
@dither: 
 
71
@x_dither: 
 
72
@y_dither: 
 
73
 
 
74
 
 
75
<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### -->
 
76
<para>
 
77
 
 
78
</para>
 
79
 
 
80
@pixbuf: 
 
81
@drawable: 
 
82
@gc: 
 
83
@src_x: 
 
84
@src_y: 
 
85
@dest_x: 
 
86
@dest_y: 
 
87
@width: 
 
88
@height: 
 
89
@dither: 
 
90
@x_dither: 
 
91
@y_dither: 
 
92
 
 
93
 
 
94
<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### -->
 
95
<para>
 
96
 
 
97
</para>
 
98
 
 
99
@pixbuf: 
 
100
@bitmap: 
 
101
@src_x: 
 
102
@src_y: 
 
103
@dest_x: 
 
104
@dest_y: 
 
105
@width: 
 
106
@height: 
 
107
@alpha_threshold: 
 
108
 
 
109
 
 
110
<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### -->
 
111
<para>
 
112
 
 
113
</para>
 
114
 
 
115
@pixbuf: 
 
116
@pixmap_return: 
 
117
@mask_return: 
 
118
@alpha_threshold: <!--
 
119
Local variables:
 
120
mode: sgml
 
121
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
 
122
End:
 
123
-->
 
124
 
 
125