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 // indicates texture coordinates should be clamped rather than wrapping
  10 #define TEXF_CLAMP 0x00000020
  11 // indicates texture should be uploaded using GL_NEAREST or GL_NEAREST_MIPMAP_NEAREST mode
  12 #define TEXF_FORCENEAREST 0x00000040
  13 // indicates texture should be uploaded using GL_LINEAR or GL_LINEAR_MIPMAP_NEAREST or GL_LINEAR_MIPMAP_LINEAR mode
  14 #define TEXF_FORCELINEAR 0x00000080
  15 // indicates texture should be affected by gl_picmip and gl_max_size cvar
  16 #define TEXF_PICMIP 0x00000100
  17 // indicates texture should be compressed if possible
  18 #define TEXF_COMPRESS 0x00000200
  19 // use this flag to block R_PurgeTexture from freeing a texture (only used by r_texture_white and similar which may be used in skinframe_t)
  20 #define TEXF_PERSISTENT 0x00000400
  21 // indicates texture should use GL_COMPARE_R_TO_TEXTURE mode
  22 #define TEXF_COMPARE 0x00000800
  23 // indicates texture should use lower precision where supported
  24 #define TEXF_LOWPRECISION 0x00001000
  25 // indicates texture should support R_UpdateTexture, actual uploads may be delayed until R_Mesh_TexBind if gl_nopartialtextureupdates is on
  26 #define TEXF_ALLOWUPDATES 0x00002000
  27 // used for checking if textures mismatch
  28 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS | TEXF_COMPARE | TEXF_LOWPRECISION)
  29
  30 typedef enum textype_e
  31 {
  32         // 8bit paletted
  33         TEXTYPE_PALETTE,
  34         // 32bit RGBA
  35         TEXTYPE_RGBA,
  36         // 32bit BGRA (preferred format due to faster uploads on most hardware)
  37         TEXTYPE_BGRA,
  38         // 16bit D16 (16bit depth) or 32bit S8D24 (24bit depth, 8bit stencil unused)
  39         TEXTYPE_SHADOWMAP,
  40         // 8bit ALPHA (used for freetype fonts)
  41         TEXTYPE_ALPHA,
  42         // 4x4 block compressed 15bit color (4 bits per pixel)
  43         TEXTYPE_DXT1,
  44         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel)
  45         TEXTYPE_DXT1A,
  46         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
  47         TEXTYPE_DXT3,
  48         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
  49         TEXTYPE_DXT5,
  50         // this represents the same format as the framebuffer, for fast copies
  51         TEXTYPE_COLORBUFFER,
  52 }
  53 textype_t;
  54
  55 // contents of this structure are mostly private to gl_textures.c
  56 typedef struct rtexture_s
  57 {
  58         // this is exposed (rather than private) for speed reasons only
  59         int texnum;
  60         qboolean dirty;
  61         int gltexturetypeenum; // exposed for use in R_Mesh_TexBind
  62 }
  63 rtexture_t;
  64
  65 // contents of this structure are private to gl_textures.c
  66 typedef struct rtexturepool_s
  67 {
  68         int useless;
  69 }
  70 rtexturepool_t;
  71
  72 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
  73
  74 // allocate a texture pool, to be used with R_LoadTexture
  75 rtexturepool_t *R_AllocTexturePool(void);
  76 // free a texture pool (textures can not be freed individually)
  77 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
  78
  79 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
  80 extern cvar_t gl_texturecompression;
  81 extern cvar_t gl_texturecompression_color;
  82 extern cvar_t gl_texturecompression_normal;
  83 extern cvar_t gl_texturecompression_gloss;
  84 extern cvar_t gl_texturecompression_glow;
  85 extern cvar_t gl_texturecompression_2d;
  86 extern cvar_t gl_texturecompression_q3bsplightmaps;
  87 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
  88 extern cvar_t gl_texturecompression_sky;
  89 extern cvar_t gl_texturecompression_lightcubemaps;
  90 extern cvar_t gl_texturecompression_reflectmask;
  91
  92 // add a texture to a pool and optionally precache (upload) it
  93 // (note: data == NULL is perfectly acceptable)
  94 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
  95 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);
  96 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);
  97 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);
  98 rtexture_t *R_LoadTextureRectangle(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, const unsigned char *data, textype_t textype, int flags, const unsigned int *palette);
  99 rtexture_t *R_LoadTextureShadowMapRectangle(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
 100 rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, int precision, qboolean filter);
 101 rtexture_t *R_LoadTextureShadowMapCube(rtexturepool_t *rtexturepool, const char *identifier, int width, int precision, qboolean filter);
 102 rtexture_t *R_LoadTextureDDSFile(rtexturepool_t *rtexturepool, const char *filename, int flags, qboolean *hasalphaflag, float *avgcolor);
 103
 104 // saves a texture to a DDS file
 105 int R_SaveTextureDDSFile(rtexture_t *rt, const char *filename, qboolean skipuncompressed);
 106
 107 // free a texture
 108 void R_FreeTexture(rtexture_t *rt);
 109
 110 // update a portion of the image data of a texture, used by lightmap updates
 111 // and procedural textures such as video playback, actual uploads may be
 112 // delayed by gl_nopartialtextureupdates cvar until R_Mesh_TexBind uses it
 113 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int width, int height);
 114
 115 // returns the renderer dependent texture slot number (call this before each
 116 // use, as a texture might not have been precached)
 117 #define R_GetTexture(rt) ((rt) ? ((rt)->dirty ? R_RealGetTexture(rt) : (rt)->texnum) : r_texture_white->texnum)
 118 int R_RealGetTexture (rtexture_t *rt);
 119
 120 // returns width of texture, as was specified when it was uploaded
 121 int R_TextureWidth(rtexture_t *rt);
 122
 123 // returns height of texture, as was specified when it was uploaded
 124 int R_TextureHeight(rtexture_t *rt);
 125
 126 // only frees the texture if TEXF_PERSISTENT is not set
 127 // also resets the variable
 128 void R_PurgeTexture(rtexture_t *prt);
 129
 130 // frees processing buffers each frame, and may someday animate procedural textures
 131 void R_Textures_Frame(void);
 132
 133 // maybe rename this - sounds awful? [11/21/2007 Black]
 134 void R_MarkDirtyTexture(rtexture_t *rt);
 135 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
 136
 137 // Clear the texture's contents
 138 void R_ClearTexture (rtexture_t *rt);
 139
 140 #endif
 141