Name
SetMaskMode -- define rendering mode for masks (V2.0)
Synopsis
SetMaskMode(mode)
Library
offscreen

Function
This function can be used to define the rendering mode when SelectMask() is active. The argument mode can either be #MASKVISIBLE or #MASKINVISIBLE. The default is #MASKVISIBLE. If you select the visible mode, all graphics commands will draw visible pixels into the mask, otherwise invisible pixels will be drawn. Obviously, a mask does not carry any color information but only those two flags per pixel (visible or invisible).

As of Hollywood 4.0, the following new mask modes are supported:

#MASKVANILLACOPY:
Masking data of the source image will be copied exactly to the destination.

#MASKAND:
Masking data of the source image will be copied to the destination mask using a logical AND operation on each pixel.

#MASKOR:
Masking data of the source image will be copied to the destination mask using a logical OR operation on each pixel.

#MASKXOR:
Masking data of the source image will be copied to the destination mask using a logical XOR operation on each pixel.

Below is a table summing up the different mask modes. Please note that the mask mode #MASKVISIBLE, #MASKINVISIBLE, and #MASKVANILLACOPY are independent of the destination mask data. Destination mask data is only taken into account by the #MASKAND, #MASKOR, and #MASKXOR modes.

See SelectMask for more information on mask rendering.

Inputs
mode
mask rendering mode (see above)
Example
See SelectMask


Show TOC