screen_destroy_pixmap()

Destroy a pixmap and frees associated resources.

Synopsis:

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

Arguments:

pix

The handle of the pixmap which is to be destroyed.

Library:

libscreen

Description:

Function Type: Flushing Execution

This function destroys the pixmap associated with the specified pixmap. Any resources and buffer created for this pixmap, whether locally or by the composition manager, will be released. The pixmap handle can no longer be used as argument in subsequent screen calls. Pixmap buffers that are not created by composition manager but are registered with screen_attach_pixmap_buffer() are not freed by this operation. The application is responsible for freeing its own external buffers.

Returns:

0 if the pixmap buffer was destroyed, or -1 if an error occurred (errno is set; refer to /usr/include/errno.h for more details). Note that the error may also have been caused by any delayed execution function that's just been flushed.