fix display of r_shownormals < 0
[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 // multiply RGB by A channel before uploading
10 #define TEXF_RGBMULTIPLYBYALPHA 0x00000004
11 // indicates texture coordinates should be clamped rather than wrapping
12 #define TEXF_CLAMP 0x00000020
13 // indicates texture should be uploaded using GL_NEAREST or GL_NEAREST_MIPMAP_NEAREST mode
14 #define TEXF_FORCENEAREST 0x00000040
15 // indicates texture should be uploaded using GL_LINEAR or GL_LINEAR_MIPMAP_NEAREST or GL_LINEAR_MIPMAP_LINEAR mode
16 #define TEXF_FORCELINEAR 0x00000080
17 // indicates texture should be affected by gl_picmip and gl_max_size cvar
18 #define TEXF_PICMIP 0x00000100
19 // indicates texture should be compressed if possible
20 #define TEXF_COMPRESS 0x00000200
21 // 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)
22 #define TEXF_PERSISTENT 0x00000400
23 // indicates texture should use GL_COMPARE_R_TO_TEXTURE mode
24 #define TEXF_COMPARE 0x00000800
25 // indicates texture should use lower precision where supported
26 #define TEXF_LOWPRECISION 0x00001000
27 // indicates texture should support R_UpdateTexture on small regions, actual uploads may be delayed until R_Mesh_TexBind if gl_nopartialtextureupdates is on
28 #define TEXF_ALLOWUPDATES 0x00002000
29 // indicates texture should be affected by gl_picmip_world and r_picmipworld (maybe others in the future) instead of gl_picmip_other
30 #define TEXF_ISWORLD 0x00004000
31 // indicates texture should be affected by gl_picmip_sprites and r_picmipsprites (maybe others in the future) instead of gl_picmip_other
32 #define TEXF_ISSPRITE 0x00008000
33 // indicates the texture will be used as a render target (D3D hint)
34 #define TEXF_RENDERTARGET 0x0010000
35 // used for checking if textures mismatch
36 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_RGBMULTIPLYBYALPHA | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS | TEXF_COMPARE | TEXF_LOWPRECISION | TEXF_RENDERTARGET)
37
38 typedef enum textype_e
39 {
40         // 8bit paletted
41         TEXTYPE_PALETTE,
42         // 32bit RGBA
43         TEXTYPE_RGBA,
44         // 32bit BGRA (preferred format due to faster uploads on most hardware)
45         TEXTYPE_BGRA,
46         // 16bit D16 (16bit depth) or 32bit S8D24 (24bit depth, 8bit stencil unused)
47         TEXTYPE_SHADOWMAP,
48         // 8bit ALPHA (used for freetype fonts)
49         TEXTYPE_ALPHA,
50         // 4x4 block compressed 15bit color (4 bits per pixel)
51         TEXTYPE_DXT1,
52         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel)
53         TEXTYPE_DXT1A,
54         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
55         TEXTYPE_DXT3,
56         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
57         TEXTYPE_DXT5,
58         // this represents the same format as the framebuffer, for fast copies
59         TEXTYPE_COLORBUFFER
60 }
61 textype_t;
62
63 /*
64 #ifdef WIN32
65 #define SUPPORTD3D
66 #define SUPPORTDIRECTX
67 #ifdef SUPPORTD3D
68 #include <d3d9.h>
69 #endif
70 #endif
71 */
72
73 // contents of this structure are mostly private to gl_textures.c
74 typedef struct rtexture_s
75 {
76         // this is exposed (rather than private) for speed reasons only
77         int texnum;
78         qboolean dirty;
79         int gltexturetypeenum; // exposed for use in R_Mesh_TexBind
80         // d3d stuff the backend needs
81         void *d3dtexture;
82 #ifdef SUPPORTD3D
83         qboolean d3disdepthsurface; // for depth/stencil surfaces
84         int d3dformat;
85         int d3dusage;
86         int d3dpool;
87         int d3daddressu;
88         int d3daddressv;
89         int d3daddressw;
90         int d3dmagfilter;
91         int d3dminfilter;
92         int d3dmipfilter;
93         int d3dmaxmiplevelfilter;
94         int d3dmipmaplodbias;
95         int d3dmaxmiplevel;
96 #endif
97 }
98 rtexture_t;
99
100 // contents of this structure are private to gl_textures.c
101 typedef struct rtexturepool_s
102 {
103         int useless;
104 }
105 rtexturepool_t;
106
107 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
108
109 // allocate a texture pool, to be used with R_LoadTexture
110 rtexturepool_t *R_AllocTexturePool(void);
111 // free a texture pool (textures can not be freed individually)
112 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
113
114 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
115 extern cvar_t gl_texturecompression;
116 extern cvar_t gl_texturecompression_color;
117 extern cvar_t gl_texturecompression_normal;
118 extern cvar_t gl_texturecompression_gloss;
119 extern cvar_t gl_texturecompression_glow;
120 extern cvar_t gl_texturecompression_2d;
121 extern cvar_t gl_texturecompression_q3bsplightmaps;
122 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
123 extern cvar_t gl_texturecompression_sky;
124 extern cvar_t gl_texturecompression_lightcubemaps;
125 extern cvar_t gl_texturecompression_reflectmask;
126
127 // add a texture to a pool and optionally precache (upload) it
128 // (note: data == NULL is perfectly acceptable)
129 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
130 rtexture_t *R_LoadTexture2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, const unsigned char *data, textype_t textype, int flags, int miplevel, const unsigned int *palette);
131 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, int miplevel, const unsigned int *palette);
132 rtexture_t *R_LoadTextureCubeMap(rtexturepool_t *rtexturepool, const char *identifier, int width, const unsigned char *data, textype_t textype, int flags, int miplevel, const unsigned int *palette);
133 rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
134 rtexture_t *R_LoadTextureDDSFile(rtexturepool_t *rtexturepool, const char *filename, int flags, qboolean *hasalphaflag, float *avgcolor, int miplevel);
135
136 // saves a texture to a DDS file
137 int R_SaveTextureDDSFile(rtexture_t *rt, const char *filename, qboolean skipuncompressed, qboolean hasalpha);
138
139 // free a texture
140 void R_FreeTexture(rtexture_t *rt);
141
142 // update a portion of the image data of a texture, used by lightmap updates
143 // and procedural textures such as video playback, actual uploads may be
144 // delayed by gl_nopartialtextureupdates cvar until R_Mesh_TexBind uses it
145 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int width, int height);
146
147 // returns the renderer dependent texture slot number (call this before each
148 // use, as a texture might not have been precached)
149 #define R_GetTexture(rt) ((rt) ? ((rt)->dirty ? R_RealGetTexture(rt) : (rt)->texnum) : r_texture_white->texnum)
150 int R_RealGetTexture (rtexture_t *rt);
151
152 // returns width of texture, as was specified when it was uploaded
153 int R_TextureWidth(rtexture_t *rt);
154
155 // returns height of texture, as was specified when it was uploaded
156 int R_TextureHeight(rtexture_t *rt);
157
158 // only frees the texture if TEXF_PERSISTENT is not set
159 // also resets the variable
160 void R_PurgeTexture(rtexture_t *prt);
161
162 // frees processing buffers each frame, and may someday animate procedural textures
163 void R_Textures_Frame(void);
164
165 // maybe rename this - sounds awful? [11/21/2007 Black]
166 void R_MarkDirtyTexture(rtexture_t *rt);
167 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
168
169 // Clear the texture's contents
170 void R_ClearTexture (rtexture_t *rt);
171
172 // returns the desired picmip level for given TEXF_ flags
173 int R_PicmipForFlags(int flags);
174
175 #endif
176