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 // multiply RGB by A channel before uploading
  10 #define TEXF_RGBMULTIPLYBYALPHA 0x00000004
  11 // indicates texture coordinates should be clamped rather than wrapping
  12 #define TEXF_CLAMP 0x00000020
  13 // indicates texture should be uploaded using GL_NEAREST or GL_NEAREST_MIPMAP_NEAREST mode
  14 #define TEXF_FORCENEAREST 0x00000040
  15 // indicates texture should be uploaded using GL_LINEAR or GL_LINEAR_MIPMAP_NEAREST or GL_LINEAR_MIPMAP_LINEAR mode
  16 #define TEXF_FORCELINEAR 0x00000080
  17 // indicates texture should be affected by gl_picmip and gl_max_size cvar
  18 #define TEXF_PICMIP 0x00000100
  19 // indicates texture should be compressed if possible
  20 #define TEXF_COMPRESS 0x00000200
  21 // 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)
  22 #define TEXF_PERSISTENT 0x00000400
  23 // indicates texture should use GL_COMPARE_R_TO_TEXTURE mode
  24 #define TEXF_COMPARE 0x00000800
  25 // indicates texture should use lower precision where supported
  26 #define TEXF_LOWPRECISION 0x00001000
  27 // indicates texture should support R_UpdateTexture on small regions, actual uploads may be delayed until R_Mesh_TexBind if gl_nopartialtextureupdates is on
  28 #define TEXF_ALLOWUPDATES 0x00002000
  29 // indicates texture should be affected by gl_picmip_world and r_picmipworld (maybe others in the future) instead of gl_picmip_other
  30 #define TEXF_ISWORLD 0x00004000
  31 // indicates texture should be affected by gl_picmip_sprites and r_picmipsprites (maybe others in the future) instead of gl_picmip_other
  32 #define TEXF_ISSPRITE 0x00008000
  33 // indicates the texture will be used as a render target (D3D hint)
  34 #define TEXF_RENDERTARGET 0x0010000
  35 // used for checking if textures mismatch
  36 #define TEXF_IMPORTANTBITS (TEXF_ALPHA | TEXF_MIPMAP | TEXF_RGBMULTIPLYBYALPHA | TEXF_CLAMP | TEXF_FORCENEAREST | TEXF_FORCELINEAR | TEXF_PICMIP | TEXF_COMPRESS | TEXF_COMPARE | TEXF_LOWPRECISION | TEXF_RENDERTARGET)
  37 // set as a flag to force the texture to be reloaded
  38 #define TEXF_FORCE_RELOAD 0x80000000
  39
  40 typedef enum textype_e
  41 {
  42         // placeholder for unused textures in r_rendertarget_t
  43         TEXTYPE_UNUSED,
  44
  45         // 8bit paletted
  46         TEXTYPE_PALETTE,
  47         // 32bit RGBA
  48         TEXTYPE_RGBA,
  49         // 32bit BGRA (preferred format due to faster uploads on most hardware)
  50         TEXTYPE_BGRA,
  51         // 8bit ALPHA (used for freetype fonts)
  52         TEXTYPE_ALPHA,
  53         // 4x4 block compressed 15bit color (4 bits per pixel)
  54         TEXTYPE_DXT1,
  55         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel)
  56         TEXTYPE_DXT1A,
  57         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
  58         TEXTYPE_DXT3,
  59         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel)
  60         TEXTYPE_DXT5,
  61
  62         // default compressed type for GLES2
  63         TEXTYPE_ETC1,
  64
  65         // 8bit paletted in sRGB colorspace
  66         TEXTYPE_SRGB_PALETTE,
  67         // 32bit RGBA in sRGB colorspace
  68         TEXTYPE_SRGB_RGBA,
  69         // 32bit BGRA (preferred format due to faster uploads on most hardware) in sRGB colorspace
  70         TEXTYPE_SRGB_BGRA,
  71         // 4x4 block compressed 15bit color (4 bits per pixel) in sRGB colorspace
  72         TEXTYPE_SRGB_DXT1,
  73         // 4x4 block compressed 15bit color plus 1bit alpha (4 bits per pixel) in sRGB colorspace
  74         TEXTYPE_SRGB_DXT1A,
  75         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel) in sRGB colorspace
  76         TEXTYPE_SRGB_DXT3,
  77         // 4x4 block compressed 15bit color plus 8bit alpha (8 bits per pixel) in sRGB colorspace
  78         TEXTYPE_SRGB_DXT5,
  79
  80         // this represents the same format as the framebuffer, for fast copies
  81         TEXTYPE_COLORBUFFER,
  82         // this represents an RGBA half_float texture (4 16bit floats)
  83         TEXTYPE_COLORBUFFER16F,
  84         // this represents an RGBA float texture (4 32bit floats)
  85         TEXTYPE_COLORBUFFER32F,
  86         // depth-stencil buffer (or texture)
  87         TEXTYPE_DEPTHBUFFER16,
  88         // depth-stencil buffer (or texture)
  89         TEXTYPE_DEPTHBUFFER24,
  90         // 32bit D24S8 buffer (24bit depth, 8bit stencil), not supported on OpenGL ES
  91         TEXTYPE_DEPTHBUFFER24STENCIL8,
  92         // shadowmap-friendly format with depth comparison (not supported on some hardware)
  93         TEXTYPE_SHADOWMAP16_COMP,
  94         // shadowmap-friendly format with raw reading (not supported on some hardware)
  95         TEXTYPE_SHADOWMAP16_RAW,
  96         // shadowmap-friendly format with depth comparison (not supported on some hardware)
  97         TEXTYPE_SHADOWMAP24_COMP,
  98         // shadowmap-friendly format with raw reading (not supported on some hardware)
  99         TEXTYPE_SHADOWMAP24_RAW,
 100 }
 101 textype_t;
 102
 103 // contents of this structure are mostly private to gl_textures.c
 104 typedef struct rtexture_s
 105 {
 106         // this is exposed (rather than private) for speed reasons only
 107         int texnum; // GL texture slot number
 108         int renderbuffernum; // GL renderbuffer slot number
 109         qboolean dirty; // indicates that R_RealGetTexture should be called
 110         qboolean glisdepthstencil; // indicates that FBO attachment has to be GL_DEPTH_STENCIL_ATTACHMENT
 111         int gltexturetypeenum; // used by R_Mesh_TexBind
 112 }
 113 rtexture_t;
 114
 115 // contents of this structure are private to gl_textures.c
 116 typedef struct rtexturepool_s
 117 {
 118         int useless;
 119 }
 120 rtexturepool_t;
 121
 122 typedef void (*updatecallback_t)(rtexture_t *rt, void *data);
 123
 124 // allocate a texture pool, to be used with R_LoadTexture
 125 rtexturepool_t *R_AllocTexturePool(void);
 126 // free a texture pool (textures can not be freed individually)
 127 void R_FreeTexturePool(rtexturepool_t **rtexturepool);
 128
 129 // the color/normal/etc cvars should be checked by callers of R_LoadTexture* functions to decide whether to add TEXF_COMPRESS to the flags
 130 extern cvar_t gl_texturecompression;
 131 extern cvar_t gl_texturecompression_color;
 132 extern cvar_t gl_texturecompression_normal;
 133 extern cvar_t gl_texturecompression_gloss;
 134 extern cvar_t gl_texturecompression_glow;
 135 extern cvar_t gl_texturecompression_2d;
 136 extern cvar_t gl_texturecompression_q3bsplightmaps;
 137 extern cvar_t gl_texturecompression_q3bspdeluxemaps;
 138 extern cvar_t gl_texturecompression_sky;
 139 extern cvar_t gl_texturecompression_lightcubemaps;
 140 extern cvar_t gl_texturecompression_reflectmask;
 141 extern cvar_t r_texture_dds_load;
 142 extern cvar_t r_texture_dds_save;
 143
 144 // add a texture to a pool and optionally precache (upload) it
 145 // (note: data == NULL is perfectly acceptable)
 146 // (note: palette must not be NULL if using TEXTYPE_PALETTE)
 147 rtexture_t *R_LoadTexture2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, const unsigned char *data, textype_t textype, int flags, int miplevel, const unsigned int *palette);
 148 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, int miplevel, const unsigned int *palette);
 149 rtexture_t *R_LoadTextureCubeMap(rtexturepool_t *rtexturepool, const char *identifier, int width, const unsigned char *data, textype_t textype, int flags, int miplevel, const unsigned int *palette);
 150 rtexture_t *R_LoadTextureShadowMap2D(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, textype_t textype, qboolean filter);
 151 rtexture_t *R_LoadTextureRenderBuffer(rtexturepool_t *rtexturepool, const char *identifier, int width, int height, textype_t textype);
 152 rtexture_t *R_LoadTextureDDSFile(rtexturepool_t *rtexturepool, const char *filename, qboolean srgb, int flags, qboolean *hasalphaflag, float *avgcolor, int miplevel, qboolean optionaltexture);
 153
 154 // saves a texture to a DDS file
 155 int R_SaveTextureDDSFile(rtexture_t *rt, const char *filename, qboolean skipuncompressed, qboolean hasalpha);
 156
 157 // free a texture
 158 void R_FreeTexture(rtexture_t *rt);
 159
 160 // update a portion of the image data of a texture, used by lightmap updates
 161 // and procedural textures such as video playback, actual uploads may be
 162 // delayed by gl_nopartialtextureupdates cvar until R_Mesh_TexBind uses it
 163 void R_UpdateTexture(rtexture_t *rt, const unsigned char *data, int x, int y, int z, int width, int height, int depth);
 164
 165 // returns the renderer dependent texture slot number (call this before each
 166 // use, as a texture might not have been precached)
 167 #define R_GetTexture(rt) ((rt) ? ((rt)->dirty ? R_RealGetTexture(rt) : (rt)->texnum) : r_texture_white->texnum)
 168 int R_RealGetTexture (rtexture_t *rt);
 169
 170 // returns width of texture, as was specified when it was uploaded
 171 int R_TextureWidth(rtexture_t *rt);
 172
 173 // returns height of texture, as was specified when it was uploaded
 174 int R_TextureHeight(rtexture_t *rt);
 175
 176 // returns flags of texture, as was specified when it was uploaded
 177 int R_TextureFlags(rtexture_t *rt);
 178
 179 // only frees the texture if TEXF_PERSISTENT is not set
 180 // also resets the variable
 181 void R_PurgeTexture(rtexture_t *prt);
 182
 183 // frees processing buffers each frame, and may someday animate procedural textures
 184 void R_Textures_Frame(void);
 185
 186 // maybe rename this - sounds awful? [11/21/2007 Black]
 187 void R_MarkDirtyTexture(rtexture_t *rt);
 188 void R_MakeTextureDynamic(rtexture_t *rt, updatecallback_t updatecallback, void *data);
 189
 190 // Clear the texture's contents
 191 void R_ClearTexture (rtexture_t *rt);
 192
 193 // returns the desired picmip level for given TEXF_ flags
 194 int R_PicmipForFlags(int flags);
 195
 196 void R_TextureStats_Print(qboolean printeach, qboolean printpool, qboolean printtotal);
 197
 198 #endif
 199