carta
XVisualInfo(3)

XVisualInfo3

Obtain visual information and visual structure

Part of XGetVisualInfo(3).

Usage

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

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.

nitems_return

Returns the number of matching visual structures.

screen

Specifies the screen.

visual

Specifies the visual type.

vinfo_mask

Specifies the visual mask value.

vinfo_return

Returns the matched visual information.

vinfo_template

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

Overview

The 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, 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.

Structures

The XVisualInfo structure contains:

/* Visual information mask bits */

#defineVisualNoMask0x0
#defineVisualIDMask0x1
#defineVisualScreenMask0x2
#defineVisualDepthMask0x4
#defineVisualClassMask0x8
#defineVisualRedMaskMask0x10
#defineVisualGreenMaskMask0x20
#defineVisualBlueMaskMask0x40
#defineVisualColormapSizeMask0x80
#defineVisualBitsPerRGBMask0x100
#defineVisualAllMask0x1FF
/* 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;

History

  • Arch Linux 2026-11-01: the text shown here
  • Debian 13 (Trixie)
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)
  • Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze)
  • Debian 5.0 (Lenny)
  • Debian 4.0 (Etch)

From libx11 1.8.14-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.