From b61647f3a10d0b12004b28ef98525614c869e61a Mon Sep 17 00:00:00 2001 From: "Enrico Weigelt, metux IT consult" Date: Fri, 4 Oct 2024 12:51:11 +0200 Subject: [PATCH] dix: add in-code docs for dixDestroyPixmap() Give some more explaination for the dixDestroyPixmap() function. Signed-off-by: Enrico Weigelt, metux IT consult Part-of: --- include/dix.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/include/dix.h b/include/dix.h index 33db66b05..49d50e603 100644 --- a/include/dix.h +++ b/include/dix.h @@ -148,8 +148,20 @@ extern _X_EXPORT void UpdateCurrentTime(void); extern _X_EXPORT void UpdateCurrentTimeIf(void); -extern _X_EXPORT int dixDestroyPixmap(void *value, - XID pid); +/* + * @brief dereference a pixmap and destroy it when not used anymore + * + * Despite the name, this function unref's the pixmap, and only destroys it when + * the pixmap isn't used anymore. (perhaps it should be renamed to dixUnrefPixmap()) + * + * Note: it's also used as resource destructor callback, hence that strange args. + * (not actually finest art, but for now a good compromise, since it's already + * existing and exported, thus can easily be used by drivers, w/o breaking compat) + * + * @param pPixmap pointer to pixmap (PixmapPtr) that should be unref'ed + * @param unused ignored, only for matching the resource destructor prototype + */ +_X_EXPORT int dixDestroyPixmap(void *pPixmap, XID unused); extern _X_EXPORT ClientPtr NextAvailableClient(void *ospriv);