gdkvisual.c 13 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
2
 * gdkvisual.c
Matthias Clasen's avatar
Matthias Clasen committed
3 4
 *
 * Copyright 2001 Sun Microsystems Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * Erwann Chenede <erwann.chenede@sun.com>
 *
 * 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
Javier Jardón's avatar
Javier Jardón committed
19
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 21
 */

22
#include "config.h"
23

24 25
#include "gdkvisualprivate.h"
#include "gdkscreenprivate.h"
26

27

28 29 30 31 32
/**
 * SECTION:visuals
 * @Short_description: Low-level display hardware information
 * @Title: Visuals
 *
Matthias Clasen's avatar
Matthias Clasen committed
33 34 35 36 37 38 39 40
 * A #GdkVisual describes a particular video hardware display format.
 * It includes information about the number of bits used for each color,
 * the way the bits are translated into an RGB value for display, and
 * the way the bits are stored in memory. For example, a piece of display
 * hardware might support 24-bit color, 16-bit color, or 8-bit color;
 * meaning 24/16/8-bit pixel sizes. For a given pixel size, pixels can
 * be in different formats; for example the "red" element of an RGB pixel
 * may be in the top 8 bits of the pixel, or may be in the lower 4 bits.
41 42 43 44
 *
 * There are several standard visuals. The visual returned by
 * gdk_screen_get_system_visual() is the system's default visual.
 *
Matthias Clasen's avatar
Matthias Clasen committed
45 46 47 48 49 50 51 52
 * A number of functions are provided for determining the "best" available
 * visual. For the purposes of making this determination, higher bit depths
 * are considered better, and for visuals of the same bit depth,
 * %GDK_VISUAL_PSEUDO_COLOR is preferred at 8bpp, otherwise, the visual
 * types are ranked in the order of(highest to lowest)
 * %GDK_VISUAL_DIRECT_COLOR, %GDK_VISUAL_TRUE_COLOR,
 * %GDK_VISUAL_PSEUDO_COLOR, %GDK_VISUAL_STATIC_COLOR,
 * %GDK_VISUAL_GRAYSCALE, then %GDK_VISUAL_STATIC_GRAY.
53 54
 */

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
G_DEFINE_TYPE (GdkVisual, gdk_visual, G_TYPE_OBJECT)

static void
gdk_visual_init (GdkVisual *visual)
{
}

static void
gdk_visual_finalize (GObject *object)
{
  G_OBJECT_CLASS (gdk_visual_parent_class)->finalize (object);
}

static void
gdk_visual_class_init (GdkVisualClass *visual_class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (visual_class);

  object_class->finalize = gdk_visual_finalize;
}
75

76 77
/**
 * gdk_list_visuals:
Matthias Clasen's avatar
Matthias Clasen committed
78
 *
79 80 81 82 83 84 85
 * Lists the available visuals for the default screen.
 * (See gdk_screen_list_visuals())
 * A visual describes a hardware image data format.
 * For example, a visual might support 24-bit color, or 8-bit color,
 * and might expect pixels to be in a certain format.
 *
 * Call g_list_free() on the return value when you're finished with it.
Matthias Clasen's avatar
Matthias Clasen committed
86
 *
Matthias Clasen's avatar
Matthias Clasen committed
87 88
 * Return value: (transfer container) (element-type GdkVisual):
 *     a list of visuals; the list must be freed, but not its contents
Matthias Clasen's avatar
Matthias Clasen committed
89
 */
90 91 92
GList*
gdk_list_visuals (void)
{
Owen Taylor's avatar
Owen Taylor committed
93
  return gdk_screen_list_visuals (gdk_screen_get_default ());
94 95 96 97
}

/**
 * gdk_visual_get_system:
Matthias Clasen's avatar
Matthias Clasen committed
98
 *
99
 * Get the system's default visual for the default GDK screen.
100 101
 * This is the visual for the root window of the display.
 * The return value should not be freed.
Matthias Clasen's avatar
Matthias Clasen committed
102
 *
103
 * Return value: (transfer none): system visual
Matthias Clasen's avatar
Matthias Clasen committed
104
 */
105 106 107
GdkVisual*
gdk_visual_get_system (void)
{
Owen Taylor's avatar
Owen Taylor committed
108
  return gdk_screen_get_system_visual (gdk_screen_get_default());
109
}
110

