From b7c80c6783695327a96e5b45506097045615eeff Mon Sep 17 00:00:00 2001 From: "Enrico Weigelt, metux IT consult" Date: Thu, 3 Jul 2025 14:41:14 +0200 Subject: [PATCH] miext: damage: document DamageScreenFuncsRec 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 --- miext/damage/damage.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/miext/damage/damage.h b/miext/damage/damage.h index 525b2db5d..b3185c18f 100644 --- a/miext/damage/damage.h +++ b/miext/damage/damage.h @@ -46,6 +46,18 @@ 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;