XGetMultiColorCursorInfo Extension Function

x11 R6 Technical Reference

XGetMultiColorCursorInfo Extension Function

Purpose

Determines screen attributes for the multicolor cursor by way of the specified drawable.

Library

Enhanced X-Windows Library (libXext.a)

C Syntax

Status XGetMultiColorCursorInfo(DisplayPtr, DrawablePtr, CursorPlanes, 
                                                       TransparentPixel, Width, Height)
Display *DisplayPtr;
Drawable *DrawablePtr;
short *CursorPlanes;
int *TransparentPixel;
short *Width;
short *Height;

Description

The XGetMultiColorCursorInfo extension function returns the number of cursor planes, the transparent pixel value, and the maximum width and height for the screen by way of the drawable specified.

If a value of -1 is returned for the TransparentPixel parameter, then transparency is not supported.

Parameters

DisplayPtr	Specifies the connection to the X server.
DrawablePtr	Specifies a drawable used to determine the screen where the multicolored cursor is created.
CursorPlanes	Returns the number of hardware cursor color planes.
TransparentPixel	Returns the color that is transparent. If transparent pixels are not supported, a value of -1 is returned.
Width	Returns the maximum width supported.
Height	Returns the maximum height supported.

Return Values

True	Indicates that the XGetMultiColorCursorInfo extension function is successful.
False	Indicates that the XGetMultiColorCursorInfo extension function is not successful.

Error Codes

BadDrawable

Related Information

Using Extensions in AIXwindows in AIX Version 4.3 AIXwindows Programming Guide.

AIXwindows Overview for Programmers in AIX Version 4.3 AIXwindows Programming Guide.