111 112 113 114 115 116 117 118
/**
 * gdk_visual_get_best_depth:
 *
 * Get the best available depth for the default GDK screen.  "Best"
 * means "largest," i.e. 32 preferred over 24 preferred over 8 bits
 * per pixel.
 *
 * Return value: best available depth
Matthias Clasen's avatar
Matthias Clasen committed
119
 */
120 121 122 123 124 125 126 127 128 129 130 131 132 133
gint
gdk_visual_get_best_depth (void)
{
  GdkScreen *screen = gdk_screen_get_default();

  return GDK_SCREEN_GET_CLASS(screen)->visual_get_best_depth (screen);
}

/**
 * gdk_visual_get_best_type:
 *
 * Return the best available visual type for the default GDK screen.
 *
 * Return value: best visual type
Matthias Clasen's avatar
Matthias Clasen committed
134
 */
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
GdkVisualType
gdk_visual_get_best_type (void)
{
  GdkScreen *screen = gdk_screen_get_default();

  return GDK_SCREEN_GET_CLASS(screen)->visual_get_best_type (screen);
}

/**
 * gdk_visual_get_best:
 *
 * Get the visual with the most available colors for the default
 * GDK screen. The return value should not be freed.
 *
 * Return value: (transfer none): best visual
Matthias Clasen's avatar
Matthias Clasen committed
150
 */
151 152 153 154 155 156 157 158 159 160 161 162 163 164
GdkVisual*
gdk_visual_get_best (void)
{
  GdkScreen *screen = gdk_screen_get_default();

  return GDK_SCREEN_GET_CLASS(screen)->visual_get_best (screen);
}

/**
 * gdk_visual_get_best_with_depth:
 * @depth: a bit depth
 *
 * Get the best visual with depth @depth for the default GDK screen.
 * Color visuals and visuals with mutable colormaps are preferred
Matthias Clasen's avatar
Matthias Clasen committed
165 166
 * over grayscale or fixed-colormap visuals. The return value should
 * not be freed. %NULL may be returned if no visual supports @depth.
167 168
 *
 * Return value: (transfer none): best visual for the given depth
Matthias Clasen's avatar
Matthias Clasen committed
169
 */
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
GdkVisual*
gdk_visual_get_best_with_depth (gint depth)
{
  GdkScreen *screen = gdk_screen_get_default();

  return GDK_SCREEN_GET_CLASS(screen)->visual_get_best_with_depth (screen, depth);
}

/**
 * gdk_visual_get_best_with_type:
 * @visual_type: a visual type
 *
 * Get the best visual of the given @visual_type for the default GDK screen.
 * Visuals with higher color depths are considered better. The return value
 * should not be freed. %NULL may be returned if no visual has type
 * @visual_type.
 *
 * Return value: (transfer none): best visual of the given type
Matthias Clasen's avatar
Matthias Clasen committed
188
 */
189 190 191 192 193 194
GdkVisual*
gdk_visual_get_best_with_type (GdkVisualType visual_type)
{
  GdkScreen *screen = gdk_screen_get_default();

  return GDK_SCREEN_GET_CLASS(screen)->visual_get_best_with_type (screen,
Matthias Clasen's avatar
Matthias Clasen committed
195
                                                                  visual_type);
196 197 198 199 200 201 202
}

/**
 * gdk_visual_get_best_with_both:
 * @depth: a bit depth
 * @visual_type: a visual type
 *
Matthias Clasen's avatar
Matthias Clasen committed
203 204
 * Combines gdk_visual_get_best_with_depth() and
 * gdk_visual_get_best_with_type().
205 206 207
 *
 * Return value: (transfer none): best visual with both @depth and
 *     @visual_type, or %NULL if none
Matthias Clasen's avatar
Matthias Clasen committed
208
 */
209 210 211 212 213 214 215 216 217 218 219
GdkVisual*
gdk_visual_get_best_with_both (gint          depth,
			       GdkVisualType visual_type)
{
  GdkScreen *screen = gdk_screen_get_default();

  return GDK_SCREEN_GET_CLASS(screen)->visual_get_best_with_both (screen, depth, visual_type);
}

