XGetVisualInfo(3) XLIB FUNCTIONS XGetVisualInfo(3)

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

SYNTAX
       XVisualInfo *XGetVisualInfo(Display *display, long vinfomask, XVisual‐
              Info *vinfotemplate, int *nitemsreturn);

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

       VisualID XVisualIDFromVisual(Visual *visual);

ARGUMENTS
       class     Specifies the class of the screen.

       depth     Specifies the depth of the screen.

       display   Specifies the connection to the X server.

       nitemsreturn
                 Returns the number of matching visual structures.

       screen    Specifies the screen.

       visual    Specifies the visual type.

       vinfomask
                 Specifies the visual mask value.

       vinforeturn
                 Returns the matched visual information.

       vinfotemplate
                 Specifies the visual attributes that are to be used in match‐
                 ing the visual structures.

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

       The XMatchVisualInfo function returns the visual information for a vis‐
       ual 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, XMatchVi‐
       sualInfo returns nonzero and the information on the visual to
       vinforeturn.  Otherwise, when a visual is not found, XMatchVisualInfo
       returns zero.

       The XVisualIDFromVisual function returns the visual ID for the speci‐
       fied visual type.

STRUCTURES
       The XVisualInfo structure contains:

       /* Visual information mask bits */

       #define   VisualNoMask                0x0

       #define   VisualIDMask                0x1
       #define   VisualScreenMask            0x2
       #define   VisualDepthMask             0x4
       #define   VisualClassMask             0x8
       #define   VisualRedMaskMask           0x10
       #define   VisualGreenMaskMask         0x20
       #define   VisualBlueMaskMask          0x40
       #define   VisualColormapSizeMask      0x80
       #define   VisualBitsPerRGBMask        0x100
       #define   VisualAllMask               0x1FF
       /* Values */

       typedef struct {
               Visual *visual;
               VisualID visualid;
               int screen;
               int depth;
               int class;
               unsigned long redmask;
               unsigned long greenmask;
               unsigned long bluemask;
               int colormapsize;
               int bitsperrgb;
       } XVisualInfo;

SEE ALSO
       XFree(3)
       Xlib - C Language X Interface



X Version 11                     libX11 1.6.5                XGetVisualInfo(3)