1/***********************************************************
2
3Copyright 1987, 1998  The Open Group
4
5Permission to use, copy, modify, distribute, and sell this software and its
6documentation for any purpose is hereby granted without fee, provided that
7the above copyright notice appear in all copies and that both that
8copyright notice and this permission notice appear in supporting
9documentation.
10
11The above copyright notice and this permission notice shall be included in
12all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21Except as contained in this notice, the name of The Open Group shall not be
22used in advertising or otherwise to promote the sale, use or other dealings
23in this Software without prior written authorization from The Open Group.
24
25
26Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
27
28                        All Rights Reserved
29
30Permission to use, copy, modify, and distribute this software and its
31documentation for any purpose and without fee is hereby granted,
32provided that the above copyright notice appear in all copies and that
33both that copyright notice and this permission notice appear in
34supporting documentation, and that the name of Digital not be
35used in advertising or publicity pertaining to distribution of the
36software without specific, written prior permission.
37
38DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
39ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
40DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
41ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
42WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
43ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44SOFTWARE.
45
46******************************************************************/
47
48#ifndef CURSOR_H
49#define CURSOR_H
50
51#include "misc.h"
52#include "screenint.h"
53#include "window.h"
54#include "privates.h"
55
56#define NullCursor ((CursorPtr)NULL)
57
58/* Provide support for alpha composited cursors */
59#define ARGB_CURSOR
60
61struct _DeviceIntRec;
62
63typedef struct _Cursor *CursorPtr;
64typedef struct _CursorMetric *CursorMetricPtr;
65
66extern _X_EXPORT DevPrivateKeyRec cursorScreenDevPriv[MAXSCREENS];
67#define CursorScreenKey(pScreen) (cursorScreenDevPriv + (pScreen)->myNum)
68
69extern _X_EXPORT CursorPtr rootCursor;
70
71extern _X_EXPORT int FreeCursor(
72    pointer /*pCurs*/,
73    XID /*cid*/);
74
75extern _X_EXPORT int AllocARGBCursor(
76    unsigned char* /*psrcbits*/,
77    unsigned char* /*pmaskbits*/,
78    CARD32* /*argb*/,
79    CursorMetricPtr /*cm*/,
80    unsigned /*foreRed*/,
81    unsigned /*foreGreen*/,
82    unsigned /*foreBlue*/,
83    unsigned /*backRed*/,
84    unsigned /*backGreen*/,
85    unsigned /*backBlue*/,
86    CursorPtr* /*ppCurs*/,
87    ClientPtr /*client*/,
88    XID /*cid*/);
89
90extern _X_EXPORT int AllocGlyphCursor(
91    Font /*source*/,
92    unsigned int /*sourceChar*/,
93    Font /*mask*/,
94    unsigned int /*maskChar*/,
95    unsigned /*foreRed*/,
96    unsigned /*foreGreen*/,
97    unsigned /*foreBlue*/,
98    unsigned /*backRed*/,
99    unsigned /*backGreen*/,
100    unsigned /*backBlue*/,
101    CursorPtr* /*ppCurs*/,
102    ClientPtr /*client*/,
103    XID /*cid*/);
104
105extern _X_EXPORT CursorPtr CreateRootCursor(
106    char* /*pfilename*/,
107    unsigned int /*glyph*/);
108
109extern _X_EXPORT int ServerBitsFromGlyph(
110    FontPtr /*pfont*/,
111    unsigned int /*ch*/,
112    CursorMetricPtr /*cm*/,
113    unsigned char ** /*ppbits*/);
114
115extern _X_EXPORT Bool CursorMetricsFromGlyph(
116    FontPtr /*pfont*/,
117    unsigned /*ch*/,
118    CursorMetricPtr /*cm*/);
119
120extern _X_EXPORT void CheckCursorConfinement(
121    WindowPtr /*pWin*/);
122
123extern _X_EXPORT void NewCurrentScreen(
124    struct _DeviceIntRec* /*pDev*/,
125    ScreenPtr /*newScreen*/,
126    int /*x*/,
127    int /*y*/);
128
129extern _X_EXPORT Bool PointerConfinedToScreen(struct _DeviceIntRec* /* pDev */);
130
131extern _X_EXPORT void GetSpritePosition(
132    struct _DeviceIntRec* /* pDev */,
133    int * /*px*/,
134    int * /*py*/);
135
136#ifdef PANORAMIX
137extern _X_EXPORT int XineramaGetCursorScreen(struct _DeviceIntRec* pDev);
138#endif /* PANORAMIX */
139
140#endif /* CURSOR_H */
141