disable offsetmapping where TEXF_ALPHA is not set and no height bias exists
[xonotic/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 // set as a flag to force the texture to be reloaded
38 #define TEXF_FORCE_RELOAD 0x80000000
39
40 typedef enum textype_e
41 {
42         // 8bit paletted
43         TEXTYPE_PALETTE,
44         // 32bit RGBA
45         TEXTYPE_RGBA,
46         // 32bit BGRA (preferred format due to faster uploads on most hardware)
47         TEXTYPE_BGRA,
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
59         // 8bit paletted in sRGB colorspace
60         TEXTYPE_SRGB_PALETTE,
61         // 32bit RGBA in sRGB colorspace
62         TEXTYPE_SRGB_RGBA,
63         // 32bit BGRA (preferred format due to faster uploads on most hardware) in sRGB colorspace
64         TEXTYPE_SRGB_BGRA,
65         // 4x4 block compressed 15bit color (4 bits per pixel) in sRGB colorspace
66         TEXTYPE_SRGB_DXT1,
67         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel) in sRGB colorspace
68         TEXTYPE_SRGB_DXT1A,
69         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel) in sRGB colorspace
70         TEXTYPE_SRGB_DXT3,
71         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel) in sRGB colorspace
72         TEXTYPE_SRGB_DXT5,
73
74         // this represents the same format as the framebuffer, for fast copies
75         TEXTYPE_COLORBUFFER,
76         // this represents an RGBA half_float texture (4 16bit floats)
77         TEXTYPE_COLORBUFFER16F,
78         // this represents an RGBA float texture (4 32bit floats)
79         TEXTYPE_COLORBUFFER32F,
80         // 16bit D16 (16bit depth) or 32bit S8D24 (24bit depth, 8bit stencil unused)
81         TEXTYPE_SHADOWMAP
82 }
83 textype_t;
84
85 /*
86 #ifdef WIN32
87 #define SUPPORTD3D
88 #define SUPPORTDIRECTX
89 #ifdef SUPPORTD3D
90 #include <d3d9.h>
91 #endif
92 #endif
93 */
94
95 // contents of this structure are mostly private to gl_textures.c
96 typedef struct rtexture_s
97 {
98         // this is exposed (rather than private) for speed reasons only
99         int texnum;
100         qboolean dirty;
101         int gltexturetypeenum; // exposed for use in R_Mesh_TexBind
102         // d3d stuff the backend needs
103         void *d3dtexture;
104 #ifdef SUPPORTD3D
105         qboolean d3disdepthsurface; // for depth/stencil surfaces
106         int d3dformat;
107         int d3dusage;
108         int d3dpool;
109         int d3daddressu;
110         int d3daddressv;
111         int d3daddressw;
112         int d3dmagfilter;
113         int d3dminfilter;
114         int d3dmipfilter;
115         int d3dmaxmiplevelfilter;
116         int d3dmipmaplodbias;
117         int d3dmaxmiplevel;
118 #endif
119 }
120 rtexture_t;
121
122 // contents of this structure are private to gl_textures.c
123 typedef struct rtexturepool_s
124 {
125         int useless;
126 }
127 rtexturepool_t;
128
129 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
130
131 // allocate a texture pool, to be used with R_LoadTexture
132 rtexturepool_t *R_AllocTexturePool(void);
133 // free a texture pool (textures can not be freed individually)
134 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
135
136 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
137 extern cvar_t gl_texturecompression;
138 extern cvar_t gl_texturecompression_color;
139 extern cvar_t gl_texturecompression_normal;
140 extern cvar_t gl_texturecompression_gloss;
141 extern cvar_t gl_texturecompression_glow;
142 extern cvar_t gl_texturecompression_2d;
143 extern cvar_t gl_texturecompression_q3bsplightmaps;
144 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
145 extern cvar_t gl_texturecompression_sky;
146 extern cvar_t gl_texturecompression_lightcubemaps;
147 extern cvar_t gl_texturecompression_reflectmask;
148 extern cvar_t r_texture_dds_load;
149 extern cvar_t r_texture_dds_save;
150
151 // add a texture to a pool and optionally precache (upload) it
152 // (note: data == NULL is perfectly acceptable)
153 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
154 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);
155 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);
156 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);
157 rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
158 rtexture_t *R_LoadTextureDDSFile(rtexturepool_t *rtexturepool, const char *filename, int flags, qboolean *hasalphaflag, float *avgcolor, int miplevel);
159
160 // saves a texture to a DDS file
161 int R_SaveTextureDDSFile(rtexture_t *rt, const char *filename, qboolean skipuncompressed, qboolean hasalpha);
162
163 // free a texture
164 void R_FreeTexture(rtexture_t *rt);
165
166 // update a portion of the image data of a texture, used by lightmap updates
167 // and procedural textures such as video playback, actual uploads may be
168 // delayed by gl_nopartialtextureupdates cvar until R_Mesh_TexBind uses it
169 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int z, int width, int height, int depth);
170
171 // returns the renderer dependent texture slot number (call this before each
172 // use, as a texture might not have been precached)
173 #define R_GetTexture(rt) ((rt) ? ((rt)->dirty ? R_RealGetTexture(rt) : (rt)->texnum) : r_texture_white->texnum)
174 int R_RealGetTexture (rtexture_t *rt);
175
176 // returns width of texture, as was specified when it was uploaded
177 int R_TextureWidth(rtexture_t *rt);
178
179 // returns height of texture, as was specified when it was uploaded
180 int R_TextureHeight(rtexture_t *rt);
181
182 // returns flags of texture, as was specified when it was uploaded
183 int R_TextureFlags(rtexture_t *rt);
184
185 // only frees the texture if TEXF_PERSISTENT is not set
186 // also resets the variable
187 void R_PurgeTexture(rtexture_t *prt);
188
189 // frees processing buffers each frame, and may someday animate procedural textures
190 void R_Textures_Frame(void);
191
192 // maybe rename this - sounds awful? [11/21/2007 Black]
193 void R_MarkDirtyTexture(rtexture_t *rt);
194 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
195
196 // Clear the texture's contents
197 void R_ClearTexture (rtexture_t *rt);
198
199 // returns the desired picmip level for given TEXF_ flags
200 int R_PicmipForFlags(int flags);
201
202 #endif
203