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 typedef struct
  53 {
  54         int                     ident;
  55         int                     version;
  56         int                     type;
  57         float           boundingradius;
  58         int                     width;
  59         int                     height;
  60         int                     numframes;
  61         float           beamlength;
  62         synctype_t      synctype;
  63 } dsprite_t;
  64
  65 typedef struct
  66 {
  67         int                     ident;
  68         int                     version;
  69         int                     type;
  70         int                     rendermode;
  71         float           boundingradius;
  72         int                     width;
  73         int                     height;
  74         int                     numframes;
  75         float           beamlength;
  76         synctype_t      synctype;
  77 } dspritehl_t;
  78
  79 #define SPR_VP_PARALLEL_UPRIGHT         0
  80 #define SPR_FACING_UPRIGHT                      1
  81 #define SPR_VP_PARALLEL                         2
  82 #define SPR_ORIENTED                            3
  83 #define SPR_VP_PARALLEL_ORIENTED        4
  84
  85 #define SPRHL_NORMAL    0
  86 #define SPRHL_ADDITIVE  1
  87 // no idea how to handle these two rendering modes
  88 #define SPRHL_INDEXALPHA        2
  89 #define SPRHL_ALPHATEST 3
  90
  91 typedef struct {
  92         int                     origin[2];
  93         int                     width;
  94         int                     height;
  95 } dspriteframe_t;
  96
  97 typedef struct {
  98         int                     numframes;
  99 } dspritegroup_t;
 100
 101 typedef struct {
 102         float   interval;
 103 } dspriteinterval_t;
 104
 105 typedef enum { SPR_SINGLE=0, SPR_GROUP } spriteframetype_t;
 106
 107 typedef struct {
 108         spriteframetype_t       type;
 109 } dspriteframetype_t;
 110
 111 #endif
 112