gsxcnv

Purpose

     Converts pixel map data organization.

C Syntax

     int gsxcnv_ (inppix, outpix)

     int *inppix, *outpix;

FORTRAN Syntax

     INTEGER function gsxcnv (inppix, outpix)

     INTEGER inppix(*), outpix(*)

Pascal Syntax

     FUNCTION gsxcnv_ (

     VAR inppix, outpix: INTEGER
     ): INTEGER [PUBLIC|;

Description

     The gsxcnv subroutine converts pixel map data to and from
     planes.  That  is, gsxcnv  converts XY  form to  and from
     pixels, or Z form.

     See "gsxblt" for more information on data formats and the
     definition of a pixel map.

     Parameters

     inppix            Points to the address  of the pixel map
                       whose data area is to be converted.

     outpix            Points to the address  of the pixel map
                       that contains  the address of  where to
                       put the converted data.

     Both the inppix and outpix parameters contain the address
     of a  pixel map.  The  fields of  each pixel map  must be
     completely  initialized before  calling this  subroutine.
     Both pixel maps  must point to data areas  that reside in
     system memory, not in a display adapter frame buffer.

     The inppix and  outpix pixel maps do not  have to specify
     the same  number of  bits per pixel.   If there  are more
     input  bits per  pixel,  the least  significant bits  are

     truncated.  If there  are less input bits  per pixel than
     required to  fill out  the destination, the  most signif-
     icant bits are filled with zeros.

     The gsxcnv subroutine only supports pixel maps defined to
     have 8 bits  per pixel or less.  If a  pixel format pixel
     map is defined with less than  8 bits per pixel, the data
     must be  arranged 1  byte per  pixel, right  justified in
     that byte.

     The  widths and  heights of  the two  data areas  must be
     identical.

     Warning:   The  calling   process  must  allocate  enough
     storage in the area pointed to by the outpix pixel map to
     contain all of the converted data.

Return Value

     GS_SUCC   Successful.
     GS_INPF   Invalid data  format specified in  inppix pixel
               map structure.
     GS_OUTF   Invalid data  format specified in  outpix pixel
               map structure.
     GS_BMAX   Pixel map defines data of  more than 8 bits per
               pixel.

Related Information

     In this book:  "gsxblt."