Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/gf/dev_guide/api/gf_context_set_planemask.html on line 1

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/gf/dev_guide/api/gf_context_set_planemask.html on line 1

Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/gf/dev_guide/api/gf_context_set_planemask.html on line 8

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/gf/dev_guide/api/gf_context_set_planemask.html on line 8

gf_context_set_planemask()

Set the current planemask

Synopsis:

#include <gf/gf.h>

void gf_context_set_planemask( gf_context_t context,
                               unsigned planemask );

Arguments:

context: The graphics context to set the planemask channel for.
planemask: A 32-bit value that is reversed and bitwise ANDed with each pixel before it's displayed.

Library:

gf

Description:

This function sets the current planemask. A planemask is a 32-bit value which represents bits in pixels that are not drawn when they are written to the display surface, allowing you to “protect” specific bits. For example, if you draw a black background (0x000000), use gf_context_set_planemask() to mask the green bits (0x00ff00), and then draw a white foreground (0xffffff), you will see magenta displayed (0xff00ff) because the green bits are protected.

The format of the planemask corresponds directly to the format of the destination surface data, so you must pay attention to the format in order to use this parameter correctly.

Classification:

QNX Graphics Framework