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