1. NAME

XGetVisualInfo, XMatchVisualInfo, XVisualIDFromVisual, XVisualInfo - obtain visual information and visual structure

2. SYNTAX

XVisualInfo *XGetVisualInfo(Display *display, long vinfo_mask, XVisualInfo *vinfo_template, int *nitems_return); Status XMatchVisualInfo(Display *display, int screen, int depth, int class, XVisualInfo *vinfo_return); VisualID XVisualIDFromVisual(Visual *visual);

3. ARGUMENTS

class 1i Specifies the class of the screen.

depth 1i Specifies the depth of the screen.

display 1i Specifies the connection to the X server.

nitems_return 1i Returns the number of matching visual structures.

screen 1i Specifies the screen.

visual 1i Specifies the visual type.

vinfo_mask 1i Specifies the visual mask value.

vinfo_return 1i Returns the matched visual information.

vinfo_template 1i Specifies the visual attributes that are to be used in matching the visual structures.

4. DESCRIPTION

The .ZN XGetVisualInfo function returns a list of visual structures that have attributes equal to the attributes specified by vinfo_template. If no visual structures match the template using the specified vinfo_mask, .ZN XGetVisualInfo returns a NULL. To free the data returned by this function, use .ZN XFree .

The .ZN XMatchVisualInfo function returns the visual information for a visual that matches the specified depth and class for a screen. Because multiple visuals that match the specified depth and class can exist, the exact visual chosen is undefined. If a visual is found, .ZN XMatchVisualInfo returns nonzero and the information on the visual to vinfo_return. Otherwise, when a visual is not found, .ZN XMatchVisualInfo returns zero.

The .ZN XVisualIDFromVisual function returns the visual ID for the specified visual type.

5. STRUCTURES

The .ZN XVisualInfo structure contains:

/* Visual information mask bits */

lw(.5i) lw(2.5i) lw(.8i).
T{
#define
T} T{
.ZN VisualNoMask
T} T{
0x0
T}
T{
#define
T} T{
.ZN VisualIDMask
T} T{
0x1
T}
T{
#define
T} T{
.ZN VisualScreenMask
T} T{
0x2
T}
T{
#define
T} T{
.ZN VisualDepthMask
T} T{
0x4
T}
T{
#define
T} T{
.ZN VisualClassMask
T} T{
0x8
T}
T{
#define
T} T{
.ZN VisualRedMaskMask
T} T{
0x10
T}
T{
#define
T} T{
.ZN VisualGreenMaskMask
T} T{
0x20
T}
T{
#define
T} T{
.ZN VisualBlueMaskMask
T} T{
0x40
T}
T{
#define
T} T{
.ZN VisualColormapSizeMask
T} T{
0x80
T}
T{
#define
T} T{
.ZN VisualBitsPerRGBMask
T} T{
0x100
T}
T{
#define
T} T{
.ZN VisualAllMask
T} T{
0x1FF
T}

.TA .5i 3i .5i 3i /* Values */ typedef struct { Visual *visual; VisualID visualid; int screen; int depth; int class; unsigned long red_mask; unsigned long green_mask; unsigned long blue_mask; int colormap_size; int bits_per_rgb; } XVisualInfo; .De

6. SEE ALSO

XFree(3)
\*(xL