]> Pileus Git - ~andy/gtk/blob - gdk/gdkcolor.h
on Feb 4 10:06:49 2002 Owen Taylor <otaylor@redhat.com>
[~andy/gtk] / gdk / gdkcolor.h
1 #ifndef __GDK_COLOR_H__
2 #define __GDK_COLOR_H__
3
4 #include <gdk/gdktypes.h>
5
6 #ifdef __cplusplus
7 extern "C" {
8 #endif /* __cplusplus */
9
10 /* The color type.
11  *   A color consists of red, green and blue values in the
12  *    range 0-65535 and a pixel value. The pixel value is highly
13  *    dependent on the depth and colormap which this color will
14  *    be used to draw into. Therefore, sharing colors between
15  *    colormaps is a bad idea.
16  */
17 struct _GdkColor
18 {
19   guint32 pixel;
20   guint16 red;
21   guint16 green;
22   guint16 blue;
23 };
24
25 /* The colormap type.
26  */
27
28 typedef struct _GdkColormapClass GdkColormapClass;
29
30 #define GDK_TYPE_COLORMAP              (gdk_colormap_get_type ())
31 #define GDK_COLORMAP(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_COLORMAP, GdkColormap))
32 #define GDK_COLORMAP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_COLORMAP, GdkColormapClass))
33 #define GDK_IS_COLORMAP(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_COLORMAP))
34 #define GDK_IS_COLORMAP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_COLORMAP))
35 #define GDK_COLORMAP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_COLORMAP, GdkColormapClass))
36
37 #define GDK_TYPE_COLOR                 (gdk_color_get_type ())
38
39 struct _GdkColormap
40 {
41   GObject parent_instance;
42
43   /*< public >*/
44   gint      size;
45   GdkColor *colors;
46
47   /*< private >*/
48   GdkVisual *visual;
49   
50   gpointer windowing_data;
51 };
52
53 struct _GdkColormapClass
54 {
55   GObjectClass parent_class;
56
57 };
58
59 GType        gdk_colormap_get_type (void) G_GNUC_CONST;
60
61 GdkColormap* gdk_colormap_new     (GdkVisual   *visual,
62                                    gboolean     allocate);
63
64 #ifndef GDK_DISABLE_DEPRECATED
65 GdkColormap* gdk_colormap_ref     (GdkColormap *cmap);
66 void         gdk_colormap_unref   (GdkColormap *cmap);
67 #endif 
68
69 GdkColormap* gdk_colormap_get_system       (void);
70 #ifndef GDK_DISABLE_DEPRECATED
71 gint         gdk_colormap_get_system_size  (void);
72 void gdk_colormap_change (GdkColormap   *colormap,
73                           gint           ncolors);
74 #endif 
75
76 gint  gdk_colormap_alloc_colors   (GdkColormap *colormap,
77                                    GdkColor    *colors,
78                                    gint         ncolors,
79                                    gboolean     writeable,
80                                    gboolean     best_match,
81                                    gboolean    *success);
82 gboolean gdk_colormap_alloc_color (GdkColormap *colormap,
83                                    GdkColor    *color,
84                                    gboolean     writeable,
85                                    gboolean     best_match);
86 void     gdk_colormap_free_colors (GdkColormap *colormap,
87                                    GdkColor    *colors,
88                                    gint         ncolors);
89 void     gdk_colormap_query_color (GdkColormap *colormap,
90                                    gulong       pixel,
91                                    GdkColor    *result);
92
93 GdkVisual *gdk_colormap_get_visual (GdkColormap *colormap);
94      
95 GdkColor *gdk_color_copy  (const GdkColor *color);
96 void      gdk_color_free  (GdkColor       *color);
97 gint      gdk_color_parse (const gchar    *spec,
98                            GdkColor       *color);
99 guint     gdk_color_hash  (const GdkColor *colora);
100 gboolean  gdk_color_equal (const GdkColor *colora,
101                            const GdkColor *colorb);
102
103 GType     gdk_color_get_type (void);
104
105 /* The following functions are deprecated */
106 #ifndef GDK_DISABLE_DEPRECATED
107 void gdk_colors_store    (GdkColormap   *colormap,
108                           GdkColor      *colors,
109                           gint           ncolors);
110 gint gdk_colors_alloc    (GdkColormap   *colormap,
111                           gboolean       contiguous,
112                           gulong        *planes,
113                           gint           nplanes,
114                           gulong        *pixels,
115                           gint           npixels);
116 void gdk_colors_free     (GdkColormap   *colormap,
117                           gulong        *pixels,
118                           gint           npixels,
119                           gulong         planes);
120 gint gdk_color_white     (GdkColormap   *colormap,
121                           GdkColor      *color);
122 gint gdk_color_black     (GdkColormap   *colormap,
123                           GdkColor      *color);
124 gint gdk_color_alloc     (GdkColormap   *colormap,
125                           GdkColor      *color);
126 gint gdk_color_change    (GdkColormap   *colormap,
127                           GdkColor      *color);
128 #endif /* GDK_DISABLE_DEPRECATED */
129
130 #ifdef __cplusplus
131 }
132 #endif /* __cplusplus */
133
134 #endif /* __GDK_COLOR_H__ */