frederik
/
xserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

dix: add in-code docs for dixDestroyPixmap() 

Give some more explaination for the dixDestroyPixmap() function.

Signed-off-by: Enrico Weigelt, metux IT consult <info@metux.net>
Part-of: <https://gitlab.freedesktop.org/xorg/xserver/-/merge_requests/1711>
This commit is contained in:
Enrico Weigelt, metux IT consult 2024-10-04 12:51:11 +02:00
parent ee798cf212
commit b61647f3a1
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/dix.h
View File

@ -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);