screen_destroy_pixmap()

Destroy a pixmap and free 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 specified pixmap. Any resources and buffer created for this pixmap, whether locally or by Screen, is released. The pixmap handle can no longer be used as argument in subsequent Screen API calls.Pixmap buffers that aren't created by Screen, but are registered with screen_attach_pixmap_buffer() aren't freed by this operation. The application is responsible for freeing its own external buffers.

Returns:

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