/**
 * gdk_query_depths:
220 221 222
 * @depths: (out) (array length=count) (transfer none): return
 *     location for available depths
 * @count: return location for number of available depths
223 224 225 226 227 228 229
 *
 * This function returns the available bit depths for the default
 * screen. It's equivalent to listing the visuals
 * (gdk_list_visuals()) and then looking at the depth field in each
 * visual, removing duplicates.
 *
 * The array returned by this function should not be freed.
Matthias Clasen's avatar
Matthias Clasen committed
230
 */
231
void
Matthias Clasen's avatar
Matthias Clasen committed
232 233
gdk_query_depths (gint **depths,
                  gint  *count)
234 235 236 237 238 239 240 241
{
  GdkScreen *screen = gdk_screen_get_default();

  GDK_SCREEN_GET_CLASS(screen)->query_depths (screen, depths, count);
}

/**
 * gdk_query_visual_types:
242 243
 * @visual_types: (out) (array length=count) (transfer none): return
 *     location for the available visual types
244 245 246 247 248 249 250 251
 * @count: return location for the number of available visual types
 *
 * This function returns the available visual types for the default
 * screen. It's equivalent to listing the visuals
 * (gdk_list_visuals()) and then looking at the type field in each
 * visual, removing duplicates.
 *
 * The array returned by this function should not be freed.
Matthias Clasen's avatar
Matthias Clasen committed
252
 */
253 254
void
gdk_query_visual_types (GdkVisualType **visual_types,
Matthias Clasen's avatar
Matthias Clasen committed
255
                        gint           *count)
256 257 258 259 260 261
{
  GdkScreen *screen = gdk_screen_get_default();

  GDK_SCREEN_GET_CLASS(screen)->query_visual_types (screen, visual_types, count);
}

Matthias Clasen's avatar
Matthias Clasen committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
/**
 * gdk_visual_get_visual_type:
 * @visual: A #GdkVisual.
 *
 * Returns the type of visual this is (PseudoColor, TrueColor, etc).
 *
 * Return value: A #GdkVisualType stating the type of @visual.
 *
 * Since: 2.22
 */
GdkVisualType
gdk_visual_get_visual_type (GdkVisual *visual)
{
  g_return_val_if_fail (GDK_IS_VISUAL (visual), 0);

  return visual->type;
}

/**
 * gdk_visual_get_depth:
 * @visual: A #GdkVisual.
 *
 * Returns the bit depth of this visual.
 *
 * Return value: The bit depth of this visual.
 *
 * Since: 2.22
 */
gint
gdk_visual_get_depth (GdkVisual *visual)
{
  g_return_val_if_fail (GDK_IS_VISUAL (visual), 0);

  return visual->depth;
}

/**
 * gdk_visual_get_byte_order:
 * @visual: A #GdkVisual.
 *
 * Returns the byte order of this visual.
 *
 * Return value: A #GdkByteOrder stating the byte order of @visual.
 *
 * Since: 2.22
 */
GdkByteOrder
gdk_visual_get_byte_order (GdkVisual *visual)
{
  g_return_val_if_fail (GDK_IS_VISUAL (visual), 0);

  return visual->byte_order;
}

/**
 * gdk_visual_get_colormap_size:
 * @visual: A #GdkVisual.
 *
 * Returns the size of a colormap for this visual.
 *
 * Return value: The size of a colormap that is suitable for @visual.
 *
 * Since: 2.22
 */
gint
gdk_visual_get_colormap_size (GdkVisual *visual)
{
  g_return_val_if_fail (GDK_IS_VISUAL (visual), 0);

  return visual->colormap_size;
}

/**
 * gdk_visual_get_bits_per_rgb:
 * @visual: a #GdkVisual
 *
 * Returns the number of significant bits per red, green and blue value.
 *
 * Return value: The number of significant bits per color value for @visual.
 *
 * Since: 2.22
 */
gint
gdk_visual_get_bits_per_rgb (GdkVisual *visual)
{
  g_return_val_if_fail (GDK_IS_VISUAL (visual), 0);

  return visual->bits_per_rgb;
}

