Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/colors.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Colormaps and Colors
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 manipulation of colors and colormaps.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 These functions are used to modify colormaps.
  10 A colormap is an object that contains the mapping
  11 between the color values stored in memory and
  12 the RGB values that are used to display color
  13 values. In general, colormaps only contain
  14 significant information for pseudo-color visuals,
  15 but even for other visual types, a colormap object
  16 is required in some circumstances.
  17 </para>
  18
  19 <para>
  20 There are a couple of special colormaps that can
  21 be retrieved. The system colormap (retrieved
  22 with gdk_colormap_get_system()) is the default
  23 colormap of the system. If you are using GdkRGB,
  24 there is another colormap that is important - the
  25 colormap in which GdkRGB works, retrieved with
  26 gdk_rgb_get_cmap(). However, when using GdkRGB,
  27 it is not generally necessary to allocate colors
  28 directly.
  29 </para>
  30
  31 <para>
  32 In previous revisions of this interface, a number
  33 of functions that take a #GdkColormap parameter
  34 were replaced with functions whose names began
  35 with "gdk_colormap_". This process will probably
  36 be extended somewhat in the future -
  37 gdk_color_white(), gdk_color_black(), and
  38 gdk_color_change() will probably become aliases.
  39 </para>
  40
  41 <!-- ##### SECTION See_Also ##### -->
  42 <para>
  43
  44 </para>
  45
  46 <!-- ##### STRUCT GdkColor ##### -->
  47 <para>
  48 The #GdkColor structure is used to describe an
  49 allocated or unallocated color.
  50 </para>
  51
  52 @pixel: For allocated colors, the value used to
  53   draw this color on the screen.
  54 @red: The red component of the color. This is
  55   a value between 0 and 65535, with 65535 indicating
  56   full intensitiy.
  57 @green: The blue component of the color.
  58 @blue: The green component of the color.
  59
  60 <!-- ##### STRUCT GdkColormap ##### -->
  61 <para>
  62 The colormap structure contains the following public fields.
  63 </para>
  64
  65 @parent_instance:
  66 @size: For pseudo-color colormaps, the number of colors
  67   in the colormap.
  68 @colors: An array containing the current values in the
  69   colormap. This can be used to map from pixel values
  70   back to RGB values. This is only meaningful for
  71   pseudo-color colormaps.
  72
  73 <!-- ##### FUNCTION gdk_colormap_new ##### -->
  74 <para>
  75 </para>
  76
  77 @visual:
  78 @allocate:
  79 @Returns:
  80
  81
  82 <!-- ##### FUNCTION gdk_colormap_ref ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @cmap:
  88 @Returns:
  89
  90
  91 <!-- ##### FUNCTION gdk_colormap_unref ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @cmap:
  97
  98
  99 <!-- ##### FUNCTION gdk_colormap_get_system ##### -->
 100 <para>
 101 </para>
 102
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION gdk_colormap_get_system_size ##### -->
 107 <para>
 108 </para>
 109
 110 @Returns:
 111
 112
 113 <!-- ##### FUNCTION gdk_colormap_change ##### -->
 114 <para>
 115 </para>
 116
 117 @colormap:
 118 @ncolors:
 119
 120
 121 <!-- ##### FUNCTION gdk_colormap_alloc_colors ##### -->
 122 <para>
 123 </para>
 124
 125 @colormap:
 126 @colors:
 127 @ncolors:
 128 @writeable:
 129 @best_match:
 130 @success:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION gdk_colormap_alloc_color ##### -->
 135 <para>
 136 </para>
 137
 138 @colormap:
 139 @color:
 140 @writeable:
 141 @best_match:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION gdk_colormap_free_colors ##### -->
 146 <para>
 147 </para>
 148
 149 @colormap:
 150 @colors:
 151 @ncolors:
 152
 153
 154 <!-- ##### FUNCTION gdk_colormap_query_color ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @colormap:
 160 @pixel:
 161 @result:
 162
 163
 164 <!-- ##### FUNCTION gdk_colormap_get_visual ##### -->
 165 <para>
 166 </para>
 167
 168 @colormap:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION gdk_colormap_get_screen ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @cmap:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION gdk_colors_store ##### -->
 182 <para>
 183 </para>
 184
 185 @colormap:
 186 @colors:
 187 @ncolors:
 188
 189
 190 <!-- ##### FUNCTION gdk_color_copy ##### -->
 191 <para>
 192 </para>
 193
 194 @color:
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION gdk_color_free ##### -->
 199 <para>
 200 </para>
 201
 202 @color:
 203
 204
 205 <!-- ##### FUNCTION gdk_colors_alloc ##### -->
 206 <para>
 207 </para>
 208
 209 @colormap:
 210 @contiguous:
 211 @planes:
 212 @nplanes:
 213 @pixels:
 214 @npixels:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gdk_colors_free ##### -->
 219 <para>
 220 </para>
 221
 222 @colormap:
 223 @pixels:
 224 @npixels:
 225 @planes:
 226
 227
 228 <!-- ##### FUNCTION gdk_color_white ##### -->
 229 <para>
 230 </para>
 231
 232 @colormap:
 233 @color:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION gdk_color_black ##### -->
 238 <para>
 239 </para>
 240
 241 @colormap:
 242 @color:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gdk_color_parse ##### -->
 247 <para>
 248 </para>
 249
 250 @spec:
 251 @color:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION gdk_color_alloc ##### -->
 256 <para>
 257 </para>
 258
 259 @colormap:
 260 @color:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gdk_color_change ##### -->
 265 <para>
 266 </para>
 267
 268 @colormap:
 269 @color:
 270 @Returns:
 271
 272
 273 <!-- ##### FUNCTION gdk_color_equal ##### -->
 274 <para>
 275 </para>
 276
 277 @colora:
 278 @colorb:
 279 @Returns:
 280
 281
 282 <!-- ##### FUNCTION gdk_color_hash ##### -->
 283 <para>
 284 </para>
 285
 286 @colora:
 287 @Returns:
 288
 289