4c221b0da1816acf2ca302b10092df059484468dvboxsync/*
4c221b0da1816acf2ca302b10092df059484468dvboxsync * Copyright © 2003 Keith Packard
4c221b0da1816acf2ca302b10092df059484468dvboxsync *
4c221b0da1816acf2ca302b10092df059484468dvboxsync * Permission to use, copy, modify, distribute, and sell this software and its
4c221b0da1816acf2ca302b10092df059484468dvboxsync * documentation for any purpose is hereby granted without fee, provided that
4c221b0da1816acf2ca302b10092df059484468dvboxsync * the above copyright notice appear in all copies and that both that
4c221b0da1816acf2ca302b10092df059484468dvboxsync * copyright notice and this permission notice appear in supporting
4c221b0da1816acf2ca302b10092df059484468dvboxsync * documentation, and that the name of Keith Packard not be used in
4c221b0da1816acf2ca302b10092df059484468dvboxsync * advertising or publicity pertaining to distribution of the software without
4c221b0da1816acf2ca302b10092df059484468dvboxsync * specific, written prior permission. Keith Packard makes no
4c221b0da1816acf2ca302b10092df059484468dvboxsync * representations about the suitability of this software for any purpose. It
4c221b0da1816acf2ca302b10092df059484468dvboxsync * is provided "as is" without express or implied warranty.
4c221b0da1816acf2ca302b10092df059484468dvboxsync *
4c221b0da1816acf2ca302b10092df059484468dvboxsync * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
4c221b0da1816acf2ca302b10092df059484468dvboxsync * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
4c221b0da1816acf2ca302b10092df059484468dvboxsync * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
4c221b0da1816acf2ca302b10092df059484468dvboxsync * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
4c221b0da1816acf2ca302b10092df059484468dvboxsync * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
4c221b0da1816acf2ca302b10092df059484468dvboxsync * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4c221b0da1816acf2ca302b10092df059484468dvboxsync * PERFORMANCE OF THIS SOFTWARE.
4c221b0da1816acf2ca302b10092df059484468dvboxsync */
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync#ifdef HAVE_DIX_CONFIG_H
4c221b0da1816acf2ca302b10092df059484468dvboxsync#include <dix-config.h>
4c221b0da1816acf2ca302b10092df059484468dvboxsync#endif
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync#ifndef _DAMAGE_H_
4c221b0da1816acf2ca302b10092df059484468dvboxsync#define _DAMAGE_H_
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef struct _damage *DamagePtr;
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef enum _damageReportLevel {
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageReportRawRegion,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageReportDeltaRegion,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageReportBoundingBox,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageReportNonEmpty,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageReportNone
4c221b0da1816acf2ca302b10092df059484468dvboxsync} DamageReportLevel;
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageReportFunc) (DamagePtr pDamage, RegionPtr pRegion, void *closure);
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageDestroyFunc) (DamagePtr pDamage, void *closure);
4c221b0da1816acf2ca302b10092df059484468dvboxsync/* It's the responsibility of the driver to duplicate both regions. */
4c221b0da1816acf2ca302b10092df059484468dvboxsync/* At some point DamageRegionRendered() must be called. */
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageMarkerFunc) (DrawablePtr pDrawable, DamagePtr pDamage, RegionPtr pOldDamage, RegionPtr pRegion, void *closure);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageScreenCreateFunc) (DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageScreenRegisterFunc) (DrawablePtr, DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageScreenUnregisterFunc) (DrawablePtr, DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef void (*DamageScreenDestroyFunc) (DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsynctypedef struct _damageScreenFuncs {
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageScreenCreateFunc Create;
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageScreenRegisterFunc Register;
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageScreenUnregisterFunc Unregister;
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageScreenDestroyFunc Destroy;
4c221b0da1816acf2ca302b10092df059484468dvboxsync} DamageScreenFuncsRec, *DamageScreenFuncsPtr;
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void miDamageCreate (DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void miDamageRegister (DrawablePtr, DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void miDamageUnregister (DrawablePtr, DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void miDamageDestroy (DamagePtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT Bool
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageSetup (ScreenPtr pScreen);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT DamagePtr
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageCreate (DamageReportFunc damageReport,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageDestroyFunc damageDestroy,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageReportLevel damageLevel,
4c221b0da1816acf2ca302b10092df059484468dvboxsync Bool isInternal,
4c221b0da1816acf2ca302b10092df059484468dvboxsync ScreenPtr pScreen,
4c221b0da1816acf2ca302b10092df059484468dvboxsync void * closure);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageDrawInternal (ScreenPtr pScreen, Bool enable);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageRegister (DrawablePtr pDrawable,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamagePtr pDamage);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageUnregister (DrawablePtr pDrawable,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamagePtr pDamage);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageDestroy (DamagePtr pDamage);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT Bool
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageSubtract (DamagePtr pDamage,
4c221b0da1816acf2ca302b10092df059484468dvboxsync const RegionPtr pRegion);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageEmpty (DamagePtr pDamage);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT RegionPtr
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageRegion (DamagePtr pDamage);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT RegionPtr
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamagePendingRegion (DamagePtr pDamage);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync/* In case of rendering, call this before the submitting the commands. */
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageRegionAppend (DrawablePtr pDrawable, RegionPtr pRegion);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync/* Call this directly after the rendering operation has been submitted. */
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageRegionProcessPending (DrawablePtr pDrawable);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync/* Call this some time after rendering is done, only relevant when a damageMarker is provided. */
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageRegionRendered (DrawablePtr pDrawable, DamagePtr pDamage, RegionPtr pOldDamage, RegionPtr pRegion);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync/* Avoid using this call, it only exists for API compatibility. */
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageDamageRegion (DrawablePtr pDrawable,
4c221b0da1816acf2ca302b10092df059484468dvboxsync const RegionPtr pRegion);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageSetReportAfterOp (DamagePtr pDamage, Bool reportAfter);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT void
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageSetPostRenderingFunctions(DamagePtr pDamage, DamageReportFunc damageReportPostRendering,
4c221b0da1816acf2ca302b10092df059484468dvboxsync DamageMarkerFunc damageMarker);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsyncextern _X_EXPORT DamageScreenFuncsPtr
4c221b0da1816acf2ca302b10092df059484468dvboxsyncDamageGetScreenFuncs (ScreenPtr);
4c221b0da1816acf2ca302b10092df059484468dvboxsync
4c221b0da1816acf2ca302b10092df059484468dvboxsync#endif /* _DAMAGE_H_ */