include/neb.h

   1 /*
   2  * $Logfile: /Freespace2/code/Nebula/Neb.h $
   3  * $Revision$
   4  * $Date$
   5  * $Author$
   6  *
   7  * Nebula effect
   8  *
   9  * $Log$
  10  * Revision 1.3  2002/05/26 20:22:48  theoddone33
  11  * Most of network/ works
  12  *
  13  * Revision 1.2  2002/05/04 04:36:56  theoddone33
  14  * More changes, took out a lot of the sound stuff which will bite later but
  15  * I don't care.
  16  *
  17  * Revision 1.1.1.1  2002/05/03 03:28:12  root
  18  * Initial import.
  19  *
  20  *
  21  * 16    8/30/99 5:01p Dave
  22  * Made d3d do less state changing in the nebula. Use new chat server for
  23  * PXO.
  24  *
  25  * 15    7/29/99 12:05a Dave
  26  * Nebula speed optimizations.
  27  *
  28  * 14    7/26/99 10:12a Dave
  29  * Upped the max # of nebula backgrounds.
  30  *
  31  * 13    5/24/99 5:45p Dave
  32  * Added detail levels to the nebula, with a decent speedup. Split nebula
  33  * lightning into its own section.
  34  *
  35  * $NoKeywords: $
  36  */
  37
  38 #ifndef _FS2_NEB2_EFFECT_HEADER_FILE
  39 #define _FS2_NEB2_EFFECT_HEADER_FILE
  40
  41 // --------------------------------------------------------------------------------------------------------
  42 // NEBULA DEFINES/VARS
  43 //
  44 #include "pstypes.h"
  45
  46 struct ship;
  47 struct object;
  48 struct vector;
  49
  50 // fog near and far values for rendering the background nebula
  51 extern float Neb_backg_fog_near;
  52 extern float Neb_backg_fog_far;
  53
  54 // nebula rendering mode
  55 #define NEB2_RENDER_NONE                                                                0                       // no rendering
  56 #define NEB2_RENDER_POLY                                                                1                       // background is the old-school polygons
  57 #define NEB2_RENDER_POF                                                                 2                       // background is the nice pof file
  58 #define NEB2_RENDER_LAME                                                                3                       // super simple nebula effect
  59 extern int Neb2_render_mode;
  60
  61 // the AWACS suppresion level for the nebula
  62 extern float Neb2_awacs;
  63
  64 #define MAX_NEB2_POOFS                          6
  65
  66 // poof names and flags (for fred)
  67 extern char Neb2_poof_filenames[MAX_NEB2_POOFS][MAX_FILENAME_LEN];
  68 extern int Neb2_poof_flags;
  69
  70 #define MAX_NEB2_BITMAPS                        10
  71
  72 // pof texture filenames
  73 extern char Neb2_bitmap_filenames[MAX_NEB2_BITMAPS][MAX_FILENAME_LEN];
  74
  75 // texture to use for this level
  76 extern char Neb2_texture_name[MAX_FILENAME_LEN];
  77
  78 // how many "slices" are in the current player nebuls
  79 extern int Neb2_slices;
  80
  81 // nebula poofs
  82 typedef struct cube_poof {
  83         vector  pt;                             // point in space
  84         int             bmap;                           // bitmap in space
  85         float           rot;                            // rotation angle
  86         float           rot_speed;              // rotation speed
  87         float           flash;                  // lightning flash
  88 } cube_poof;
  89 #define MAX_CPTS                5               // should always be <= slices
  90 extern cube_poof Neb2_cubes[MAX_CPTS][MAX_CPTS][MAX_CPTS];
  91
  92
  93 // --------------------------------------------------------------------------------------------------------
  94 // NEBULA FUNCTIONS
  95 //
  96
  97 // neb2 stuff (specific nebula densities) -----------------------------------
  98
  99 // initialize neb2 stuff at game startup
 100 void neb2_init();
 101
 102 // set detail level
 103 void neb2_set_detail_level(int level);
 104
 105 // initialize nebula stuff - call from game_post_level_init(), so the mission has been loaded
 106 void neb2_level_init();
 107
 108 // shutdown nebula stuff
 109 void neb2_level_close();
 110
 111 // create a nebula object, return objnum of the nebula or -1 on fail
 112 // NOTE : in most cases you will want to pass -1.0f for outer_radius. Trust me on this
 113 int neb2_create(vector *offset, int num_poofs, float inner_radius, float outer_radius, float max_poof_radius);
 114
 115 // delete a nebula object
 116 void neb2_delete(object *objp);
 117
 118 // call before beginning all rendering
 119 void neb2_render_setup(vector *eye_pos, matrix *eye_orient);
 120
 121 // renders a nebula object
 122 void neb2_render(object *objp);
 123
 124 // preprocess the nebula object before simulation
 125 void neb2_process_pre(object *objp);
 126
 127 // process the nebula object after simulating, but before rendering
 128 void neb2_process_post(object *objp);
 129
 130 // render the player nebula
 131 void neb2_render_player();
 132
 133 // call this when the player's viewpoint has changed, this will cause the code to properly reset
 134 // the eye's local poofs
 135 void neb2_eye_changed();
 136
 137 // get near and far fog values based upon object type and rendering mode
 138 void neb2_get_fog_values(float *fnear, float *ffar, object *obj);
 139
 140 // given a position in space, return a value from 0.0 to 1.0 representing the fog level
 141 float neb2_get_fog_intensity(object *obj);
 142
 143 // should we not render this object because its obscured by the nebula?
 144 int neb2_skip_render(object *objp, float z_depth);
 145
 146 // extend LOD
 147 float neb2_get_lod_scale(int objnum);
 148
 149 // fogging stuff --------------------------------------------------
 150
 151 // get the color of the pixel in the small pre-rendered background nebula
 152 void neb2_get_pixel(int x, int y, int *r, int *g, int *b);
 153
 154 // set the background color
 155 void neb2_set_backg_color(int r, int g, int b);
 156
 157 // get the color to fog the background color to
 158 void neb2_get_backg_color(int *r, int *g, int *b);
 159
 160 #endif
 161