spritegn.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20 //
  21 // spritegn.h: header file for sprite generation program
  22 //
  23
  24 // **********************************************************
  25 // * This file must be identical in the spritegen directory *
  26 // * and in the Quake directory, because it's used to       *
  27 // * pass data from one to the other via .spr files.        *
  28 // **********************************************************
  29
  30 #ifndef SPRITEGEN_H
  31 #define SPRITEGEN_H
  32
  33 //-------------------------------------------------------
  34 // This program generates .spr sprite package files.
  35 // The format of the files is as follows:
  36 //
  37 // dsprite_t file header structure
  38 // <repeat dsprite_t.numframes times>
  39 //   <if spritegroup, repeat dspritegroup_t.numframes times>
  40 //     dspriteframe_t frame header structure
  41 //     sprite bitmap
  42 //   <else (single sprite frame)>
  43 //     dspriteframe_t frame header structure
  44 //     sprite bitmap
  45 // <endrepeat>
  46 //-------------------------------------------------------
  47
  48 #define SPRITE_VERSION          1
  49 #define SPRITEHL_VERSION        2
  50 #define SPRITE32_VERSION        32
  51
  52 #define SPRITE2_VERSION         2
  53
  54 typedef struct dsprite_s
  55 {
  56         int                     ident;
  57         int                     version;
  58         int                     type;
  59         float           boundingradius;
  60         int                     width;
  61         int                     height;
  62         int                     numframes;
  63         float           beamlength;
  64         synctype_t      synctype;
  65 } dsprite_t;
  66
  67 typedef struct dspritehl_s
  68 {
  69         int                     ident;
  70         int                     version;
  71         int                     type;
  72         int                     rendermode;
  73         float           boundingradius;
  74         int                     width;
  75         int                     height;
  76         int                     numframes;
  77         float           beamlength;
  78         synctype_t      synctype;
  79 } dspritehl_t;
  80
  81 typedef struct dsprite2frame_s
  82 {
  83         int             width, height;
  84         int             origin_x, origin_y;             // raster coordinates inside pic
  85         char    name[64];                               // name of pcx file
  86 } dsprite2frame_t;
  87
  88 typedef struct dsprite2_s
  89 {
  90         int                             ident;
  91         int                             version;
  92         int                             numframes;
  93         dsprite2frame_t frames[1];              // variable sized
  94 } dsprite2_t;
  95
  96 #define SPR_VP_PARALLEL_UPRIGHT         0
  97 #define SPR_FACING_UPRIGHT                      1
  98 #define SPR_VP_PARALLEL                         2
  99 #define SPR_ORIENTED                            3
 100 #define SPR_VP_PARALLEL_ORIENTED        4
 101 #define SPR_LABEL                       5
 102 #define SPR_LABEL_SCALE                 6
 103
 104 #define SPRHL_OPAQUE    0
 105 #define SPRHL_ADDITIVE  1
 106 #define SPRHL_INDEXALPHA        2
 107 #define SPRHL_ALPHATEST 3
 108
 109 typedef struct dspriteframe_s {
 110         int                     origin[2];
 111         int                     width;
 112         int                     height;
 113 } dspriteframe_t;
 114
 115 typedef struct dspritegroup_s {
 116         int                     numframes;
 117 } dspritegroup_t;
 118
 119 typedef struct dspriteinterval_s {
 120         float   interval;
 121 } dspriteinterval_t;
 122
 123 typedef enum spriteframetype_e { SPR_SINGLE=0, SPR_GROUP } spriteframetype_t;
 124
 125 typedef struct dspriteframetype_s {
 126         spriteframetype_t       type;
 127 } dspriteframetype_t;
 128
 129 #endif
 130