]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - r_textures.h
restoring scaffolding for cubemap and 2D shadowmaps
[xonotic/darkplaces.git] / r_textures.h
index 9657fadf14fc9cbb33c6c5eb88bc5918c7bdc41b..3cb7f8381b883c9c97996b02d3c89a8196eb82b2 100644 (file)
 
-#define TEXF_ALPHA 1 // transparent
-#define TEXF_MIPMAP 2 // mipmapped
-#define TEXF_RGBA 4 // 32bit RGBA, as opposed to 8bit paletted
-#define TEXF_PRECACHE 8 // upload immediately, otherwise defer loading until it is used (r_textureprecache can override this)
+#ifndef R_TEXTURES_H
+#define R_TEXTURES_H
 
-// contents of this structure are private to gl_textures.c
+// transparent
+#define TEXF_ALPHA 0x00000001
+// mipmapped
+#define TEXF_MIPMAP 0x00000002
+// upload if r_textureprecache >= 1, otherwise defer loading until it is used
+#define TEXF_PRECACHE 0x00000004
+// upload immediately, never defer (ignore r_textureprecache)
+#define TEXF_ALWAYSPRECACHE 0x00000008
+// indicates texture coordinates should be clamped rather than wrapping
+#define TEXF_CLAMP 0x00000020
+// indicates texture should be uploaded using GL_NEAREST or GL_NEAREST_MIPMAP_NEAREST mode
+#define TEXF_FORCENEAREST 0x00000040
+// indicates texture should be uploaded using GL_LINEAR or GL_LINEAR_MIPMAP_NEAREST or GL_LINEAR_MIPMAP_LINEAR mode
+#define TEXF_FORCELINEAR 0x00000080
+// indicates texture should be affected by gl_picmip and gl_max_size cvar
+#define TEXF_PICMIP 0x00000100
+// indicates texture should be compressed if possible
+#define TEXF_COMPRESS 0x00000200
+// use this flag to block R_PurgeTexture from freeing a texture
+#define TEXF_PERSISTENT 0x00000400
+// indicates texture should use GL_COMPARE_R_TO_TEXTURE mode
+#define TEXF_COMPARE 0x00000800
+// used for checking if textures mismatch
+#define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS | TEXF_COMPARE)
+
+typedef enum textype_e
+{
+       // 8bit paletted
+       TEXTYPE_PALETTE,
+       // 32bit RGBA
+       TEXTYPE_RGBA,
+       // 32bit BGRA (preferred format due to faster uploads on most hardware)
+       TEXTYPE_BGRA,
+       // 32bit S8D24 (24bit depth, 8bit stencil unused)
+       TEXTYPE_SHADOWMAP,
+       // 32bit L16A16
+       TEXTYPE_PROJECTION
+}
+textype_t;
+
+// contents of this structure are mostly private to gl_textures.c
 typedef struct rtexture_s
 {
-       int useless;
+       // this is exposed (rather than private) for speed reasons only
+       int texnum;
 }
 rtexture_t;
 
-// uploads a texture
-extern rtexture_t *R_LoadTexture (char *identifier, int width, int height, byte *data, int flags);
-// returns the renderer dependent texture slot number (call this before each use, as a texture might not have been precached)
-extern int R_GetTexture (rtexture_t *rt);
-// returns a GL texture slot (only used for lightmaps)
-extern int R_GetTextureSlots(int count);
+// contents of this structure are private to gl_textures.c
+typedef struct rtexturepool_s
+{
+       int useless;
+}
+rtexturepool_t;
+
+typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
+
+// allocate a texture pool, to be used with R_LoadTexture
+rtexturepool_t *R_AllocTexturePool(void);
+// free a texture pool (textures can not be freed individually)
+void R_FreeTexturePool(rtexturepool_t **rtexturepool);
+
+// the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
+extern cvar_t gl_texturecompression;
+extern cvar_t gl_texturecompression_color;
+extern cvar_t gl_texturecompression_normal;
+extern cvar_t gl_texturecompression_gloss;
+extern cvar_t gl_texturecompression_glow;
+extern cvar_t gl_texturecompression_2d;
+extern cvar_t gl_texturecompression_q3bsplightmaps;
+extern cvar_t gl_texturecompression_q3bspdeluxemaps;
+extern cvar_t gl_texturecompression_sky;
+extern cvar_t gl_texturecompression_lightcubemaps;
+
+// add a texture to a pool and optionally precache (upload) it
+// (note: data == NULL is perfectly acceptable)
+// (note: palette must not be NULL if using TEXTYPE_PALETTE)
+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);
+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);
+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);
+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);
+rtexture_t *R_LoadTextureShadowMapRectangle(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, qboolean filter);
+rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, qboolean filter);
+rtexture_t *R_LoadTextureShadowMapCube(rtexturepool_t *rtexturepool, const char *identifier, int width, qboolean filter);
+rtexture_t *R_LoadTextureCubeProjection(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int size, int border);
+
+// free a texture
+void R_FreeTexture(rtexture_t *rt);
+
+// update a portion of the image data of a texture, used by lightmap updates
+// and procedural textures such as video playback.
+void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int width, int height);
+
+// returns the renderer dependent texture slot number (call this before each
+// use, as a texture might not have been precached)
+#define R_GetTexture(rt) ((rt) ? ((rt)->texnum > 0 ? (rt)->texnum : R_RealGetTexture(rt)) : r_texture_white->texnum)
+int R_RealGetTexture (rtexture_t *rt);
+
+// returns true if the texture is transparent (useful for rendering code)
+int R_TextureHasAlpha(rtexture_t *rt);
+
+// returns width of texture, as was specified when it was uploaded
+int R_TextureWidth(rtexture_t *rt);
+
+// returns height of texture, as was specified when it was uploaded
+int R_TextureHeight(rtexture_t *rt);
+
+// only frees the texture if TEXF_PERSISTENT is not set
+// also resets the variable
+void R_PurgeTexture(rtexture_t *prt);
+
+// frees processing buffers each frame, and may someday animate procedural textures
+void R_Textures_Frame(void);
+
+// maybe rename this - sounds awful? [11/21/2007 Black]
+void R_MarkDirtyTexture(rtexture_t *rt);
+void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
+
+// Clear the texture's contents
+void R_ClearTexture (rtexture_t *rt);
+
+#endif
+