Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-xlib-rgb.sgml

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