I386LINUX/util/I386LINUX/man/man3/TIFFswab.3t

   1 .\" $Header: /CVS_DB/Eos/util/I386LINUX/man/man3/TIFFswab.3t,v 1.1.1.1 2002/02/01 06:40:35 tacyas Exp $
   2 .\"
   3 .\" Copyright (c) 1988-1997 Sam Leffler
   4 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   5 .\"
   6 .\" Permission to use, copy, modify, distribute, and sell this software and
   7 .\" its documentation for any purpose is hereby granted without fee, provided
   8 .\" that (i) the above copyright notices and this permission notice appear in
   9 .\" all copies of the software and related documentation, and (ii) the names of
  10 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  11 .\" publicity relating to the software without the specific, prior written
  12 .\" permission of Sam Leffler and Silicon Graphics.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  16 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  17 .\"
  18 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  19 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  20 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  22 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  23 .\" OF THIS SOFTWARE.
  24 .\"
  25 .if n .po 0
  26 .TH SWAB 3T "December 16, 1991"
  27 .SH NAME
  28 TIFFReverseBits, TIFFSwabShort, TIFFSwabLong, TIFFSwabArrayOfShort, TIFFSwabArrayOfLong \- byte- and bit-swapping routines
  29 .SH SYNOPSIS
  30 .B "#include <tiffio.h>"
  31 .br
  32 .B "const unsigned char* TIFFGetBitRevTable(int reversed);"
  33 .br
  34 .B "void TIFFReverseBits(u_char* data, unsigned long nbytes)"
  35 .br
  36 .B "void TIFFSwabShort(uint16* data)"
  37 .br
  38 .B "void TIFFSwabLong(uint32* data)"
  39 .br
  40 .B "void TIFFSwabArrayOfShort(uint16* data, unsigned long nshorts)"
  41 .br
  42 .B "void TIFFSwabArrayOfLong(uint32* data, unsigned long nlongs)"
  43 .SH DESCRIPTION
  44 The following routines are used by the library to swap
  45 16- and 32-bit data and to reverse the order of bits in bytes.
  46 .PP
  47 .IR TIFFSwabShort
  48 and
  49 .IR TIFFSwabLong
  50 swap the bytes in a single 16-bit and 32-bit item, respectively.
  51 .IR TIFFSwabArrayOfShort
  52 and
  53 .IR TIFFSwabArrayOfLong
  54 swap the bytes in an array of 16-bit and 32-bit items, respectively.
  55 .PP
  56 .IR TIFFReverseBits
  57 replaces each byte in
  58 .I data
  59 with the equivalent bit-reversed value.
  60 This operation is done with a lookup table,
  61 .I TIFFBitRevTable
  62 which is declared public.
  63 A second table,
  64 .I TIFFNoBitRevTable
  65 is also declared public; it is a lookup table that
  66 can be used as an
  67 .IR "identity function" ;
  68 i.e.
  69 .IR "TIFFNoBitRevTable[n] == n" .
  70 .SH DIAGNOSTICS
  71 None.
  72 .SH "SEE ALSO"
  73 .IR libtiff (3T),