IM: im_format_raw.h Source File

previous page next page
im_format_raw.h

00001 /** \file
00002  * \brief Initialize the RAW Format Driver
00003  * Header for internal use only.
00004  *
00005  * See Copyright Notice in im_lib.h
00006  */
00007 
00008 #ifndef __IM_FORMAT_RAW_H
00009 #define __IM_FORMAT_RAW_H
00010 
00011 #if defined(__cplusplus)
00012 extern "C" {
00013 #endif
00014 
00015 /** \defgroup raw RAW - RAW File
00016  * 
00017  * \par
00018  * The file must be open/created with the functions \ref imFileOpenRaw and \ref imFileNewRaw.
00019  * 
00020  * \section Description
00021  * 
00022  * \par
00023  * Internal Implementation.
00024  * \par
00025  * Supports RAW binary images. You must know image parameters a priori. \n
00026  * You must set the IM_INT attributes "Width", "Height", "ColorMode", "DataType" before the imFileReadImageInfo/imFileWriteImageInfo functions.
00027  * \par
00028  * The data must be in binary form, but can start in an arbitrary offset from the begining of the file, use attribute "StartOffset".
00029  * The default is at 0 offset. 
00030  * \par
00031  * Integer sign and double precision can be converted using attribute "SwitchType". \n
00032  * The conversions will be BYTE<->CHAR, USHORT<->SHORT, INT<->UINT, FLOAT<->DOUBLE.
00033  * \par
00034  * Byte Order can be Little Endian (Intel=1) or Big Endian (Motorola=0), use the attribute "ByteOrder", the default is the current CPU.
00035  * \par
00036  * The lines can be aligned to a BYTE (1), WORD (2) or DWORD (4) boundaries, ue attribute "Padding" with the respective value.
00037  * \par
00038  * See \ref im_raw.h
00039  * 
00040  * \section Features
00041  *
00042 \verbatim
00043     Data Types: <all>
00044     Color Spaces: all, except MAP.
00045     Compressions: 
00046       NONE - no compression 
00047     Can have more than one image, depends on "StartOffset" attribute.
00048     Can have an alpha channel.
00049     Components can be packed or not.
00050     Lines arranged from top down to bottom or bottom up to top.
00051 
00052     Attributes:
00053       Width, Height, ColorMode, DataType IM_INT (1)
00054       StartOffset, SwitchType, ByteOrder, Padding  IM_INT (1)
00055 \endverbatim
00056  * \ingroup format */
00057 imFormat* imFormatInitRAW(void);
00058 
00059 
00060 #if defined(__cplusplus)
00061 }
00062 #endif
00063 
00064 #endif
previous page start next page