Museum

msmask(3G)                                                          msmask(3G)



NAME
     msmask - specifies a multisample mask

C SPECIFICATION
     void msmask(float mask, Boolean inverse)

PARAMETERS
     mask      is a value between 0 and 1 inclusive, indicating what fraction
               of the multisamples at each pixel are to be updated.  The
               default is 1.

     inverse   specifies whether an inverse mask should be created.

DESCRIPTION
     Just as the polygon pattern specifies a subset of pixels that can be
     written in a window, msmask specifies a subset of multisample locations
     that can be written at each pixel.  Unlike polygon pattern, which
     specifies exactly which pixels can and cannot be written, however, msmask
     specifies only the ratio of writable and unwritable sample locations at
     each pixel.  Values between 0 and 1 inclusive indicate the fraction of
     multisample locations that can be written, with the default value of 1
     indicating that all sample locations can be written, and 0 indicating
     that no sample locations can be written.  Only the ratio is guaranteed -
     the enabled sample locations may vary from pixel to pixel.

     Setting inverse will generate the inverse mask.  For example,

          msmask(0.75, FALSE)

     will generate a mask that allows 75% of the samples to be written, and

          msmask(0.75, TRUE)

     will generate a mask that allows the other 25% of the samples to be
     written.

     msmask has no effect when multisample is not enabled.

SEE ALSO
     msalpha, mspattern, mssize, multisample

NOTE
     IRIS-4D G, GT, GTX, VGX, and VGXT models, the Personal Iris, Indigo
     Entry, Indy, XL, XS, XS24, XZ, Elan and Extreme systems do not support
     msmask.










                                                                        Page 1