src/Objects/DataManip/tgaFile/doc/tgaFile.html

   1 <H4> Update Time 05/06/13---09:05:05 </H4>
   2 <HR>
   3 <A NAME="Information">
   4 <H2>Information from source codes</H2>
   5 </A>
   6 <PRE>
   7 ../src/tgaFileInit.c:
   8
   9 ../src/tgaFilePrint.c:
  10
  11 ../src/tgaFileRead.c:
  12 </PRE>
  13 <HR>
  14 <A NAME="include">
  15 <H2>tgaFile.h</H2>
  16 </A>
  17 <PRE>
  18 #ifndef   TGA_FILE_H
  19 #define   TGA_FILE_H
  20
  21 typedef enum tgaFileColorMap {
  22         tgaFileColorMapNoColorMap=0,
  23         tgaFileColorMapColorMap=1
  24 } tgaFileColorMap;
  25
  26 typedef enum tgaFileImageType {
  27         tgaFileImageTypeNoImage  = 0,
  28         tgaFileImageTypeColorMappedImage = 1,
  29         tgaFileImageTypeTrueColorImage   = 2,
  30         tgaFileImageTypeBlackAndWhite    = 3,
  31         tgaFileImageTypeRLEColorMappedImage = 9,
  32         tgaFileImageTypeRLETrueColorImage   = 10,
  33         tgaFileImageTypeRLEBlackAndWhite    = 11
  34 } tgaFileImageType;
  35
  36 typedef struct tgaFileColorMapSpecification {
  37         short FirstEntryIndex;
  38         short ColorMapLength;
  39         unsigned char ColorMapEntrySize;
  40 } tgaFileColorMapSpecification;
  41
  42 typedef enum tgaFileImageOrigin {
  43         tgaFileImageOriginBottomLeft  = 0,
  44         tgaFileImageOriginBottomRight = 1,
  45         tgaFileImageOriginTopLeft     = 2,
  46         tgaFileImageOriginTopRight    = 3
  47 } tgaFileImageOrigin;
  48
  49 typedef union tgaFileDescriptor {
  50         unsigned char All;
  51         struct {
  52                 unsigned char AlphaChannelBits:4;
  53                 unsigned char ImageOrigin:2;
  54                 unsigned char Unused:2;
  55         } Bit;
  56 } tgaFileDescriptor;
  57
  58 typedef struct tgaFileImageSpecification {
  59         short Xorigin;
  60         short Yorigin;
  61         short Width;
  62         short Height;
  63         unsigned char Depth;
  64         tgaFileDescriptor Descriptor;
  65 } tgaFileImageSpecification;
  66
  67 typedef struct tgaFileHeader {
  68         unsigned char IDLength;                        /*  1 Byte */
  69         unsigned char ColorMapType;                    /*  1 Byte */
  70         unsigned char ImageType;                       /*  1 Byte */
  71         tgaFileColorMapSpecification ColorMapSpec;     /*  5 Bytes */
  72         tgaFileImageSpecification ImageSpec;           /* 10 Bytes */
  73 } tgaFileHeader;                                   /* 18 Bytes */
  74
  75 typedef unsigned char tgaFileImageID;
  76 typedef unsigned char tgaFileColorMapData;
  77 typedef unsigned char tgaFileImageData;
  78 typedef unsigned char tgaFileDeveloperData;
  79
  80 typedef struct tgaFile {
  81         tgaFileHeader        Header;                   /* Field 1-5 : fixed: 18 Bytes */
  82         tgaFileImageID*      ImageID;                  /* Field 6: variable */
  83         tgaFileColorMapData* ColorMapData;             /* Field 7: variable */
  84         tgaFileImageData*    Image;                /* Field 8: variable */
  85         tgaFileDeveloperData* DeveloperData;           /* Field 9: variable */
  86
  87         /* Additional Information */
  88         int flagHeader;
  89         int ImageDataOffset;
  90         int ImageDataBytes;
  91 } tgaFile;
  92
  93 #ifdef __cplusplust
  94 extern "C" {
  95 #endif
  96 extern tgaFile* tgaFileInit(tgaFile* tga, FILE* fpt, int mode);
  97 extern tgaFile* tgaFileImageInit(tgaFile* tga, FILE* fpt, int mode);
  98
  99 /* in tgaFileRead.c */
 100 extern tgaFile* tgaFileHeaderRead(tgaFile* tga, FILE* fpt, int mode);
 101 extern tgaFile* tgaFileImageDataRead(tgaFile* tga, FILE* fpt, int mode);
 102 extern tgaFile* tgaFileRead(tgaFile* tga, FILE* fpt, int mode);
 103
 104 /* in tgaFilePrint */
 105 extern void tgaFileHeaderPrint(tgaFile* tga, FILE* out, int mode);
 106
 107 #ifdef __cplusplust
 108 };
 109 #endif
 110
 111 #endif /* TGA_FILE_H */
 112 </PRE>