rewrote memory system entirely (hunk, cache, and zone are gone, memory pools replaced...

[xonotic/darkplaces.git] / r_textures.h

diff --git a/r_textures.h b/r_textures.h
index 9cfcca3e76d8c0a06184301707ece27d9bda021b..3bf15de7d04ebe8caf8881b27f0e7b5246f55f55 100644 (file)
--- a/r_textures.h
+++ b/r_textures.h
@@ -1,20 +1,70 @@
 
-#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)
-#define TEXF_ALWAYSPRECACHE 16 // upload immediately, never defer (ignore r_textureprecache)
+// 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
+// allocated as a fragment in a larger texture, mipmap is not allowed with
+// this, mostly used for lightmaps (which are procedural textures)
+#define TEXF_FRAGMENT 0x00000010
+// used for checking if textures mismatch
+#define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_FRAGMENT)
+
+// 8bit quake paletted
+#define TEXTYPE_QPALETTE 1
+// 24bit RGB
+#define TEXTYPE_RGB 2
+// 32bit RGBA
+#define TEXTYPE_RGBA 3
 
 // contents of this structure are private to gl_textures.c
-typedef struct rtexture_s
+typedef struct
 {
        int useless;
 }
 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
+{
+       int useless;
+}
+rtexturepool_t;
+
+// allocate a texture pool, to be used with R_LoadTexture/R_ProceduralTexture
+rtexturepool_t *R_AllocTexturePool(void);
+// free a texture pool (textures can not be freed individually)
+void R_FreeTexturePool(rtexturepool_t **rtexturepool);
+
+// important technical note:
+// fragment textures must have a width that is compatible with the fragment
+// update system, to get a compliant size, use R_CompatibleFragmentWidth
+int R_CompatibleFragmentWidth(int width, int textype, int flags);
+
+// these two functions add a texture to a pool, and may precache (upload) it
+// a normal static texture
+rtexture_t *R_LoadTexture (rtexturepool_t *rtexturepool, char *identifier, int width, int height, byte *data, int textype, int flags);
+// a procedurally generated texture, often animated over time, note: generate can be NULL (for odd uses)
+rtexture_t *R_ProceduralTexture (rtexturepool_t *rtexturepool, char *identifier, int width, int height, int textype, int flags, int (*generate)(byte *buffer, int width, int height, void *parameterdata, int parameterdatasize), void *parameterdata, int parameterdatasize);
+
+// update the image data of a texture, used by lightmap updates and procedural
+// textures.
+void R_UpdateTexture(rtexture_t *rt, byte *data);
+
+// location of the fragment in the texture (note: any parameter except rt can be NULL)
+void R_GetFragmentLocation(rtexture_t *rt, int *x, int *y, float *fx1, float *fy1, float *fx2, float *fy2);
+
+// returns the renderer dependent texture slot number (call this before each use, as a texture might not have been precached, or it might change over time if it is procedural)
+int R_GetTexture (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);