mirror of
https://github.com/X11Libre/xserver.git
synced 2026-03-26 23:25:08 +00:00
bab9362335
This struct (and associated functions) needs to be part of public driver ABI, so video drivers can get notifications on damage certain operations, but there hasn't been any documentation on it. Signed-off-by: Enrico Weigelt, metux IT consult <info@metux.net>
128 lines
4.4 KiB
C
128 lines
4.4 KiB
C
/*
|
|
* 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);
|
|
|
|
typedef void (*DamageScreenCreateFunc) (DamagePtr);
|
|
typedef void (*DamageScreenRegisterFunc) (DrawablePtr, DamagePtr);
|
|
typedef void (*DamageScreenUnregisterFunc) (DrawablePtr, DamagePtr);
|
|
typedef void (*DamageScreenDestroyFunc) (DamagePtr);
|
|
|
|
/* @public
|
|
*
|
|
* @brief Driver callbacks for getting notified on several damage calls
|
|
*
|
|
* The pointer to this struct can be obtained via DamageGetScreenFuncs().
|
|
* Drivers can inject themselves here, in order to get notified on
|
|
* DamageCreate(), DamageRegister(), DamageUnregister(), DamageDestroy().
|
|
*
|
|
* This should ONLY be touched by video drivers, nobody else.
|
|
*
|
|
* So far the only one using it is the proprietary NVidia driver.
|
|
*/
|
|
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(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 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 DamageScreenFuncsPtr DamageGetScreenFuncs(ScreenPtr);
|
|
|
|
#endif /* _DAMAGE_H_ */
|