screen_destroy_pixmap()

Destroy a pixmap and free associated resources

Function type:

Flushing execution

Synopsis:

#include <screen/screen.h>

int screen_destroy_pixmap( screen_pixmap_t pix );

Arguments:

pix
The handle of the pixmap that should be destroyed. This should have been created with screen_create_pixmap().

Library:

screen

Description:

This function destroys the pixmap associated with the pixmap handle. Any resources and buffer created for this pixmap, both locally, and 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:

If the function succeeds, it returns 0 and the pixmap is destroyed. Otherwise, the function returns -1 and errno is set.

Classification:

Windowing API

Safety  Value  
Interrupt handler No
Signal handler No
Thread Yes