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

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