9647311077e8ce5c382f8764366a1367fb0612bc
[xonotic/darkplaces.git] / 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
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
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
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
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
102 #define SPRHL_OPAQUE    0
103 #define SPRHL_ADDITIVE  1
104 #define SPRHL_INDEXALPHA        2
105 #define SPRHL_ALPHATEST 3
106
107 typedef struct {
108         int                     origin[2];
109         int                     width;
110         int                     height;
111 } dspriteframe_t;
112
113 typedef struct {
114         int                     numframes;
115 } dspritegroup_t;
116
117 typedef struct {
118         float   interval;
119 } dspriteinterval_t;
120
121 typedef enum { SPR_SINGLE=0, SPR_GROUP } spriteframetype_t;
122
123 typedef struct {
124         spriteframetype_t       type;
125 } dspriteframetype_t;
126
127 #endif
128