xref: /OK3568_Linux_fs/external/xserver/include/pixmap.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /***********************************************************
2*4882a593Smuzhiyun 
3*4882a593Smuzhiyun Copyright 1987, 1998  The Open Group
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun Permission to use, copy, modify, distribute, and sell this software and its
6*4882a593Smuzhiyun documentation for any purpose is hereby granted without fee, provided that
7*4882a593Smuzhiyun the above copyright notice appear in all copies and that both that
8*4882a593Smuzhiyun copyright notice and this permission notice appear in supporting
9*4882a593Smuzhiyun documentation.
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun The above copyright notice and this permission notice shall be included in
12*4882a593Smuzhiyun all copies or substantial portions of the Software.
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15*4882a593Smuzhiyun IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16*4882a593Smuzhiyun FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17*4882a593Smuzhiyun OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18*4882a593Smuzhiyun AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19*4882a593Smuzhiyun CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun Except as contained in this notice, the name of The Open Group shall not be
22*4882a593Smuzhiyun used in advertising or otherwise to promote the sale, use or other dealings
23*4882a593Smuzhiyun in this Software without prior written authorization from The Open Group.
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun                         All Rights Reserved
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun Permission to use, copy, modify, and distribute this software and its
30*4882a593Smuzhiyun documentation for any purpose and without fee is hereby granted,
31*4882a593Smuzhiyun provided that the above copyright notice appear in all copies and that
32*4882a593Smuzhiyun both that copyright notice and this permission notice appear in
33*4882a593Smuzhiyun supporting documentation, and that the name of Digital not be
34*4882a593Smuzhiyun used in advertising or publicity pertaining to distribution of the
35*4882a593Smuzhiyun software without specific, written prior permission.
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
38*4882a593Smuzhiyun ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
39*4882a593Smuzhiyun DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
40*4882a593Smuzhiyun ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
41*4882a593Smuzhiyun WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
42*4882a593Smuzhiyun ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
43*4882a593Smuzhiyun SOFTWARE.
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun ******************************************************************/
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun #ifndef PIXMAP_H
48*4882a593Smuzhiyun #define PIXMAP_H
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun #include "misc.h"
51*4882a593Smuzhiyun #include "screenint.h"
52*4882a593Smuzhiyun #include "regionstr.h"
53*4882a593Smuzhiyun #include <X11/extensions/randr.h>
54*4882a593Smuzhiyun /* types for Drawable */
55*4882a593Smuzhiyun #define DRAWABLE_WINDOW 0
56*4882a593Smuzhiyun #define DRAWABLE_PIXMAP 1
57*4882a593Smuzhiyun #define UNDRAWABLE_WINDOW 2
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun /* corresponding type masks for dixLookupDrawable() */
60*4882a593Smuzhiyun #define M_DRAWABLE_WINDOW	(1<<0)
61*4882a593Smuzhiyun #define M_DRAWABLE_PIXMAP	(1<<1)
62*4882a593Smuzhiyun #define M_UNDRAWABLE_WINDOW	(1<<2)
63*4882a593Smuzhiyun #define M_ANY			(-1)
64*4882a593Smuzhiyun #define M_WINDOW	(M_DRAWABLE_WINDOW|M_UNDRAWABLE_WINDOW)
65*4882a593Smuzhiyun #define M_DRAWABLE	(M_DRAWABLE_WINDOW|M_DRAWABLE_PIXMAP)
66*4882a593Smuzhiyun #define M_UNDRAWABLE	(M_UNDRAWABLE_WINDOW)
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun /* flags to PaintWindow() */
69*4882a593Smuzhiyun #define PW_BACKGROUND 0
70*4882a593Smuzhiyun #define PW_BORDER 1
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun #define NullPixmap ((PixmapPtr)0)
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun typedef struct _Drawable *DrawablePtr;
75*4882a593Smuzhiyun typedef struct _Pixmap *PixmapPtr;
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun typedef struct _PixmapDirtyUpdate *PixmapDirtyUpdatePtr;
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun typedef union _PixUnion {
80*4882a593Smuzhiyun     PixmapPtr pixmap;
81*4882a593Smuzhiyun     unsigned long pixel;
82*4882a593Smuzhiyun } PixUnion;
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun #define SamePixUnion(a,b,isPixel)\
85*4882a593Smuzhiyun     ((isPixel) ? (a).pixel == (b).pixel : (a).pixmap == (b).pixmap)
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun #define EqualPixUnion(as, a, bs, b)				\
88*4882a593Smuzhiyun     ((as) == (bs) && (SamePixUnion (a, b, as)))
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun #define OnScreenDrawable(type) \
91*4882a593Smuzhiyun 	(type == DRAWABLE_WINDOW)
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun #define WindowDrawable(type) \
94*4882a593Smuzhiyun 	((type == DRAWABLE_WINDOW) || (type == UNDRAWABLE_WINDOW))
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun extern _X_EXPORT PixmapPtr GetScratchPixmapHeader(ScreenPtr pScreen,
97*4882a593Smuzhiyun                                                   int width,
98*4882a593Smuzhiyun                                                   int height,
99*4882a593Smuzhiyun                                                   int depth,
100*4882a593Smuzhiyun                                                   int bitsPerPixel,
101*4882a593Smuzhiyun                                                   int devKind,
102*4882a593Smuzhiyun                                                   void *pPixData);
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun extern _X_EXPORT void FreeScratchPixmapHeader(PixmapPtr /*pPixmap */ );
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun extern _X_EXPORT Bool CreateScratchPixmapsForScreen(ScreenPtr /*pScreen */ );
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun extern _X_EXPORT void FreeScratchPixmapsForScreen(ScreenPtr /*pScreen */ );
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun extern _X_EXPORT PixmapPtr AllocatePixmap(ScreenPtr /*pScreen */ ,
111*4882a593Smuzhiyun                                           int /*pixDataSize */ );
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun extern _X_EXPORT void FreePixmap(PixmapPtr /*pPixmap */ );
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun extern _X_EXPORT PixmapPtr
116*4882a593Smuzhiyun PixmapShareToSlave(PixmapPtr pixmap, ScreenPtr slave);
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun extern _X_EXPORT void
119*4882a593Smuzhiyun PixmapUnshareSlavePixmap(PixmapPtr slave_pixmap);
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun #define HAS_DIRTYTRACKING_ROTATION 1
122*4882a593Smuzhiyun #define HAS_DIRTYTRACKING_DRAWABLE_SRC 1
123*4882a593Smuzhiyun extern _X_EXPORT Bool
124*4882a593Smuzhiyun PixmapStartDirtyTracking(DrawablePtr src,
125*4882a593Smuzhiyun                          PixmapPtr slave_dst,
126*4882a593Smuzhiyun                          int x, int y, int dst_x, int dst_y,
127*4882a593Smuzhiyun                          Rotation rotation);
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun extern _X_EXPORT Bool
130*4882a593Smuzhiyun PixmapStopDirtyTracking(DrawablePtr src, PixmapPtr slave_dst);
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun /* helper function, drivers can do this themselves if they can do it more
133*4882a593Smuzhiyun    efficently */
134*4882a593Smuzhiyun extern _X_EXPORT Bool
135*4882a593Smuzhiyun PixmapSyncDirtyHelper(PixmapDirtyUpdatePtr dirty);
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun #endif                          /* PIXMAP_H */
138