]> Pileus Git - ~andy/gtk/blob - gdk/gdkcolor.h
Deprecate gdk_set/get_use_xshm, make gdk_set_use_xshm a noop. Remove
[~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 GdkColormap* gdk_colormap_ref     (GdkColormap *cmap);
64 void         gdk_colormap_unref   (GdkColormap *cmap);
65
66 GdkColormap* gdk_colormap_get_system       (void);
67 #ifndef GDK_DISABLE_DEPRECATED
68 gint         gdk_colormap_get_system_size  (void);
69 #endif
70
71 void gdk_colormap_change (GdkColormap   *colormap,
72                           gint           ncolors);
73
74
75 gint  gdk_colormap_alloc_colors   (GdkColormap *colormap,
76                                    GdkColor    *colors,
77                                    gint         ncolors,
78                                    gboolean     writeable,
79                                    gboolean     best_match,
80                                    gboolean    *success);
81 gboolean gdk_colormap_alloc_color (GdkColormap *colormap,
82                                    GdkColor    *color,
83                                    gboolean     writeable,
84                                    gboolean     best_match);
85 void     gdk_colormap_free_colors (GdkColormap *colormap,
86                                    GdkColor    *colors,
87                                    gint         ncolors);
88 void     gdk_colormap_query_color (GdkColormap *colormap,
89                                    gulong       pixel,
90                                    GdkColor    *result);
91
92 GdkVisual *gdk_colormap_get_visual (GdkColormap *colormap);
93      
94 GdkColor *gdk_color_copy  (const GdkColor *color);
95 void      gdk_color_free  (GdkColor       *color);
96 gint      gdk_color_parse (const gchar    *spec,
97                            GdkColor       *color);
98 guint     gdk_color_hash  (const GdkColor *colora);
99 gboolean  gdk_color_equal (const GdkColor *colora,
100                            const GdkColor *colorb);
101
102 GType     gdk_color_get_type (void);
103
104 /* The following functions are deprecated */
105 #ifndef GDK_DISABLE_DEPRECATED
106 void gdk_colors_store    (GdkColormap   *colormap,
107                           GdkColor      *colors,
108                           gint           ncolors);
109 gint gdk_colors_alloc    (GdkColormap   *colormap,
110                           gboolean       contiguous,
111                           gulong        *planes,
112                           gint           nplanes,
113                           gulong        *pixels,
114                           gint           npixels);
115 void gdk_colors_free     (GdkColormap   *colormap,
116                           gulong        *pixels,
117                           gint           npixels,
118                           gulong         planes);
119 gint gdk_color_white     (GdkColormap   *colormap,
120                           GdkColor      *color);
121 gint gdk_color_black     (GdkColormap   *colormap,
122                           GdkColor      *color);
123 gint gdk_color_alloc     (GdkColormap   *colormap,
124                           GdkColor      *color);
125 gint gdk_color_change    (GdkColormap   *colormap,
126                           GdkColor      *color);
127 #endif /* GDK_DISABLE_DEPRECATED */
128
129 #ifdef __cplusplus
130 }
131 #endif /* __cplusplus */
132
133 #endif /* __GDK_COLOR_H__ */