Vizard 8 » Command Index » Vizard objects » window » <window>.setClearMask
8.0

<window>.setClearMask

Set the clear mask for the subwindow

<window>.setClearMask(  
mask  
mode = viz.MASK_SET  
)  
mask
A combination of the following bit flags:

Clear masks

viz.GL_COLOR_BUFFER_BIT

The color buffer

viz.GL_DEPTH_BUFFER_BIT

The depth buffer

viz.GL_STENCIL_BUFFER_BIT

The stencil buffer

mode = viz.MASK_SET
Mode for specifying how to apply the mask. Can be one of the following:

Mask modes

viz.MASK_SET

Set the mask to the new value.

viz.MASK_ADD

Add the value to the existing mask.

viz.MASK_REMOVE

Remove the value from the existing mask.

viz.MASK_TOGGLE

Toggle the value with the existing mask.

Remarks

The clear mask controls which OpenGL bits are cleared before the subwindow begins rendering.

The default value is (viz.GL_COLOR_BUFFER_BIT | viz.GL_DEPTH_BUFFER_BIT)

Note: You can specify the default value using the 'viz.clearMask' option in the vizcore.cfg file.

Return Value

None

See also

<window>.getClearMask