include/iff.h

   1 /*
   2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
   9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  11 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  12 */
  13
  14 #ifndef _IFF_H
  15 #define _IFF_H
  16
  17 #include "pstypes.h"
  18 #include "gr.h"
  19
  20 //Prototypes for IFF library functions
  21
  22 int iff_read_bitmap(char *ifilename,grs_bitmap *bm,int bitmap_type,ubyte *palette);
  23         //reads an IFF file into a grs_bitmap structure. fills in palette if not null
  24         //returns error codes - see IFF.H.  see GR.H for bitmap_type
  25         //MEM DETAILS:  This routines assumes that you already have the grs_bitmap
  26         //structure allocated, but that you don't have the data for this bitmap
  27         //allocated. In other words, do this:
  28         //   grs_bitmap * MyPicture;
  29         //   MALLOC( MyPicture, grs_bitmap, 1);
  30         //   iff_read_bitmap( filename, MyPicture, BM_LINEAR, NULL );
  31         //   ...do whatever with your bitmap ...
  32         //   gr_free_bitmap( MyPicture );
  33         //   exit(0)
  34
  35 //like iff_read_bitmap(), but reads into a bitmap that already exists,
  36 //without allocating memory for the bitmap.
  37 int iff_read_into_bitmap(char *ifilename,grs_bitmap *bm,byte *palette);
  38
  39 //read in animator brush (.abm) file
  40 //fills in array of pointers, and n_bitmaps.
  41 //returns iff error codes. max_bitmaps is size of array.
  42 int iff_read_animbrush(char *ifilename,grs_bitmap **bm,int max_bitmaps,int *n_bitmaps,ubyte *palette);
  43
  44 // After a read
  45 extern ubyte iff_transparent_color;
  46 extern ubyte iff_has_transparency;      // 0=no transparency, 1=iff_transparent_color is valid
  47
  48 int iff_write_bitmap(char *ofilename,grs_bitmap *bm,ubyte *palette);
  49         //writes an IFF file from a grs_bitmap structure. writes palette if not null
  50         //returns error codes - see IFF.H.
  51
  52 //function to return pointer to error message
  53 char *iff_errormsg(int error_number);
  54
  55
  56 //Error codes for read & write routines
  57
  58 #define IFF_NO_ERROR                    0               //everything is fine, have a nice day
  59 #define IFF_NO_MEM                      1               //not enough mem for loading or processing
  60 #define IFF_UNKNOWN_FORM        2               //IFF file, but not a bitmap
  61 #define IFF_NOT_IFF                     3               //this isn't even an IFF file
  62 #define IFF_NO_FILE                     4               //cannot find or open file
  63 #define IFF_BAD_BM_TYPE         5               //tried to save invalid type, like BM_RGB15
  64 #define IFF_CORRUPT                     6               //bad data in file
  65 #define IFF_FORM_ANIM           7               //this is an anim, with non-anim load rtn
  66 #define IFF_FORM_BITMAP         8               //this is not an anim, with anim load rtn
  67 #define IFF_TOO_MANY_BMS        9               //anim read had more bitmaps than room for
  68 #define IFF_UNKNOWN_MASK        10              //unknown masking type
  69 #define IFF_READ_ERROR          11              //error reading from file
  70 #define IFF_BM_MISMATCH         12              //bm being loaded doesn't match bm loaded into
  71
  72 #endif
  73