Imported Upstream version 1.15.1
[deb_xorg-server.git] / include / cursor.h
CommitLineData
a09e091a
JB
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
25Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
26
27 All Rights Reserved
28
29Permission to use, copy, modify, and distribute this software and its
30documentation for any purpose and without fee is hereby granted,
31provided that the above copyright notice appear in all copies and that
32both that copyright notice and this permission notice appear in
33supporting documentation, and that the name of Digital not be
34used in advertising or publicity pertaining to distribution of the
35software without specific, written prior permission.
36
37DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
38ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
39DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
40ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
41WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
42ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
43SOFTWARE.
44
45******************************************************************/
46
47#ifndef CURSOR_H
48#define CURSOR_H
49
50#include "misc.h"
51#include "screenint.h"
52#include "window.h"
53#include "privates.h"
54
55#define NullCursor ((CursorPtr)NULL)
56
57/* Provide support for alpha composited cursors */
58#define ARGB_CURSOR
59
60struct _DeviceIntRec;
61
62typedef struct _Cursor *CursorPtr;
63typedef struct _CursorMetric *CursorMetricPtr;
64
65extern _X_EXPORT DevScreenPrivateKeyRec cursorScreenDevPriv;
66
67#define CursorScreenKey (&cursorScreenDevPriv)
68
69extern _X_EXPORT CursorPtr rootCursor;
70
71extern _X_EXPORT int FreeCursor(pointer /*pCurs */ ,
72 XID /*cid */ );
73
74extern _X_EXPORT CursorPtr RefCursor(CursorPtr /* cursor */);
75extern _X_EXPORT CursorPtr UnrefCursor(CursorPtr /* cursor */);
76extern _X_EXPORT int CursorRefCount(const CursorPtr /* cursor */);
77
78extern _X_EXPORT int AllocARGBCursor(unsigned char * /*psrcbits */ ,
79 unsigned char * /*pmaskbits */ ,
80 CARD32 * /*argb */ ,
81 CursorMetricPtr /*cm */ ,
82 unsigned /*foreRed */ ,
83 unsigned /*foreGreen */ ,
84 unsigned /*foreBlue */ ,
85 unsigned /*backRed */ ,
86 unsigned /*backGreen */ ,
87 unsigned /*backBlue */ ,
88 CursorPtr * /*ppCurs */ ,
89 ClientPtr /*client */ ,
90 XID /*cid */ );
91
92extern _X_EXPORT int AllocGlyphCursor(Font /*source */ ,
93 unsigned int /*sourceChar */ ,
94 Font /*mask */ ,
95 unsigned int /*maskChar */ ,
96 unsigned /*foreRed */ ,
97 unsigned /*foreGreen */ ,
98 unsigned /*foreBlue */ ,
99 unsigned /*backRed */ ,
100 unsigned /*backGreen */ ,
101 unsigned /*backBlue */ ,
102 CursorPtr * /*ppCurs */ ,
103 ClientPtr /*client */ ,
104 XID /*cid */ );
105
106extern _X_EXPORT CursorPtr CreateRootCursor(char * /*pfilename */ ,
107 unsigned int /*glyph */ );
108
109extern _X_EXPORT int ServerBitsFromGlyph(FontPtr /*pfont */ ,
110 unsigned int /*ch */ ,
111 CursorMetricPtr /*cm */ ,
112 unsigned char ** /*ppbits */ );
113
114extern _X_EXPORT Bool CursorMetricsFromGlyph(FontPtr /*pfont */ ,
115 unsigned /*ch */ ,
116 CursorMetricPtr /*cm */ );
117
118extern _X_EXPORT void CheckCursorConfinement(WindowPtr /*pWin */ );
119
120extern _X_EXPORT void NewCurrentScreen(struct _DeviceIntRec * /*pDev */ ,
121 ScreenPtr /*newScreen */ ,
122 int /*x */ ,
123 int /*y */ );
124
125extern _X_EXPORT Bool PointerConfinedToScreen(struct _DeviceIntRec * /* pDev */
126 );
127
128extern _X_EXPORT void GetSpritePosition(struct _DeviceIntRec * /* pDev */ ,
129 int * /*px */ ,
130 int * /*py */ );
131
132#ifdef PANORAMIX
133extern _X_EXPORT int XineramaGetCursorScreen(struct _DeviceIntRec *pDev);
134#endif /* PANORAMIX */
135
136#endif /* CURSOR_H */