<window>.setCullMask

Vizard 8 » Command Index » Vizard objects » window » <window>.setCullMask

8.1

<window>.setCullMask

Set the window cull mask

<window>.setCullMask(
mask
eye = viz.BOTH_EYE
mode = viz.MASK_SET
)

mask

The cull mask

eye = viz.BOTH_EYE

Controls which eye the cull mask will be used with. Can be one of the following:

Eye values
viz.BOTH_EYE	The cull mask will be used when rendering in non-stereo mode.
viz.LEFT_EYE	The cull mask will be used when rendering the left eye in stereo mode.
viz.RIGHT_EYE	The cull mask will be used when rendering the right eye in stereo mode.

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 cull mask is used to control which nodes will be rendered by the window. When creating a custom cull mask, use the <viz>.addNodeMask command to ensure that your cull mask does not conflict with any masks used internally by Vizard.

Return Value

None