summaryrefslogtreecommitdiff
path: root/man/TIFFswab.3t
diff options
context:
space:
mode:
Diffstat (limited to 'man/TIFFswab.3t')
-rw-r--r--man/TIFFswab.3t73
1 files changed, 73 insertions, 0 deletions
diff --git a/man/TIFFswab.3t b/man/TIFFswab.3t
new file mode 100644
index 00000000..dfb8d56a
--- /dev/null
+++ b/man/TIFFswab.3t
@@ -0,0 +1,73 @@
+.\" $Header: /usr/people/sam/tiff/man/RCS/TIFFswab.3t,v 1.10 1995/10/11 19:45:29 sam Exp $
+.\"
+.\" Copyright (c) 1988-1995 Sam Leffler
+.\" Copyright (c) 1991-1995 Silicon Graphics, Inc.
+.\"
+.\" Permission to use, copy, modify, distribute, and sell this software and
+.\" its documentation for any purpose is hereby granted without fee, provided
+.\" that (i) the above copyright notices and this permission notice appear in
+.\" all copies of the software and related documentation, and (ii) the names of
+.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
+.\" publicity relating to the software without the specific, prior written
+.\" permission of Sam Leffler and Silicon Graphics.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
+.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
+.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
+.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
+.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
+.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+.\" OF THIS SOFTWARE.
+.\"
+.if n .po 0
+.TH SWAB 3T "December 16, 1991"
+.SH NAME
+TIFFReverseBits, TIFFSwabShort, TIFFSwabLong, TIFFSwabArrayOfShort, TIFFSwabArrayOfLong \- byte- and bit-swapping routines
+.SH SYNOPSIS
+.B "#include <tiffio.h>"
+.br
+.B "const unsigned char* TIFFGetBitRevTable(int reversed);"
+.br
+.B "void TIFFReverseBits(u_char* data, unsigned long nbytes)"
+.br
+.B "void TIFFSwabShort(uint16* data)"
+.br
+.B "void TIFFSwabLong(uint32* data)"
+.br
+.B "void TIFFSwabArrayOfShort(uint16* data, unsigned long nshorts)"
+.br
+.B "void TIFFSwabArrayOfLong(uint32* data, unsigned long nlongs)"
+.SH DESCRIPTION
+The following routines are used by the library to swap
+16- and 32-bit data and to reverse the order of bits in bytes.
+.PP
+.IR TIFFSwabShort
+and
+.IR TIFFSwabLong
+swap the bytes in a single 16-bit and 32-bit item, respectively.
+.IR TIFFSwabArrayOfShort
+and
+.IR TIFFSwabArrayOfLong
+swap the bytes in an array of 16-bit and 32-bit items, respectively.
+.PP
+.IR TIFFReverseBits
+replaces each byte in
+.I data
+with the equivalent bit-reversed value.
+This operation is done with a lookup table,
+.I TIFFBitRevTable
+which is declared public.
+A second table,
+.I TIFFNoBitRevTable
+is also declared public; it is a lookup table that
+can be used as an
+.IR "identity function" ;
+i.e.
+.IR "TIFFNoBitRevTable[n] == n" .
+.SH DIAGNOSTICS
+None.
+.SH "SEE ALSO"
+.IR libtiff (3T),