/**
 * gdk_visual_get_red_pixel_details:
Matthias Clasen's avatar
Matthias Clasen committed
354 355 356 357
 * @visual: A #GdkVisual
 * @mask: (out) (allow-none): A pointer to a #guint32 to be filled in, or %NULL
 * @shift: (out) (allow-none): A pointer to a #gint to be filled in, or %NULL
 * @precision: (out) (allow-none): A pointer to a #gint to be filled in, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
358 359
 *
 * Obtains values that are needed to calculate red pixel values in TrueColor
Matthias Clasen's avatar
Matthias Clasen committed
360
 * and DirectColor. The "mask" is the significant bits within the pixel.
Matthias Clasen's avatar
Matthias Clasen committed
361
 * The "shift" is the number of bits left we must shift a primary for it
Matthias Clasen's avatar
Matthias Clasen committed
362
 * to be in position (according to the "mask"). Finally, "precision" refers
Matthias Clasen's avatar
Matthias Clasen committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
 * to how much precision the pixel value contains for a particular primary.
 *
 * Since: 2.22
 */
void
gdk_visual_get_red_pixel_details (GdkVisual *visual,
                                  guint32   *mask,
                                  gint      *shift,
                                  gint      *precision)
{
  g_return_if_fail (GDK_IS_VISUAL (visual));

  if (mask)
    *mask = visual->red_mask;

  if (shift)
    *shift = visual->red_shift;

  if (precision)
    *precision = visual->red_prec;
}

/**
 * gdk_visual_get_green_pixel_details:
 * @visual: a #GdkVisual
Matthias Clasen's avatar
Matthias Clasen committed
388 389 390
 * @mask: (out) (allow-none): A pointer to a #guint32 to be filled in, or %NULL
 * @shift: (out) (allow-none): A pointer to a #gint to be filled in, or %NULL
 * @precision: (out) (allow-none): A pointer to a #gint to be filled in, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
391 392
 *
 * Obtains values that are needed to calculate green pixel values in TrueColor
Matthias Clasen's avatar
Matthias Clasen committed
393
 * and DirectColor. The "mask" is the significant bits within the pixel.
Matthias Clasen's avatar
Matthias Clasen committed
394
 * The "shift" is the number of bits left we must shift a primary for it
Matthias Clasen's avatar
Matthias Clasen committed
395
 * to be in position (according to the "mask"). Finally, "precision" refers
Matthias Clasen's avatar
Matthias Clasen committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
 * to how much precision the pixel value contains for a particular primary.
 *
 * Since: 2.22
 */
void
gdk_visual_get_green_pixel_details (GdkVisual *visual,
                                    guint32   *mask,
                                    gint      *shift,
                                    gint      *precision)
{
  g_return_if_fail (GDK_IS_VISUAL (visual));

  if (mask)
    *mask = visual->green_mask;

  if (shift)
    *shift = visual->green_shift;

  if (precision)
    *precision = visual->green_prec;
}

/**
 * gdk_visual_get_blue_pixel_details:
 * @visual: a #GdkVisual
Matthias Clasen's avatar
Matthias Clasen committed
421 422 423
 * @mask: (out) (allow-none): A pointer to a #guint32 to be filled in, or %NULL
 * @shift: (out) (allow-none): A pointer to a #gint to be filled in, or %NULL
 * @precision: (out) (allow-none): A pointer to a #gint to be filled in, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
424 425
 *
 * Obtains values that are needed to calculate blue pixel values in TrueColor
Matthias Clasen's avatar
Matthias Clasen committed
426
 * and DirectColor. The "mask" is the significant bits within the pixel.
Matthias Clasen's avatar
Matthias Clasen committed
427
 * The "shift" is the number of bits left we must shift a primary for it
Matthias Clasen's avatar
Matthias Clasen committed
428
 * to be in position (according to the "mask"). Finally, "precision" refers
Matthias Clasen's avatar
Matthias Clasen committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
 * to how much precision the pixel value contains for a particular primary.
 *
 * Since: 2.22
 */
void
gdk_visual_get_blue_pixel_details (GdkVisual *visual,
                                   guint32   *mask,
                                   gint      *shift,
                                   gint      *precision)
{
  g_return_if_fail (GDK_IS_VISUAL (visual));

  if (mask)
    *mask = visual->blue_mask;

  if (shift)
    *shift = visual->blue_shift;

  if (precision)
    *precision = visual->blue_prec;
}
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467

/**
 * gdk_visual_get_screen:
 * @visual: a #GdkVisual
 *
 * Gets the screen to which this visual belongs
 *
 * Return value: (transfer none): the screen to which this visual belongs.
 *
 * Since: 2.2
 */
GdkScreen *
gdk_visual_get_screen (GdkVisual *visual)
{
  g_return_val_if_fail (GDK_IS_VISUAL (visual), NULL);

  return visual->screen;
}