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 //-------------------------------------------------------
  31 // This program generates .spr sprite package files.
  32 // The format of the files is as follows:
  33 //
  34 // dsprite_t file header structure
  35 // <repeat dsprite_t.numframes times>
  36 //   <if spritegroup, repeat dspritegroup_t.numframes times>
  37 //     dspriteframe_t frame header structure
  38 //     sprite bitmap
  39 //   <else (single sprite frame)>
  40 //     dspriteframe_t frame header structure
  41 //     sprite bitmap
  42 // <endrepeat>
  43 //-------------------------------------------------------
  44
  45 #define SPRITE_VERSION  1
  46 #define SPRITEHL_VERSION        2
  47 #define SPRITE32_VERSION        32
  48
  49 typedef struct
  50 {
  51         int                     ident;
  52         int                     version;
  53         int                     type;
  54         float           boundingradius;
  55         int                     width;
  56         int                     height;
  57         int                     numframes;
  58         float           beamlength;
  59         synctype_t      synctype;
  60 } dsprite_t;
  61
  62 typedef struct
  63 {
  64         int                     ident;
  65         int                     version;
  66         int                     type;
  67         int                     rendermode;
  68         float           boundingradius;
  69         int                     width;
  70         int                     height;
  71         int                     numframes;
  72         float           beamlength;
  73         synctype_t      synctype;
  74 } dspritehl_t;
  75
  76 #define SPR_VP_PARALLEL_UPRIGHT         0
  77 #define SPR_FACING_UPRIGHT                      1
  78 #define SPR_VP_PARALLEL                         2
  79 #define SPR_ORIENTED                            3
  80 #define SPR_VP_PARALLEL_ORIENTED        4
  81
  82 #define SPRHL_NORMAL    0
  83 #define SPRHL_ADDITIVE  1
  84 // no idea how to handle these two rendering modes
  85 #define SPRHL_INDEXALPHA        2
  86 #define SPRHL_ALPHATEST 3
  87
  88 typedef struct {
  89         int                     origin[2];
  90         int                     width;
  91         int                     height;
  92 } dspriteframe_t;
  93
  94 typedef struct {
  95         int                     numframes;
  96 } dspritegroup_t;
  97
  98 typedef struct {
  99         float   interval;
 100 } dspriteinterval_t;
 101
 102 typedef enum { SPR_SINGLE=0, SPR_GROUP } spriteframetype_t;
 103
 104 typedef struct {
 105         spriteframetype_t       type;
 106 } dspriteframetype_t;