summaryrefslogtreecommitdiff
path: root/libs/gtkmm2/gdk/gdkmm/rgb.h
blob: fa504ae68c421c3ea3e71685031af95a823d79bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/* $Id$ */

/* Copyright 2004      The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _GDKMM_RGB_H
#define _GDKMM_RGB_H

#include <gdkmm/colormap.h>  
#include <gdkmm/visual.h>

namespace Gdk
{

/** Get the preferred colormap for rendering image data.
 * Not a very useful function; historically, GDK could only render RGB image data to one colormap and visual,
 * but in the current version it can render to any colormap and visual. So there's no need to call this function.
 *
 * @result The preferred colormap
 */
Glib::RefPtr<Colormap> rgb_get_colormap();

/** Gets a "preferred visual" chosen by GdkRGB for rendering image data on the default screen.
 * In previous versions of GDK, this was the only visual GdkRGB could use for rendering. In current versions,
 * it's simply the visual GdkRGB would have chosen as the optimal one in those previous versions.
 * GdkRGB can now render to drawables with any visual.
 * @result The Gdk::Visual chosen by GdkRGB.
 */
Glib::RefPtr<Visual> rgb_get_visual();

/** Determines whether the visual is ditherable.
 * This function may be useful for presenting a user interface choice to the user about which dither mode is desired;
 * if the display is not ditherable, it may make sense to gray out or hide the corresponding UI widget.
 * result true if the visual is ditherable.
 */
bool rgb_ditherable();

} //namespace Gdk

#endif //_GDKMM_RGB_H