XVisualIDFromVisual(3x)

XVisualIDFromVisual3x

Obtain visual information and visual structure

Part of XGetVisualInfo(3x).

Usage

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);

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:

#define0x0
#define0x1
#define0x2
#define0x4
#define0x8
#define0x10
#define0x20
#define0x40
#define0x80
#define0x100
#define0x1FF
typedef struct {
	Visual *visual;
	VisualID visualid;
	int screen;
	unsigned int depth;
	int class;
	unsigned long red_mask;
	unsigned long green_mask;
	unsigned long blue_mask;
	int colormap_size;
	int bits_per_rgb;
} XVisualInfo;

Releases

8 releases since Debian 1.1 (Buzz); the text changed 4 times.

  1. 1.1
  2. 1.2
  3. 1.3–2.2
  4. 3.0
  5. 3.1

From libx11-dev 4.3.0.dfsg.1-14sarge7 in Debian 3.1 (Sarge). Parsed by carta from the page's man source.