bmpman.h

Go to the documentation of this file.

#ifndef _BMPMAN_H
#define _BMPMAN_H
/*
 * Copyright (C) Volition, Inc. 1999.  All rights reserved.
 *
 * All source code herein is the property of Volition, Inc. You may not sell
 * or otherwise commercially exploit the source or things you created based on the
 * source.
 *
 */

#include "cfile/cfile.h"
#include "globalincs/pstypes.h"

#ifndef NDEBUG
#define BMPMAN_NDEBUG   
#endif

#define MAX_BITMAPS 4750

// Flag positions for bitmap.flags
// ***** NOTE:  bitmap.flags is an 8-bit value, no more BMP_TEX_* flags can be added unless the type is changed!! ******
#define BMP_AABITMAP        (1<<0)      
#define BMP_TEX_XPARENT     (1<<1)      
#define BMP_TEX_OTHER       (1<<2)      
#define BMP_TEX_DXT1        (1<<3)      
#define BMP_TEX_DXT3        (1<<4)      
#define BMP_TEX_DXT5        (1<<5)      
#define BMP_TEX_CUBEMAP     (1<<6)      

// Combined flags
#define BMP_TEX_COMP        ( BMP_TEX_DXT1 | BMP_TEX_DXT3 | BMP_TEX_DXT5 )  
#define BMP_TEX_NONCOMP     ( BMP_TEX_XPARENT | BMP_TEX_OTHER )             
#define BMP_TEX_ANY         ( BMP_TEX_COMP | BMP_TEX_NONCOMP )              

// Flag positions for bitmap.type
#define BMP_FLAG_RENDER_TARGET_STATIC       (1<<0)      
#define BMP_FLAG_RENDER_TARGET_DYNAMIC      (1<<1)      
#define BMP_FLAG_CUBEMAP                    (1<<2)      

// Bitmap types
enum BM_TYPE
{
        BM_TYPE_NONE = 0,   
        BM_TYPE_USER,       
        BM_TYPE_PCX,        
        BM_TYPE_TGA,        
        BM_TYPE_DDS,        
        BM_TYPE_PNG,        
        BM_TYPE_JPG,        
        BM_TYPE_ANI,        
        BM_TYPE_EFF,        

        // special types
        BM_TYPE_RENDER_TARGET_STATIC,   
        BM_TYPE_RENDER_TARGET_DYNAMIC,  

        // Compressed types (bitmap.c_type)
        BM_TYPE_DXT1,           
        BM_TYPE_DXT3,           
        BM_TYPE_DXT5,           
        BM_TYPE_CUBEMAP_DDS,    
        BM_TYPE_CUBEMAP_DXT1,   
        BM_TYPE_CUBEMAP_DXT3,   
        BM_TYPE_CUBEMAP_DXT5    
};

struct bitmap
{
        short   w;          
        short   h;          
        short   rowsize;    
        ubyte   bpp;        
        ubyte   true_bpp;   
        ubyte   flags;      
        ptr_u   data;       
        ubyte *palette;     
};

extern int bm_texture_ram;  

extern int Bm_paging;   

extern const BM_TYPE bm_type_list[];       
extern const char *bm_ext_list[];        
extern const int BM_NUM_TYPES;           
extern const BM_TYPE bm_ani_type_list[];   
extern const char *bm_ani_ext_list[];    
extern const int BM_ANI_NUM_TYPES;       

extern int GLOWMAP;     
extern int SPECMAP;     
extern int ENVMAP;      
extern int NORMMAP;     
extern int HEIGHTMAP;   
extern int MISCMAP;     

void bm_init();

void bm_close();

int bm_get_cache_slot(int bitmap_id, int separate_ani_frames);

int bm_get_next_handle();

void *bm_malloc(int handle, int size);

void bm_update_memory_used(int n, int size);

class bitmap_lookup {
        ubyte *Bitmap_data;

        int Width;
        int Height;
        int Num_channels;

        float map_texture_address(float address);
public:
        bitmap_lookup(int bitmap_num);
        ~bitmap_lookup();

        bool valid();

        float get_channel_red(float u, float v);
        float get_channel_green(float u, float v);
        float get_channel_blue(float u, float v);
        float get_channel_alpha(float u, float v);
};

int bm_load(const char* filename);

int bm_load(const SCP_string& filename);

int bm_load_duplicate(const char *filename);

int bm_create(int bpp, int w, int h, void *data = NULL, int flags = 0);

int bm_unload(int handle, int clear_render_targets = 0, bool nodebug = false);

int bm_unload_fast(int handle, int clear_render_targets = 0);

int bm_release(int handle, int clear_render_targets = 0);

int bm_load_animation(const char *filename, int *nframes = NULL, int *fps = NULL, int *keyframe = NULL, int can_drop_frames = 0, int dir_type = CF_TYPE_ANY);

int bm_load_either(const char *filename, int *nframes = NULL, int *fps = NULL, int *keyframe = NULL, int can_drop_frames = 0, int dir_type = CF_TYPE_ANY);

bitmap* bm_lock(int handle, ubyte bpp, ubyte flags, bool nodebug = false);

uint bm_get_signature(int handle);

BM_TYPE bm_get_type(int handle);

void bm_unlock(int handle);

int bm_is_valid(int handle);

int bm_get_info(int handle, int *w = NULL, int * h = NULL, ubyte * flags = NULL, int *nframes = NULL, int *fps = NULL);

void bm_get_filename(int bitmapnum, char *filename);

const char *bm_get_filename(int handle);

void bm_gfx_load_all();

void bm_unload_all();

void bm_get_palette(int handle, ubyte *pal, char *name);

void bm_gfx_get_pixel(int bitmap, float u, float v, ubyte *r, ubyte *g, ubyte *b);

void bm_get_frame_usage(int *ntotal, int *nnew);

int bm_reload(int bitmap_handle, const char* filename);

void bm_page_in_start();

void bm_page_in_stop();

// Paging code in a library should call these functions
// in its page in function.

void bm_page_in_texture(int bitmapnum, int num_frames = 0);

void bm_page_in_xparent_texture(int bitmapnum, int num_frames = 1);

void bm_page_in_aabitmap(int bitmapnum, int num_frames = 1);

bool bm_page_out(int handle);

void bm_set_low_mem(int mode);

void BM_SELECT_SCREEN_FORMAT();

void BM_SELECT_TEX_FORMAT();

void BM_SELECT_ALPHA_TEX_FORMAT();

extern void(*bm_set_components)(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

extern void(*bm_set_components_32)(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

void bm_set_components_argb_16_screen(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

void bm_set_components_argb_32_screen(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

void bm_set_components_argb_16_tex(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

void bm_set_components_argb_32_tex(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

void bm_get_components(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a);

int bm_is_compressed(int handle);

int bm_get_tcache_type(int handle);

size_t bm_get_size(int handle);

int bm_get_num_mipmaps(int handle);

bool bm_has_alpha_channel(int handle);

void bm_print_bitmaps();

int bm_make_render_target(int width, int height, int flags);

int bm_is_render_target(int handle);

bool bm_set_render_target(int handle, int face = -1);

bool bm_load_and_parse_eff(const char *filename, int dir_type, int *nframes, int *nfps, int *key, BM_TYPE *type);

#endif