rlesetup(3)                        CLIX                        rlesetup(3)



  NAME

    rle_setup - Establishes parameters for an Run Length Encode (RLE) channel

  LIBRARY

    Intergraph Device Library (libix.a)

  SYNOPSIS

    #include <sys/xio/xerr.h>

    #include <sys/xio/xrle.h>

    int rle_setup(
      int channel ,
      int linewidth ,
      int swathsize ,
      int top ,
      int left ,
      int igr ,
      int format );

  DESCRIPTION

    The rle_setup() function establishes parameters for the specified Run
    Length Encoding (RLE) channel.  The specified channel must have been
    opened with rle_open().  Possible values for linewidth are 32, 64, 128,
    256, 512, and 1024.  The swathsize parameter represents the number of
    lines per swath.  The top represents the size of the top margin to be
    skipped.  The left parameter represents the size of the left margin to be
    skipped.

    The igr parameter is the value to be placed in the IGR field of each
    scanline header; a value of -1 indicates that no scanline headers are to
    be produced.

    The format parameter determines which mode the RLE will operate in.
    Possible modes are defined in <sys/xio/xrle.h> and described below.

    RLE_BW_RLE
           Black and white RLE

    RLE_EKTRON_RLE
           Ektron format RLE

    RLE_COLOR_RLE
           Color RLE

    RLE_PASSTHRU1
           Single component; no compression



  2/94 - Intergraph Corporation                                              1

  rlesetup(3)                        CLIX                        rlesetup(3)



    RLE_PASSTHRU3
           All components; no compression

    RLE_REVERSE_BW_RLE
           Reverse black and white RLE

    RLE_REVERSE_EKTRON_RLE
           Reverse Ektron format RLE

    RLE_REVERSE_COLOR_RLE
           Reverse color RLE

    RLE_REVERSE_PASSTHRU1
           Reverse single component; no compression

    RLE_REVERSE_PASSTHRU3
           Reverse all components; no compression

  RETURN VALUES

    Upon successful completion, a value of 0 is returned.  Otherwise, one of
    the following failure codes is returned.

  ERRORS

    The rle_setup() function will fail if one of the following is true:

    [XIO_FAILURE]
           The system does not contain the driver needed to support this
           request.

    [RLE_CHANNEL_INVALID]
           The specified channel is beyond the maximum allowed.

    [RLE_CHANNEL_NOT_OPEN]
           The specified channel is not open for this process.

    [RLE_INVALID_PARMS]
           An invalid value was passed for a parameter.

  RELATED INFORMATION

    Functions:  rle_open(3)

    Files:  xrle(7)









  2                                              Intergraph Corporation - 2/94