new cvars:
[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 // indicates texture should be affected by gl_picmip_world and r_picmipworld (maybe others in the future) instead of gl_picmip_other
28 #define TEXF_ISWORLD 0x00004000
29 // indicates texture should be affected by gl_picmip_sprites and r_picmipsprites (maybe others in the future) instead of gl_picmip_other
30 #define TEXF_ISSPRITE 0x00008000
31 // used for checking if textures mismatch
32 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS | TEXF_COMPARE | TEXF_LOWPRECISION)
33
34 typedef enum textype_e
35 {
36         // 8bit paletted
37         TEXTYPE_PALETTE,
38         // 32bit RGBA
39         TEXTYPE_RGBA,
40         // 32bit BGRA (preferred format due to faster uploads on most hardware)
41         TEXTYPE_BGRA,
42         // 16bit D16 (16bit depth) or 32bit S8D24 (24bit depth, 8bit stencil unused)
43         TEXTYPE_SHADOWMAP,
44         // 8bit ALPHA (used for freetype fonts)
45         TEXTYPE_ALPHA,
46         // 4x4 block compressed 15bit color (4 bits per pixel)
47         TEXTYPE_DXT1,
48         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel)
49         TEXTYPE_DXT1A,
50         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
51         TEXTYPE_DXT3,
52         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
53         TEXTYPE_DXT5,
54         // this represents the same format as the framebuffer, for fast copies
55         TEXTYPE_COLORBUFFER,
56 }
57 textype_t;
58
59 // contents of this structure are mostly private to gl_textures.c
60 typedef struct rtexture_s
61 {
62         // this is exposed (rather than private) for speed reasons only
63         int texnum;
64         qboolean dirty;
65         int gltexturetypeenum; // exposed for use in R_Mesh_TexBind
66 }
67 rtexture_t;
68
69 // contents of this structure are private to gl_textures.c
70 typedef struct rtexturepool_s
71 {
72         int useless;
73 }
74 rtexturepool_t;
75
76 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
77
78 // allocate a texture pool, to be used with R_LoadTexture
79 rtexturepool_t *R_AllocTexturePool(void);
80 // free a texture pool (textures can not be freed individually)
81 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
82
83 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
84 extern cvar_t gl_texturecompression;
85 extern cvar_t gl_texturecompression_color;
86 extern cvar_t gl_texturecompression_normal;
87 extern cvar_t gl_texturecompression_gloss;
88 extern cvar_t gl_texturecompression_glow;
89 extern cvar_t gl_texturecompression_2d;
90 extern cvar_t gl_texturecompression_q3bsplightmaps;
91 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
92 extern cvar_t gl_texturecompression_sky;
93 extern cvar_t gl_texturecompression_lightcubemaps;
94 extern cvar_t gl_texturecompression_reflectmask;
95
96 // add a texture to a pool and optionally precache (upload) it
97 // (note: data == NULL is perfectly acceptable)
98 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
99 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);
100 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);
101 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);
102 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);
103 rtexture_t *R_LoadTextureShadowMapRectangle(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
104 rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
105 rtexture_t *R_LoadTextureShadowMapCube(rtexturepool_t *rtexturepool, const char *identifier, int width, int precision, qboolean filter);
106 rtexture_t *R_LoadTextureDDSFile(rtexturepool_t *rtexturepool, const char *filename, int flags, qboolean *hasalphaflag, float *avgcolor);
107
108 // saves a texture to a DDS file
109 int R_SaveTextureDDSFile(rtexture_t *rt, const char *filename, qboolean skipuncompressed);
110
111 // free a texture
112 void R_FreeTexture(rtexture_t *rt);
113
114 // update a portion of the image data of a texture, used by lightmap updates
115 // and procedural textures such as video playback, actual uploads may be
116 // delayed by gl_nopartialtextureupdates cvar until R_Mesh_TexBind uses it
117 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int width, int height);
118
119 // returns the renderer dependent texture slot number (call this before each
120 // use, as a texture might not have been precached)
121 #define R_GetTexture(rt) ((rt) ? ((rt)->dirty ? R_RealGetTexture(rt) : (rt)->texnum) : r_texture_white->texnum)
122 int R_RealGetTexture (rtexture_t *rt);
123
124 // returns width of texture, as was specified when it was uploaded
125 int R_TextureWidth(rtexture_t *rt);
126
127 // returns height of texture, as was specified when it was uploaded
128 int R_TextureHeight(rtexture_t *rt);
129
130 // only frees the texture if TEXF_PERSISTENT is not set
131 // also resets the variable
132 void R_PurgeTexture(rtexture_t *prt);
133
134 // frees processing buffers each frame, and may someday animate procedural textures
135 void R_Textures_Frame(void);
136
137 // maybe rename this - sounds awful? [11/21/2007 Black]
138 void R_MarkDirtyTexture(rtexture_t *rt);
139 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
140
141 // Clear the texture's contents
142 void R_ClearTexture (rtexture_t *rt);
143
144 #endif
145