xref: /OK3568_Linux_fs/external/xserver/miext/damage/damage.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright © 2003 Keith Packard
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Permission to use, copy, modify, distribute, and sell this software and its
5*4882a593Smuzhiyun  * documentation for any purpose is hereby granted without fee, provided that
6*4882a593Smuzhiyun  * the above copyright notice appear in all copies and that both that
7*4882a593Smuzhiyun  * copyright notice and this permission notice appear in supporting
8*4882a593Smuzhiyun  * documentation, and that the name of Keith Packard not be used in
9*4882a593Smuzhiyun  * advertising or publicity pertaining to distribution of the software without
10*4882a593Smuzhiyun  * specific, written prior permission.  Keith Packard makes no
11*4882a593Smuzhiyun  * representations about the suitability of this software for any purpose.  It
12*4882a593Smuzhiyun  * is provided "as is" without express or implied warranty.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15*4882a593Smuzhiyun  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16*4882a593Smuzhiyun  * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17*4882a593Smuzhiyun  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18*4882a593Smuzhiyun  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19*4882a593Smuzhiyun  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
20*4882a593Smuzhiyun  * PERFORMANCE OF THIS SOFTWARE.
21*4882a593Smuzhiyun  */
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #ifdef HAVE_DIX_CONFIG_H
24*4882a593Smuzhiyun #include <dix-config.h>
25*4882a593Smuzhiyun #endif
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #ifndef _DAMAGE_H_
28*4882a593Smuzhiyun #define _DAMAGE_H_
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun typedef struct _damage *DamagePtr;
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun typedef enum _damageReportLevel {
33*4882a593Smuzhiyun     DamageReportRawRegion,
34*4882a593Smuzhiyun     DamageReportDeltaRegion,
35*4882a593Smuzhiyun     DamageReportBoundingBox,
36*4882a593Smuzhiyun     DamageReportNonEmpty,
37*4882a593Smuzhiyun     DamageReportNone
38*4882a593Smuzhiyun } DamageReportLevel;
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun typedef void (*DamageReportFunc) (DamagePtr pDamage, RegionPtr pRegion,
41*4882a593Smuzhiyun                                   void *closure);
42*4882a593Smuzhiyun typedef void (*DamageDestroyFunc) (DamagePtr pDamage, void *closure);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun typedef void (*DamageScreenCreateFunc) (DamagePtr);
45*4882a593Smuzhiyun typedef void (*DamageScreenRegisterFunc) (DrawablePtr, DamagePtr);
46*4882a593Smuzhiyun typedef void (*DamageScreenUnregisterFunc) (DrawablePtr, DamagePtr);
47*4882a593Smuzhiyun typedef void (*DamageScreenDestroyFunc) (DamagePtr);
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun typedef struct _damageScreenFuncs {
50*4882a593Smuzhiyun     DamageScreenCreateFunc Create;
51*4882a593Smuzhiyun     DamageScreenRegisterFunc Register;
52*4882a593Smuzhiyun     DamageScreenUnregisterFunc Unregister;
53*4882a593Smuzhiyun     DamageScreenDestroyFunc Destroy;
54*4882a593Smuzhiyun } DamageScreenFuncsRec, *DamageScreenFuncsPtr;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun extern _X_EXPORT void miDamageCreate(DamagePtr);
57*4882a593Smuzhiyun extern _X_EXPORT void miDamageRegister(DrawablePtr, DamagePtr);
58*4882a593Smuzhiyun extern _X_EXPORT void miDamageUnregister(DrawablePtr, DamagePtr);
59*4882a593Smuzhiyun extern _X_EXPORT void miDamageDestroy(DamagePtr);
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun extern _X_EXPORT Bool
62*4882a593Smuzhiyun  DamageSetup(ScreenPtr pScreen);
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun extern _X_EXPORT DamagePtr
65*4882a593Smuzhiyun DamageCreate(DamageReportFunc damageReport,
66*4882a593Smuzhiyun              DamageDestroyFunc damageDestroy,
67*4882a593Smuzhiyun              DamageReportLevel damageLevel,
68*4882a593Smuzhiyun              Bool isInternal, ScreenPtr pScreen, void *closure);
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun extern _X_EXPORT void
71*4882a593Smuzhiyun  DamageDrawInternal(ScreenPtr pScreen, Bool enable);
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun extern _X_EXPORT void
74*4882a593Smuzhiyun  DamageRegister(DrawablePtr pDrawable, DamagePtr pDamage);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun extern _X_EXPORT void
77*4882a593Smuzhiyun  DamageUnregister(DamagePtr pDamage);
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun extern _X_EXPORT void
80*4882a593Smuzhiyun  DamageDestroy(DamagePtr pDamage);
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun extern _X_EXPORT Bool
83*4882a593Smuzhiyun  DamageSubtract(DamagePtr pDamage, const RegionPtr pRegion);
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun extern _X_EXPORT void
86*4882a593Smuzhiyun  DamageEmpty(DamagePtr pDamage);
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun extern _X_EXPORT RegionPtr
89*4882a593Smuzhiyun  DamageRegion(DamagePtr pDamage);
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun extern _X_EXPORT RegionPtr
92*4882a593Smuzhiyun  DamagePendingRegion(DamagePtr pDamage);
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun /* In case of rendering, call this before the submitting the commands. */
95*4882a593Smuzhiyun extern _X_EXPORT void
96*4882a593Smuzhiyun  DamageRegionAppend(DrawablePtr pDrawable, RegionPtr pRegion);
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun /* Call this directly after the rendering operation has been submitted. */
99*4882a593Smuzhiyun extern _X_EXPORT void
100*4882a593Smuzhiyun  DamageRegionProcessPending(DrawablePtr pDrawable);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun /* Call this when you create a new Damage and you wish to send an initial damage message (to it). */
103*4882a593Smuzhiyun extern _X_EXPORT void
104*4882a593Smuzhiyun  DamageReportDamage(DamagePtr pDamage, RegionPtr pDamageRegion);
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun /* Avoid using this call, it only exists for API compatibility. */
107*4882a593Smuzhiyun extern _X_EXPORT void
108*4882a593Smuzhiyun  DamageDamageRegion(DrawablePtr pDrawable, const RegionPtr pRegion);
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun extern _X_EXPORT void
111*4882a593Smuzhiyun  DamageSetReportAfterOp(DamagePtr pDamage, Bool reportAfter);
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun extern _X_EXPORT DamageScreenFuncsPtr DamageGetScreenFuncs(ScreenPtr);
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun #endif                          /* _DAMAGE_H_ */
116