implemented support for caching compressed textures (.dds files),
[divverent/darkplaces.git] / r_textures.h
1
2 #ifndef R_TEXTURES_H
3 #define R_TEXTURES_H
4
5 // transparent
6 #define TEXF_ALPHA 0x00000001
7 // mipmapped
8 #define TEXF_MIPMAP 0x00000002
9 // indicates texture coordinates should be clamped rather than wrapping
10 #define TEXF_CLAMP 0x00000020
11 // indicates texture should be uploaded using GL_NEAREST or GL_NEAREST_MIPMAP_NEAREST mode
12 #define TEXF_FORCENEAREST 0x00000040
13 // indicates texture should be uploaded using GL_LINEAR or GL_LINEAR_MIPMAP_NEAREST or GL_LINEAR_MIPMAP_LINEAR mode
14 #define TEXF_FORCELINEAR 0x00000080
15 // indicates texture should be affected by gl_picmip and gl_max_size cvar
16 #define TEXF_PICMIP 0x00000100
17 // indicates texture should be compressed if possible
18 #define TEXF_COMPRESS 0x00000200
19 // use this flag to block R_PurgeTexture from freeing a texture (only used by r_texture_white and similar which may be used in skinframe_t)
20 #define TEXF_PERSISTENT 0x00000400
21 // indicates texture should use GL_COMPARE_R_TO_TEXTURE mode
22 #define TEXF_COMPARE 0x00000800
23 // indicates texture should use lower precision where supported
24 #define TEXF_LOWPRECISION 0x00001000
25 // indicates texture should support R_UpdateTexture, actual uploads may be delayed until R_Mesh_TexBind if gl_nopartialtextureupdates is on
26 #define TEXF_ALLOWUPDATES 0x00002000
27 // used for checking if textures mismatch
28 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS | TEXF_COMPARE | TEXF_LOWPRECISION)
29
30 typedef enum textype_e
31 {
32         // 8bit paletted
33         TEXTYPE_PALETTE,
34         // 32bit RGBA
35         TEXTYPE_RGBA,
36         // 32bit BGRA (preferred format due to faster uploads on most hardware)
37         TEXTYPE_BGRA,
38         // 16bit D16 (16bit depth) or 32bit S8D24 (24bit depth, 8bit stencil unused)
39         TEXTYPE_SHADOWMAP,
40         // 8bit ALPHA (used for freetype fonts)
41         TEXTYPE_ALPHA,
42         // 4x4 block compressed 15bit color (4 bits per pixel)
43         TEXTYPE_DXT1,
44         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel)
45         TEXTYPE_DXT1A,
46         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
47         TEXTYPE_DXT3,
48         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
49         TEXTYPE_DXT5,
50 }
51 textype_t;
52
53 // contents of this structure are mostly private to gl_textures.c
54 typedef struct rtexture_s
55 {
56         // this is exposed (rather than private) for speed reasons only
57         int texnum;
58         qboolean dirty;
59         int gltexturetypeenum; // exposed for use in R_Mesh_TexBind
60 }
61 rtexture_t;
62
63 // contents of this structure are private to gl_textures.c
64 typedef struct rtexturepool_s
65 {
66         int useless;
67 }
68 rtexturepool_t;
69
70 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
71
72 // allocate a texture pool, to be used with R_LoadTexture
73 rtexturepool_t *R_AllocTexturePool(void);
74 // free a texture pool (textures can not be freed individually)
75 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
76
77 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
78 extern cvar_t gl_texturecompression;
79 extern cvar_t gl_texturecompression_color;
80 extern cvar_t gl_texturecompression_normal;
81 extern cvar_t gl_texturecompression_gloss;
82 extern cvar_t gl_texturecompression_glow;
83 extern cvar_t gl_texturecompression_2d;
84 extern cvar_t gl_texturecompression_q3bsplightmaps;
85 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
86 extern cvar_t gl_texturecompression_sky;
87 extern cvar_t gl_texturecompression_lightcubemaps;
88
89 // add a texture to a pool and optionally precache (upload) it
90 // (note: data == NULL is perfectly acceptable)
91 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
92 rtexture_t *R_LoadTexture2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, const unsigned char *data, textype_t textype, int flags, const unsigned int *palette);
93 rtexture_t *R_LoadTexture3D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int depth, const unsigned char *data, textype_t textype, int flags, const unsigned int *palette);
94 rtexture_t *R_LoadTextureCubeMap(rtexturepool_t *rtexturepool, const char *identifier, int width, const unsigned char *data, textype_t textype, int flags, const unsigned int *palette);
95 rtexture_t *R_LoadTextureRectangle(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, const unsigned char *data, textype_t textype, int flags, const unsigned int *palette);
96 rtexture_t *R_LoadTextureShadowMapRectangle(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
97 rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
98 rtexture_t *R_LoadTextureShadowMapCube(rtexturepool_t *rtexturepool, const char *identifier, int width, int precision, qboolean filter);
99 rtexture_t *R_LoadTextureDDSFile(rtexturepool_t *rtexturepool, const char *filename, int flags, qboolean *hasalphaflag, float *avgcolor);
100
101 // saves a texture to a DDS file
102 int R_SaveTextureDDSFile(rtexture_t *rt, const char *filename, qboolean skipuncompressed);
103
104 // free a texture
105 void R_FreeTexture(rtexture_t *rt);
106
107 // update a portion of the image data of a texture, used by lightmap updates
108 // and procedural textures such as video playback, actual uploads may be
109 // delayed by gl_nopartialtextureupdates cvar until R_Mesh_TexBind uses it
110 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int width, int height);
111
112 // returns the renderer dependent texture slot number (call this before each
113 // use, as a texture might not have been precached)
114 #define R_GetTexture(rt) ((rt) ? ((rt)->dirty ? R_RealGetTexture(rt) : (rt)->texnum) : r_texture_white->texnum)
115 int R_RealGetTexture (rtexture_t *rt);
116
117 // returns width of texture, as was specified when it was uploaded
118 int R_TextureWidth(rtexture_t *rt);
119
120 // returns height of texture, as was specified when it was uploaded
121 int R_TextureHeight(rtexture_t *rt);
122
123 // only frees the texture if TEXF_PERSISTENT is not set
124 // also resets the variable
125 void R_PurgeTexture(rtexture_t *prt);
126
127 // frees processing buffers each frame, and may someday animate procedural textures
128 void R_Textures_Frame(void);
129
130 // maybe rename this - sounds awful? [11/21/2007 Black]
131 void R_MarkDirtyTexture(rtexture_t *rt);
132 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
133
134 // Clear the texture's contents
135 void R_ClearTexture (rtexture_t *rt);
136
137 #endif
138