]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-xlib-rgb.sgml
contrib subdir
[~andy/gtk] / docs / reference / gdk-pixbuf / tmpl / gdk-pixbuf-xlib-rgb.sgml
1 <!-- ##### SECTION Title ##### -->
2 XlibRGB
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Functions for rendering RGB buffers to X drawables.
6
7 <!-- ##### SECTION Long_Description ##### -->
8   <para>
9     The XlibRGB set of functions is a port of the GdkRGB library to
10     use plain Xlib and X drawables.  You can use these functions to
11     render RGB buffers into drawables very quickly with high-quality
12     dithering.
13   </para>
14
15 <!-- ##### SECTION See_Also ##### -->
16   <para>
17     GdkRGB
18   </para>
19
20 <!-- ##### STRUCT XlibRgbCmap ##### -->
21   <para>
22     FIXME: Describe this.
23   </para>
24
25 @colors: FIXME.
26 @lut: FIXME.
27
28 <!-- ##### ENUM XlibRgbDither ##### -->
29   <para>
30     These values are used to specify which dithering method should be
31     used.  <symbol>XLIB_RGB_DITHER_NONE</symbol> will use no dithering
32     and simply map the colors in an RGB buffer to the closest colors
33     that the display can provide.
34     <symbol>XLIB_RGB_DITHER_NORMAL</symbol> will provide dithering
35     only on pseudocolor displays.
36     <symbol>XLIB_RGB_DITHER_MAX</symbol> will provide dithering on
37     pseudocolor and 16-bit truecolor or &ldquo;high color&rdquo;
38     displays.
39   </para>
40
41 @XLIB_RGB_DITHER_NONE: Specifies no dithering.
42 @XLIB_RGB_DITHER_NORMAL: Specifies dithering only on pseudocolor
43 displays.
44 @XLIB_RGB_DITHER_MAX: Specifies dithering on high color displays.
45
46 <!-- ##### FUNCTION xlib_rgb_init ##### -->
47 <para>
48
49 </para>
50
51 @display: 
52 @screen: 
53
54
55 <!-- ##### FUNCTION xlib_rgb_init_with_depth ##### -->
56 <para>
57
58 </para>
59
60 @display: 
61 @screen: 
62 @prefDepth: 
63
64
65 <!-- ##### FUNCTION xlib_rgb_gc_set_foreground ##### -->
66 <para>
67
68 </para>
69
70 @gc: 
71 @rgb: 
72
73
74 <!-- ##### FUNCTION xlib_rgb_gc_set_background ##### -->
75 <para>
76
77 </para>
78
79 @gc: 
80 @rgb: 
81
82
83 <!-- ##### FUNCTION xlib_draw_rgb_image ##### -->
84 <para>
85
86 </para>
87
88 @drawable: 
89 @gc: 
90 @x: 
91 @y: 
92 @width: 
93 @height: 
94 @dith: 
95 @rgb_buf: 
96 @rowstride: 
97
98
99 <!-- ##### FUNCTION xlib_draw_rgb_image_dithalign ##### -->
100 <para>
101
102 </para>
103
104 @drawable: 
105 @gc: 
106 @x: 
107 @y: 
108 @width: 
109 @height: 
110 @dith: 
111 @rgb_buf: 
112 @rowstride: 
113 @xdith: 
114 @ydith: 
115
116
117 <!-- ##### FUNCTION xlib_draw_rgb_32_image ##### -->
118 <para>
119
120 </para>
121
122 @drawable: 
123 @gc: 
124 @x: 
125 @y: 
126 @width: 
127 @height: 
128 @dith: 
129 @buf: 
130 @rowstride: 
131
132
133 <!-- ##### FUNCTION xlib_draw_gray_image ##### -->
134 <para>
135
136 </para>
137
138 @drawable: 
139 @gc: 
140 @x: 
141 @y: 
142 @width: 
143 @height: 
144 @dith: 
145 @buf: 
146 @rowstride: 
147
148
149 <!-- ##### FUNCTION xlib_rgb_cmap_new ##### -->
150 <para>
151
152 </para>
153
154 @colors: 
155 @n_colors: 
156 @Returns: 
157
158
159 <!-- ##### FUNCTION xlib_rgb_cmap_free ##### -->
160 <para>
161
162 </para>
163
164 @cmap: 
165
166
167 <!-- ##### FUNCTION xlib_draw_indexed_image ##### -->
168 <para>
169
170 </para>
171
172 @drawable: 
173 @gc: 
174 @x: 
175 @y: 
176 @width: 
177 @height: 
178 @dith: 
179 @buf: 
180 @rowstride: 
181 @cmap: 
182
183
184 <!-- ##### FUNCTION xlib_rgb_ditherable ##### -->
185 <para>
186
187 </para>
188
189 @Returns: 
190
191
192 <!-- ##### FUNCTION xlib_rgb_set_verbose ##### -->
193 <para>
194
195 </para>
196
197 @verbose: 
198
199
200 <!-- ##### FUNCTION xlib_rgb_set_install ##### -->
201 <para>
202
203 </para>
204
205 @install: 
206
207
208 <!-- ##### FUNCTION xlib_rgb_set_min_colors ##### -->
209 <para>
210
211 </para>
212
213 @min_colors: 
214
215
216 <!-- ##### FUNCTION xlib_rgb_get_cmap ##### -->
217 <para>
218
219 </para>
220
221 @Returns: 
222
223
224 <!-- ##### FUNCTION xlib_rgb_get_visual ##### -->
225 <para>
226
227 </para>
228
229 @Returns: 
230
231
232 <!-- ##### FUNCTION xlib_rgb_get_visual_info ##### -->
233 <para>
234
235 </para>
236
237 @Returns: 
238
239
240 <!-- ##### FUNCTION xlib_rgb_get_depth ##### -->
241 <para>
242
243 </para>
244
245 @Returns: 
246
247
248 <!-- ##### FUNCTION xlib_rgb_get_display ##### -->
249 <para>
250
251 </para>
252
253 @Returns: 
254
255
256 <!-- ##### FUNCTION xlib_rgb_get_screen ##### -->
257 <para>
258
259 </para>
260
261 @Returns: <!--
262 Local variables:
263 mode: sgml
264 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
265 End:
266 -->
267
268