gpr_set_plane_mask_32() — Apollo Domain/OS SR10.3.5

GPR_$SET_PLANE_MASK_32            GPR Calls             GPR_$SET_PLANE_MASK_32


NAME
     gpr_$set_plane_mask_32 - establishes a 32-bit plane mask for subsequent
     write operations.

FORMAT
     gpr_$set_plane_mask_32 (mask, status)

DESCRIPTION
     This routine establishes a 32-bit plane mask for subsequent write opera-
     tions.

     This call is identical to the gpr_$set_plane_mask call except that
     gpr_$set_plane_mask_32 establishes a 32-bit mask instead of a 16-bit
     mask.  We recommend that you use gpr_$set_plane_mask_32 instead of
     gpr_$set_plane_mask since we may obsolete gpr_$set_plane_mask.  The
     default mask specifies that all planes are used.

     Operations occur only on the planes specified in the mask.  A program can
     use this routine, for example, to perform raster operations on separate
     planes or groups of planes in the bitmap.

     Using the mask, a program can partition an 8-bit pixel into subunits.
     For example, the program can use planes 0 - 3 for one picture and planes
     4 - 7 for another.  Thus, one bitmap may contain two color pictures.
     This does not, however, increase the number of colors available for one
     bitmap.

   Input Parameters
     mask The plane mask, which specifies which planes to use, in
          gpr_$mask_32_t format.  This is a four-byte integer.

   Output Parameters
     status
          Completion status, in status_$t format.

SEE ALSO
     gpr_$set_plane_mask.
Museum
