]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
Documentation fixes.
[~andy/gtk] / docs / reference / gdk-pixbuf / tmpl / gdk-pixbuf-loader.sgml
1 <!-- ##### SECTION Title ##### -->
2 GdkPixbufLoader
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Application-driven progressive image loading.
6
7 <!-- ##### SECTION Long_Description ##### -->
8   <para>
9     #GdkPixbufLoader provides a way for applications to drive the
10     process of loading an image, by letting them send the image data
11     directly to the loader instead of having the loader read the data
12     from a file.  Applications can use this functionality instead of
13     gdk_pixbuf_new_from_file() or gdk_pixbuf_animation_new_from_file() 
14     when they need to parse image data in
15     small chunks.  For example, it should be used when reading an
16     image from a (potentially) slow network connection, or when
17     loading an extremely large file.
18   </para>
19
20   <para>
21     To use #GdkPixbufLoader to load an image, just create a new one,
22     and call gdk_pixbuf_loader_write() to send the data to it.  When
23     done, gdk_pixbuf_loader_close() should be called to end the stream
24     and finalize everything.  The loader will emit three important
25     signals throughout the process.  The first, "<link
26     linkend="GdkPixbufLoader-size-prepared">size_prepared</link>",
27     will be called as soon as the image has enough information to
28     determine the size of the image to be used. If you want to scale
29     the image while loading it, you can call gdk_pixbuf_loader_set_size()
30     in response to this signal.
31     </para>
32
33     <para>The second signal, "<link
34     linkend="GdkPixbufLoader-area-prepared">area_prepared</link>",
35     will be called as soon as the pixbuf of the desired has been 
36     allocated.  You can obtain it by calling gdk_pixbuf_loader_get_pixbuf(). 
37     If you want to use it, simply ref it.  
38     In addition, no actual information will be passed in yet, so the
39     pixbuf can be safely filled with any temporary graphics (or an
40     initial color) as needed.  You can also call
41     gdk_pixbuf_loader_get_pixbuf() later and get the same pixbuf.
42   </para>
43
44   <para>
45     The last signal, "<link
46     linkend="GdkPixbufLoader-area-updated">area_updated</link>" gets
47     called every time a region is updated.  This way you can update a
48     partially completed image.  Note that you do not know anything
49     about the completeness of an image from the area updated.  For
50     example, in an interlaced image, you need to make several passes
51     before the image is done loading.
52   </para>
53
54   <refsect2>
55     <title>Loading an animation</title>
56
57     <para>
58       Loading an animation is almost as easy as loading an
59       image.  Once the first "<link
60       linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal
61       has been emitted, you can call gdk_pixbuf_loader_get_animation()
62       to get the #GdkPixbufAnimation struct and gdk_pixbuf_animation_get_iter()
63       to get an #GdkPixbufAnimationIter for displaying it. 
64     </para>
65   </refsect2>
66
67 <!-- ##### SECTION See_Also ##### -->
68   <para>
69     gdk_pixbuf_new_from_file(), gdk_pixbuf_animation_new_from_file()
70   </para>
71
72 <!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->
73 <para>
74
75 </para>
76
77 @Returns: 
78
79
80 <!-- ##### FUNCTION gdk_pixbuf_loader_new_with_type ##### -->
81 <para>
82
83 </para>
84
85 @image_type: 
86 @error: 
87 @Returns: 
88
89
90 <!-- ##### FUNCTION gdk_pixbuf_loader_get_format ##### -->
91 <para>
92
93 </para>
94
95 @loader: 
96 @Returns: 
97
98
99 <!-- ##### FUNCTION gdk_pixbuf_loader_write ##### -->
100 <para>
101
102 </para>
103
104 @loader: 
105 @buf: 
106 @count: 
107 @error: 
108 @Returns: 
109
110
111 <!-- ##### FUNCTION gdk_pixbuf_loader_set_size ##### -->
112 <para>
113
114 </para>
115
116 @loader: 
117 @width: 
118 @height: 
119
120
121 <!-- ##### FUNCTION gdk_pixbuf_loader_get_pixbuf ##### -->
122 <para>
123
124 </para>
125
126 @loader: 
127 @Returns: 
128
129
130 <!-- ##### FUNCTION gdk_pixbuf_loader_get_animation ##### -->
131 <para>
132
133 </para>
134
135 @loader: 
136 @Returns: 
137
138
139 <!-- ##### FUNCTION gdk_pixbuf_loader_close ##### -->
140 <para>
141
142 </para>
143
144 @loader: 
145 @error: 
146 @Returns: 
147
148
149 <!-- ##### SIGNAL GdkPixbufLoader::area-prepared ##### -->
150   <para>
151     This signal is emitted when the pixbuf loader has allocated the pixbuf
152     in the desired size.  After this signal is emitted, applications can 
153     call gdk_pixbuf_loader_get_pixbuf() to fetch the partially-loaded pixbuf.
154   </para>
155
156 @gdkpixbufloader: the object which received the signal.
157
158 <!-- ##### SIGNAL GdkPixbufLoader::area-updated ##### -->
159   <para>
160     This signal is emitted when a significant area of the image being
161     loaded has been updated.  Normally it means that a complete
162     scanline has been read in, but it could be a different area as
163     well.  Applications can use this signal to know when to repaint
164     areas of an image that is being loaded.
165   </para>
166
167 @gdkpixbufloader: Loader which emitted the signal.
168 @arg1: 
169 @arg2: 
170 @arg3: 
171 @arg4: 
172 <!-- # Unused Parameters # -->
173 @x: X offset of upper-left corner of the updated area.
174 @y: Y offset of upper-left corner of the updated area.
175 @width: Width of updated area.
176 @height: Height of updated area.
177
178 <!-- ##### SIGNAL GdkPixbufLoader::closed ##### -->
179   <para>
180     This signal is emitted when gdk_pixbuf_loader_close() is called.
181     It can be used by different parts of an application to receive
182     notification when an image loader is closed by the code that
183     drives it.
184   </para>
185
186 @gdkpixbufloader: the object which received the signal.
187
188 <!--
189 Local variables:
190 mode: sgml
191 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
192 End:
193 -->
194
195 <!-- ##### SIGNAL GdkPixbufLoader::size-prepared ##### -->
196   <para>
197     This signal is emitted when the pixbuf loader has been fed the
198     initial amount of data that is required to figure out the size
199     of the image that it will create.  Applications can call  
200     gdk_pixbuf_loader_set_size() in response to this signal to set
201     the desired size to which the image should be scaled.
202   </para>
203
204 @gdkpixbufloader: the object which received the signal.
205 @arg1: 
206 @arg2: 
207 <!-- # Unused Parameters # -->
208 @width: the original width of the image
209 @height: the original height of the image
210