GPR_$ALLOCATE_HDM_BITMAP          GPR Calls           GPR_$ALLOCATE_HDM_BITMAP


NAME
     gpr_$allocate_hdm_bitmap - allocates a bitmap in hidden display memory.

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

DESCRIPTION
     This routine allocates a bitmap in hidden display memory.
     gpr_$allocate_hdm_bitmap allocates a bitmap in hidden display memory for
     programs running in a borrow or direct mode.  You cannot allocate a hid-
     den display memory bitmap if your program is running in frame mode.

   Input Parameters
     size The width and height of the bitmap, in gpr_$offset_t format.  This
          data type is 4 bytes long.  The maximum size allowed for hidden
          display memory bitmaps is 224 bits by 224 bits.

     hi_plane_id
          The identifier of the highest plane of the bitmap, in gpr_$plane_t
          format.  This is a 2-byte integer.

     attrib_block_desc
          The descriptor of the bitmap's attribute block, in
          gpr_$attribute_desc_t format.  This is a 4-byte integer.

   Output Parameters
     bitmap_desc
          The descriptor of the bitmap in hidden display memory, in
          gpr_$bitmap_desc_t format.  This is a 4-byte integer.

     status
          Completion status, in status_$t format.

SEE ALSO
     gpr_$acquire_display, gpr_$deallocate_bitmap.

NOTES
     In direct mode you must acquire the display before calling
     gpr_$allocate_hdm_bitmap.  You acquire the display with the
     gpr_$acquire_display routine.

     Use gpr_$deallocate_bitmap to deallocate a hidden display memory bitmap.