GPR_$ALLOCATE_BITMAP              GPR Calls               GPR_$ALLOCATE_BITMAP


NAME
     gpr_$allocate_bitmap - allocates a bitmap in main memory.

FORMAT
     gpr_$allocate_bitmap (size, hi_plane_id, attrib_block_desc, bitmap_desc,
                           status)

DESCRIPTION
     This routine allocates a bitmap in main memory and returns a bitmap
     descriptor.

   Input Parameters
     size Bitmap width and height, in gpr_$offset_t format.  Possible values
          for width and height are 1 - 8192.  This data type is four bytes
          long. See the GPR Data Types section for more information.

     hi_plane_id
          Identifier of the highest plane which the bitmap will use, in
          gpr_$rgb_plane_t format.  This is a 2-byte integer.  Valid values
          are 0 - 31.

     attrib_block_desc
          Descriptor of the attribute block which the bitmap will use, in
          gpr_$attribute_desc_t format.  This is a 4-byte integer.

   Output Parameters
     bitmap_desc
          Descriptor of the allocated bitmap, in gpr_$bitmap_desc_t format.
          This is a 4-byte integer.

     status
          Completion status, in status_$t format. This data type is 4 bytes
          long. See the GPR Data Types section for more information.

SEE ALSO
     gpr_$set_bitmap, gpr_$deallocate_bitmap.

NOTES
     To establish an allocated bitmap as the current bitmap, use
     gpr_$set_bitmap.

     To deallocate a bitmap, use gpr_$deallocate_bitmap.  A program cannot use
     a bitmap after it is deallocated.