screen_unref_pixmap()

Updated: October 26, 2022

Remove a reference from a specified pixmap

Synopsis:

#include <screen/screen.h>
int screen_unref_pixmap(screen_pixmap_t pix)

Arguments:

pix
The handle of the pixmap for which the reference is to be removed.

Library:

libscreen

Description:

Function Type: Immediate Execution

This function removes a reference to a pixmap. If the pixmap and its buffer haven't been destroyed yet, the effect of screen_unref_pixmap() is simply to decrease a reference count. If the pixmap or the pixmap buffer was destroyed while still being referenced, screen_unref_pixmap() will cause the pixmap and/or its buffer to be destroyed when the reference count reaches zero.

Returns:

0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).