Gecko resizing support
[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 // upload if r_textureprecache >= 1, otherwise defer loading until it is used
10 #define TEXF_PRECACHE 0x00000004
11 // upload immediately, never defer (ignore r_textureprecache)
12 #define TEXF_ALWAYSPRECACHE 0x00000008
13 // indicates texture coordinates should be clamped rather than wrapping
14 #define TEXF_CLAMP 0x00000020
15 // indicates texture should be uploaded using GL_NEAREST or GL_NEAREST_MIPMAP_NEAREST mode
16 #define TEXF_FORCENEAREST 0x00000040
17 // indicates texture should be uploaded using GL_LINEAR or GL_LINEAR_MIPMAP_NEAREST or GL_LINEAR_MIPMAP_LINEAR mode
18 #define TEXF_FORCELINEAR 0x00000080
19 // indicates texture should be affected by gl_picmip and gl_max_size cvar
20 #define TEXF_PICMIP 0x00000100
21 // indicates texture should be compressed if possible
22 #define TEXF_COMPRESS 0x00000200
23 // use this flag to block R_PurgeTexture from freeing a texture
24 #define TEXF_PERSISTENT 0x00000400
25 // used for checking if textures mismatch
26 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS)
27
28 typedef enum textype_e
29 {
30         // 8bit paletted
31         TEXTYPE_PALETTE,
32         // 32bit RGBA
33         TEXTYPE_RGBA,
34         // 32bit BGRA (preferred format due to faster uploads on most hardware)
35         TEXTYPE_BGRA,
36 }
37 textype_t;
38
39 // contents of this structure are mostly private to gl_textures.c
40 typedef struct rtexture_s
41 {
42         // this is exposed (rather than private) for speed reasons only
43         int texnum;
44 }
45 rtexture_t;
46
47 // contents of this structure are private to gl_textures.c
48 typedef struct rtexturepool_s
49 {
50         int useless;
51 }
52 rtexturepool_t;
53
54 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
55
56 // allocate a texture pool, to be used with R_LoadTexture
57 rtexturepool_t *R_AllocTexturePool(void);
58 // free a texture pool (textures can not be freed individually)
59 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
60
61 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
62 extern cvar_t gl_texturecompression;
63 extern cvar_t gl_texturecompression_color;
64 extern cvar_t gl_texturecompression_normal;
65 extern cvar_t gl_texturecompression_gloss;
66 extern cvar_t gl_texturecompression_glow;
67 extern cvar_t gl_texturecompression_2d;
68 extern cvar_t gl_texturecompression_q3bsplightmaps;
69 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
70 extern cvar_t gl_texturecompression_sky;
71 extern cvar_t gl_texturecompression_lightcubemaps;
72
73 // add a texture to a pool and optionally precache (upload) it
74 // (note: data == NULL is perfectly acceptable)
75 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
76 rtexture_t *R_LoadTexture1D(rtexturepool_t *rtexturepool, const char *identifier, int width, const unsigned char *data, textype_t textype, int flags, const unsigned int *palette);
77 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);
78 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);
79 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);
80
81 // free a texture
82 void R_FreeTexture(rtexture_t *rt);
83
84 // update a portion of the image data of a texture, used by lightmap updates
85 // and procedural textures such as video playback.
86 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int width, int height);
87
88 // returns the renderer dependent texture slot number (call this before each
89 // use, as a texture might not have been precached)
90 #define R_GetTexture(rt) ((rt) ? ((rt)->texnum >= 0 ? (rt)->texnum : R_RealGetTexture(rt)) : r_texture_white->texnum)
91 int R_RealGetTexture (rtexture_t *rt);
92
93 // returns true if the texture is transparent (useful for rendering code)
94 int R_TextureHasAlpha(rtexture_t *rt);
95
96 // returns width of texture, as was specified when it was uploaded
97 int R_TextureWidth(rtexture_t *rt);
98
99 // returns height of texture, as was specified when it was uploaded
100 int R_TextureHeight(rtexture_t *rt);
101
102 // only frees the texture if TEXF_PERSISTENT is not set
103 // also resets the variable
104 void R_PurgeTexture(rtexture_t *prt);
105
106 // frees processing buffers each frame, and may someday animate procedural textures
107 void R_Textures_Frame(void);
108
109 // maybe rename this - sounds awful? [11/21/2007 Black]
110 void R_MarkDirtyTexture(rtexture_t *rt);
111 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
112
113 // Clear the texture's contents
114 void R_ClearTexture (rtexture_t *rt);
115
116 #endif
117