screen_discard_window_regions()

Discard the specified window regions.

Synopsis:

#include <screen/screen.h>
 
int screen_discard_window_regions(screen_window_t win,
                                  int count,
                                  const int *rects)

Since:

BlackBerry 10.0.0

Arguments:

win

The handle of the window in which you want to specify regions to discard.

count

The number of rectangles (retangular regions) you want to discard, specified in the rects argument. The value of count can be 0.

rects

An array of integers containing the x, y, width, and height coordinates of rectangles that bound areas in the window you want to discard. The rects argument must provide at least 4 times count integers(quadruples of x, y, width and height).

Library:

libscreen (For the qcc command, use the -l screen option to link against this library)

Description:

Function Type: Delayed Execution

This function is a hole-punching API. Use this function to specify window regions you want to discard. The regions behave as if they were transparent, or as if there were no transparency on the window. When you call this function, it invalidates any regions you might have defined previously. You can call the function with count set to 0 to remove discarded regions.

Returns:

0 if the request for discarding window regions have been queued, or -1 if an error occurred (errno is set).

Last modified: 2014-11-17



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus