summaryrefslogtreecommitdiff
path: root/miext/damage/damage.h
blob: 0c7fc316c467d91ac7d7e2ae04434eff83c8704c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
 * Copyright © 2003 Keith Packard
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of Keith Packard not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission.  Keith Packard makes no
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
 * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#ifdef HAVE_DIX_CONFIG_H
#include <dix-config.h>
#endif

#ifndef _DAMAGE_H_
#define _DAMAGE_H_

typedef struct _damage	*DamagePtr;

typedef enum _damageReportLevel {
    DamageReportRawRegion,
    DamageReportDeltaRegion,
    DamageReportBoundingBox,
    DamageReportNonEmpty,
    DamageReportNone
} DamageReportLevel;

typedef void (*DamageReportFunc) (DamagePtr pDamage, RegionPtr pRegion, void *closure);
typedef void (*DamageDestroyFunc) (DamagePtr pDamage, void *closure);
/* It's the responsibility of the driver to duplicate both regions. */
/* At some point DamageRegionRendered() must be called. */
typedef void (*DamageMarkerFunc) (DrawablePtr pDrawable, DamagePtr pDamage, RegionPtr pOldDamage, RegionPtr pRegion, void *closure);

typedef void (*DamageScreenCreateFunc) (DamagePtr);
typedef void (*DamageScreenRegisterFunc) (DrawablePtr, DamagePtr);
typedef void (*DamageScreenUnregisterFunc) (DrawablePtr, DamagePtr);
typedef void (*DamageScreenDestroyFunc) (DamagePtr);

typedef struct _damageScreenFuncs {
    DamageScreenCreateFunc      Create;
    DamageScreenRegisterFunc    Register;
    DamageScreenUnregisterFunc  Unregister;
    DamageScreenDestroyFunc     Destroy;
} DamageScreenFuncsRec, *DamageScreenFuncsPtr;

extern _X_EXPORT void miDamageCreate (DamagePtr);
extern _X_EXPORT void miDamageRegister (DrawablePtr, DamagePtr);
extern _X_EXPORT void miDamageUnregister (DrawablePtr, DamagePtr);
extern _X_EXPORT void miDamageDestroy (DamagePtr);

extern _X_EXPORT Bool
DamageSetup (ScreenPtr pScreen);
    
extern _X_EXPORT DamagePtr
DamageCreate (DamageReportFunc  damageReport,
	      DamageDestroyFunc	damageDestroy,
	      DamageReportLevel damageLevel,
	      Bool		isInternal,
	      ScreenPtr		pScreen,
	      void *		closure);

extern _X_EXPORT void
DamageDrawInternal (ScreenPtr pScreen, Bool enable);

extern _X_EXPORT void
DamageRegister (DrawablePtr	pDrawable,
		DamagePtr	pDamage);

extern _X_EXPORT void
DamageUnregister (DrawablePtr	pDrawable,
		  DamagePtr	pDamage);

extern _X_EXPORT void
DamageDestroy (DamagePtr pDamage);

extern _X_EXPORT Bool
DamageSubtract (DamagePtr	    pDamage,
		const RegionPtr	    pRegion);

extern _X_EXPORT void
DamageEmpty (DamagePtr pDamage);

extern _X_EXPORT RegionPtr
DamageRegion (DamagePtr		    pDamage);

extern _X_EXPORT RegionPtr
DamagePendingRegion (DamagePtr	    pDamage);

/* In case of rendering, call this before the submitting the commands. */
extern _X_EXPORT void
DamageRegionAppend (DrawablePtr pDrawable, RegionPtr pRegion);

/* Call this directly after the rendering operation has been submitted. */
extern _X_EXPORT void
DamageRegionProcessPending (DrawablePtr pDrawable);

/* Call this some time after rendering is done, only relevant when a damageMarker is provided. */
extern _X_EXPORT void
DamageRegionRendered (DrawablePtr pDrawable, DamagePtr pDamage, RegionPtr pOldDamage, RegionPtr pRegion);

/* Call this when you create a new Damage and you wish to send an initial damage message (to it). */
extern _X_EXPORT void
DamageReportDamage (DamagePtr pDamage, RegionPtr pDamageRegion);

/* Avoid using this call, it only exists for API compatibility. */
extern _X_EXPORT void
DamageDamageRegion (DrawablePtr	    pDrawable,
		    const RegionPtr pRegion);

extern _X_EXPORT void
DamageSetReportAfterOp (DamagePtr pDamage, Bool reportAfter);

extern _X_EXPORT void
DamageSetPostRenderingFunctions(DamagePtr pDamage, DamageReportFunc damageReportPostRendering,
				DamageMarkerFunc damageMarker);

extern _X_EXPORT DamageScreenFuncsPtr
DamageGetScreenFuncs (ScreenPtr);

#endif /* _DAMAGE_H_ */