Museum

GMF_$RESTORE_PLANE                Domain/OS                 GMF_$RESTORE_PLANE


NAME
     gmf_$restore_plane - restore a bitmap from a GMF

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/gmf.h>

     void gmf_$restore_plane(
          ios_$id_t &stream_id,
          short &x_dimension,
          short &y_dimension,
          short &wpl,
          short *&plane_ptr,
          short *bpi,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/gmf.ins.pas';

     procedure gmf_$restore_plane(
          in stream_id: ios_$id_t;
          in x_dimension: integer
          in y_dimension: integer;
          in wpl: integer;
          in plane_ptr: univ_ptr;
          out bpi: integer;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/gmf.ins.ftn'

           integer*4 status
           integer*2 stream_id, bpi, x_dimension, y_dimension
           integer*2 wpl, bits(65535)

           integer*4 plane_ptr
           pointer /plane_ptr/ bits

           call gmf_$restore_plane(stream_id, x_dimension, y_dimension,
          &                        wpl, plane_ptr, bpi, status)

DESCRIPTION
     Gmf_$restore_plane restores a bitmap from the GMF open on stream_id.

     The display must be in "borrow mode" when gmf_$restore_plane is called.

     stream_id
          The stream ID of the GMF to restore the bitmap from.

     x_dimension
          The width of the bitmap, or the number of bits in the x-dimension,
          to be restored from the GMF.

     y_dimension
          The height of the bitmap, or the number of bits in the y-dimension,
          to be restored from the GMF.

     wpl  The number of 16-bit words per scan line in the destination display.

     plane_ptr
          A pointer to where the bitmap should be restored.  The value of
          plane_ptr is the address of the upper left corner of the restored
          bitmap.

     bpi  The number of bits per inch in the restored image.  If bpi is
          nonzero, the restored bitmap represents the actual size of the image
          stored in the GMF.  If bpi is 0, the restored bitmap is a one-for-
          one bit copy of the bitmap copied to the GMF, which may not
          represent the actual size of the image that was saved in the GMF.

     status
          The completion status.

NOTES
     In order for your application to run correctly on all Apollo displays,
     the application should call gpr_$enable_direct_access before calling
     gmf_$copy_plane,  gmf_$copy_subplane or gmf_$restore_plane.