t
Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.


t
XGetVisualInfo __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
XGetVisualInfo, XMatchVisualInfo, XVisualIDFromVisual, XVisualInfo - obtain visual information and visual structure
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\^);

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.
DESCRIPTION
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 */

#define
VisualNoMask T} T{ 0x0 T} T{ #define T} T{ VisualIDMask T} T{ 0x1 T} T{ #define T} T{ VisualScreenMask T} T{ 0x2 T} T{ #define T} T{ VisualDepthMask T} T{ 0x4 T} T{ #define T} T{ VisualClassMask T} T{ 0x8 T} T{ #define T} T{ VisualRedMaskMask T} T{ 0x10 T} T{ #define T} T{ VisualGreenMaskMask T} T{ 0x20 T} T{ #define T} T{ VisualBlueMaskMask T} T{ 0x40 T} T{ #define T} T{ VisualColormapSizeMask T} T{ 0x80 T} T{ #define T} T{ VisualBitsPerRGBMask T} T{ 0x100 T} T{ #define T} T{ VisualAllMask T} T{ 0x1FF T} .TE .EX /* 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;
"SEE ALSO"
XFree(__libmansuffix__)

\*(xL