Name

XGetVisualInfo, XMatchVisualInfo, XVisualIDFromVisual − obtain visual information

Syntax

XVisualInfo *XGetVisualInfo(display, vinfo_mask, vinfo_template, nitems_return)
      Display *display;
      long vinfo_mask;
      XVisualInfo *vinfo_template;
      int *nitems_return;

Status XMatchVisualInfo(display, screen, depth, class, vinfo_return)
      Display *display;
      int screen;
      int depth;
      int class;
      XVisualInfo *vinfo_return;

VisualID XVisualIDFromVisual(visual)
       Visual *visual;

Arguments

classSpecifies the class of the screen. 

depthSpecifies the depth of the screen. 

displaySpecifies the connection to the X server. 

nitems_return
Returns the number of matching visual structures.

screenSpecifies the screen. 

visualSpecifies the visual type. 

vinfo_maskSpecifies the visual mask value. 

vinfo_returnReturns the matched visual information. 

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

Description

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

The 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, XMatchVisualInfo returns nonzero and the information on the visual to vinfo_return. Otherwise, when a visual is not found, XMatchVisualInfo returns zero.

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

See Also

Guide to the Xlib Library