bm_internal.h

Go to the documentation of this file.

#ifndef __BM_INTERNAL_H__
#define __BM_INTERNAL_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.
*
*/

#ifndef BMPMAN_INTERNAL
#error The file header "bmpman/bm_internal.h" is protected. Make sure you know what you are doing!
#endif

#include "bmpman/bmpman.h"

union bm_extra_info {
        struct {
                // Stuff needed for animations
                int first_frame;    
                int num_frames;     
                int keyframe;       
                ubyte fps;          

                struct {
                        // stuff for static animations
                        BM_TYPE type;                         
                        char  filename[MAX_FILENAME_LEN];   
                } eff;
        } ani;

        struct {
                // Stuff needed for user bitmaps
                void* data;         
                ubyte bpp;          
                ubyte flags;        
        } user;
};

struct bitmap_entry {
        // identification
        char filename[MAX_FILENAME_LEN];    

        uint signature;         
        uint palette_checksum;  
        int  handle;            
        int  last_used;         

        BM_TYPE type;             
        BM_TYPE comp_type;        
        signed char ref_count;  

        int dir_type;           

        // compressed bitmap stuff (.dds) - RT please take a look at this and tell me if we really need it
        size_t mem_taken;          
        int num_mipmaps;        

        // Stuff to keep track of usage
        ubyte preloaded;        
        int   preload_count;    
        ubyte used_flags;       
        int   load_count;

        bitmap bm;              

        bm_extra_info info;     

#ifdef BMPMAN_NDEBUG
        // bookeeping
        ubyte used_last_frame;  // If set, then it was used last frame
        ubyte used_this_frame;  // If set, then it was used this frame
        int   data_size;        // How much data this bitmap uses
        int   used_count;       // How many times it was accessed
#endif
};

extern bitmap_entry bm_bitmaps[MAX_BITMAPS];

// image specific lock functions
void bm_lock_ani( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );
void bm_lock_dds( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );
void bm_lock_png( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );
void bm_lock_jpg( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );
void bm_lock_pcx( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );
void bm_lock_tga( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );
void bm_lock_user( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags );


#endif // __BM_INTERNAL_H__