added support for TEXTYPE_BGRA (GL_BGRA format), this doesn't require
[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 // used for checking if textures mismatch
24 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS)
25
26 // 8bit paletted
27 #define TEXTYPE_PALETTE 1
28 // 32bit RGBA
29 #define TEXTYPE_RGBA 3
30 // 32bit BGRA (preferred format due to faster uploads on most hardware)
31 #define TEXTYPE_BGRA 4
32
33 // contents of this structure are mostly private to gl_textures.c
34 typedef struct rtexture_s
35 {
36         // this is exposed (rather than private) for speed reasons only
37         int texnum;
38 }
39 rtexture_t;
40
41 // contents of this structure are private to gl_textures.c
42 typedef struct rtexturepool_s
43 {
44         int useless;
45 }
46 rtexturepool_t;
47
48 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
49
50 // allocate a texture pool, to be used with R_LoadTexture
51 rtexturepool_t *R_AllocTexturePool(void);
52 // free a texture pool (textures can not be freed individually)
53 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
54
55 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
56 extern cvar_t gl_texturecompression;
57 extern cvar_t gl_texturecompression_color;
58 extern cvar_t gl_texturecompression_normal;
59 extern cvar_t gl_texturecompression_gloss;
60 extern cvar_t gl_texturecompression_glow;
61 extern cvar_t gl_texturecompression_2d;
62 extern cvar_t gl_texturecompression_q3bsplightmaps;
63 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
64 extern cvar_t gl_texturecompression_sky;
65 extern cvar_t gl_texturecompression_lightcubemaps;
66
67 // add a texture to a pool and optionally precache (upload) it
68 // (note: data == NULL is perfectly acceptable)
69 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
70 rtexture_t *R_LoadTexture1D(rtexturepool_t *rtexturepool, const char *identifier, int width, const unsigned char *data, int textype, int flags, const unsigned int *palette);
71 rtexture_t *R_LoadTexture2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, const unsigned char *data, int textype, int flags, const unsigned int *palette);
72 rtexture_t *R_LoadTexture3D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int depth, const unsigned char *data, int textype, int flags, const unsigned int *palette);
73 rtexture_t *R_LoadTextureCubeMap(rtexturepool_t *rtexturepool, const char *identifier, int width, const unsigned char *data, int textype, int flags, const unsigned int *palette);
74
75 // free a texture
76 void R_FreeTexture(rtexture_t *rt);
77
78 // update a portion of the image data of a texture, used by lightmap updates
79 // and procedural textures such as video playback.
80 void R_UpdateTexture(rtexture_t *rt, unsigned char *data, int x, int y, int width, int height);
81
82 // returns the renderer dependent texture slot number (call this before each
83 // use, as a texture might not have been precached)
84 #define R_GetTexture(rt) ((rt) ? ((rt)->texnum >= 0 ? (rt)->texnum : R_RealGetTexture(rt)) : r_texture_white->texnum)
85 int R_RealGetTexture (rtexture_t *rt);
86
87 // returns true if the texture is transparent (useful for rendering code)
88 int R_TextureHasAlpha(rtexture_t *rt);
89
90 // returns width of texture, as was specified when it was uploaded
91 int R_TextureWidth(rtexture_t *rt);
92
93 // returns height of texture, as was specified when it was uploaded
94 int R_TextureHeight(rtexture_t *rt);
95
96 // frees processing buffers each frame, and may someday animate procedural textures
97 void R_Textures_Frame(void);
98
99 // maybe rename this - sounds awful? [11/21/2007 Black]
100 void R_MarkDirtyTexture(rtexture_t *rt);
101 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data); 
102
103 #endif
104