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_colormap(). 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_".
  36 </para>
  37
  38 <!-- ##### SECTION See_Also ##### -->
  39 <para>
  40
  41 </para>
  42
  43 <!-- ##### SECTION Stability_Level ##### -->
  44
  45
  46 <!-- ##### SECTION Image ##### -->
  47
  48
  49 <!-- ##### STRUCT GdkColor ##### -->
  50 <para>
  51 The #GdkColor structure is used to describe an
  52 allocated or unallocated color.
  53 </para>
  54
  55 @pixel: For allocated colors, the value used to
  56   draw this color on the screen.
  57 @red: The red component of the color. This is
  58   a value between 0 and 65535, with 65535 indicating
  59   full intensitiy.
  60 @green: The green component of the color.
  61 @blue: The blue component of the color.
  62
  63 <!-- ##### STRUCT GdkColormap ##### -->
  64 <para>
  65 The colormap structure contains the following public fields.
  66 </para>
  67
  68
  69 <!-- ##### FUNCTION gdk_colormap_new ##### -->
  70 <para>
  71 </para>
  72
  73 @visual:
  74 @allocate:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION gdk_colormap_get_system ##### -->
  79 <para>
  80 </para>
  81
  82 @void:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION gdk_colormap_alloc_colors ##### -->
  87 <para>
  88 </para>
  89
  90 @colormap:
  91 @colors:
  92 @n_colors:
  93 @writeable:
  94 @best_match:
  95 @success:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION gdk_colormap_alloc_color ##### -->
 100 <para>
 101 </para>
 102
 103 @colormap:
 104 @color:
 105 @writeable:
 106 @best_match:
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION gdk_colormap_free_colors ##### -->
 111 <para>
 112 </para>
 113
 114 @colormap:
 115 @colors:
 116 @n_colors:
 117
 118
 119 <!-- ##### FUNCTION gdk_colormap_get_visual ##### -->
 120 <para>
 121 </para>
 122
 123 @colormap:
 124 @Returns:
 125
 126
 127 <!-- ##### FUNCTION gdk_colormap_get_screen ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @cmap:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION gdk_color_copy ##### -->
 137 <para>
 138 </para>
 139
 140 @color:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION gdk_color_free ##### -->
 145 <para>
 146 </para>
 147
 148 @color:
 149
 150
 151 <!-- ##### FUNCTION gdk_color_parse ##### -->
 152 <para>
 153 </para>
 154
 155 @spec:
 156 @color:
 157 @Returns:
 158
 159
 160 <!-- ##### FUNCTION gdk_color_equal ##### -->
 161 <para>
 162 </para>
 163
 164 @colora:
 165 @colorb:
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION gdk_color_hash ##### -->
 170 <para>
 171 </para>
 172
 173 @colora:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION gdk_color_to_string ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @color:
 183 @Returns:
 184
 185