systemvars.h File Reference

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

Go to the source code of this file.

Classes
struct	vei
struct	vci
struct	detail_levels
struct	profile_sample
struct	profile_sample_history
class	profile_auto

Macros
#define	GM_MULTIPLAYER   (1 << 0)
#define	GM_NORMAL   (1 << 1)
#define	GM_DEAD_DIED   (1 << 2)
#define	GM_DEAD_BLEW_UP   (1 << 3)
#define	GM_DEAD_ABORTED   (1 << 4)
#define	GM_IN_MISSION   (1 << 5)
#define	GM_DEAD   (GM_DEAD_DIED | GM_DEAD_BLEW_UP | GM_DEAD_ABORTED)
#define	GM_STANDALONE_SERVER   (1 << 8)
#define	GM_STATS_TRANSFER   (1 << 9)
#define	GM_CAMPAIGN_MODE   (1 << 10)
#define	VM_EXTERNAL   (1 << 0)
#define	VM_TRACK   (1 << 1)
#define	VM_DEAD_VIEW   (1 << 2)
#define	VM_CHASE   (1 << 3)
#define	VM_OTHER_SHIP   (1 << 4)
#define	VM_EXTERNAL_CAMERA_LOCKED   (1 << 5)
#define	VM_WARP_CHASE   (1 << 6)
#define	VM_PADLOCK_UP   (1 << 7)
#define	VM_PADLOCK_REAR   (1 << 8)
#define	VM_PADLOCK_LEFT   (1 << 9)
#define	VM_PADLOCK_RIGHT   (1 << 10)
#define	VM_WARPIN_ANCHOR   (1 << 11)
#define	VM_TOPDOWN   (1 << 12)
#define	VM_FREECAMERA   (1 << 13)
#define	VM_PADLOCK_ANY   (VM_PADLOCK_UP|VM_PADLOCK_REAR|VM_PADLOCK_LEFT|VM_PADLOCK_RIGHT)
#define	CUB_NONE   0
#define	CUB_CUTSCENE   (1<<0)
#define	CUB_GRADUAL   (1<<15)
#define	SINGLEPLAYER   !(Game_mode & GM_MULTIPLAYER)
#define	DETAIL_DEFAULT   (0xFFFFFFFF)
#define	DETAIL_FLAG_STARS   (1<<0)
#define	DETAIL_FLAG_NEBULAS   (1<<1)
#define	DETAIL_FLAG_MOTION   (1<<2)
#define	DETAIL_FLAG_PLANETS   (1<<3)
#define	DETAIL_FLAG_MODELS   (1<<4)
#define	DETAIL_FLAG_LASERS   (1<<5)
#define	DETAIL_FLAG_CLEAR   (1<<6)
#define	DETAIL_FLAG_HUD   (1<<7)
#define	DETAIL_FLAG_FIREBALLS   (1<<8)
#define	DETAIL_FLAG_COLLISION   (1<<9)
#define	NOISE_NUM_FRAMES   15
#define	NUM_SKILL_LEVELS   5
#define	MAX_DETAIL_LEVEL   4
#define	NUM_DEFAULT_DETAIL_LEVELS   4
#define	PROFILE(name, function)   { profile_begin(name); function; profile_end(name); }
#define	MAX_LIGHTS   256
#define	MAX_LIGHT_LEVELS   16
#define	safe_kill(a)   if(a)vm_free(a)

Typedefs
typedef struct vei	vei
typedef struct vci	vci
typedef struct detail_levels	detail_levels
typedef struct profile_sample	profile_sample
typedef struct profile_sample_history	profile_sample_history

Enumerations
enum	FadeType { FI_NONE, FI_FADEIN, FI_FADEOUT }

Functions
void	detail_level_set (int level)
int	current_detail_level ()
void	profile_init ()
	Called once at engine initialization to set the timer. More...
void	profile_deinit ()
void	profile_begin (const char *name)
void	profile_begin (SCP_string &output_handle, const char *name)
void	profile_end (const char *name)
void	profile_dump_output ()
void	store_profile_in_history (SCP_string &name, float percent, uint time)
void	get_profile_from_history (SCP_string &name, float *avg, float *min, float *max, uint *avg_micro_sec, uint *min_micro_sec, uint *max_micro_sec)
void	windebug_memwatch_init ()
void	insertion_sort (void *array, size_t array_size, size_t element_size, int(*fncompare)(const void *, const void *))

Variables
float	Cutscene_bars_progress
float	Cutscene_delta_time
int	Cutscene_bar_flags
shader	Viewer_shader
FadeType	Fade_type
int	Fade_start_timestamp
int	Fade_end_timestamp
fix	Missiontime
fix	Skybox_timestamp
fix	Frametime
int	Framecount
int	Game_mode
int	Viewer_mode
int	Rand_count
int	Game_restoring
int	Game_detail_level
uint	Game_detail_flags
angles	Viewer_slew_angles
vei	Viewer_external_info
vci	Viewer_chase_info
vec3d	leaning_position
int	Is_standalone
int	Interface_framerate
int	Interface_last_tick
float	Noise [NOISE_NUM_FRAMES]
bool	Basemap_override
bool	Envmap_override
bool	Specmap_override
bool	Normalmap_override
bool	Heightmap_override
bool	Glowpoint_override
bool	Glowpoint_use_depth_buffer
bool	GLSL_override
bool	PostProcessing_override
bool	Teamcolor_override
bool	Shadow_override
detail_levels	Detail
SCP_string	profile_output
int	TotalRam

Macro Definition Documentation

#define CUB_CUTSCENE   (1<<0)

Definition at line 52 of file systemvars.h.

#define CUB_GRADUAL   (1<<15)

Definition at line 54 of file systemvars.h.

#define CUB_NONE   0

Definition at line 50 of file systemvars.h.

#define DETAIL_DEFAULT   (0xFFFFFFFF)

Definition at line 105 of file systemvars.h.

#define DETAIL_FLAG_CLEAR   (1<<6)

Definition at line 113 of file systemvars.h.

#define DETAIL_FLAG_COLLISION   (1<<9)

Definition at line 116 of file systemvars.h.

#define DETAIL_FLAG_FIREBALLS   (1<<8)

Definition at line 115 of file systemvars.h.

#define DETAIL_FLAG_HUD   (1<<7)

Definition at line 114 of file systemvars.h.

#define DETAIL_FLAG_LASERS   (1<<5)

Definition at line 112 of file systemvars.h.

#define DETAIL_FLAG_MODELS   (1<<4)

Definition at line 111 of file systemvars.h.

#define DETAIL_FLAG_MOTION   (1<<2)

Definition at line 109 of file systemvars.h.

#define DETAIL_FLAG_NEBULAS   (1<<1)

Definition at line 108 of file systemvars.h.

#define DETAIL_FLAG_PLANETS   (1<<3)

Definition at line 110 of file systemvars.h.

#define DETAIL_FLAG_STARS   (1<<0)

Definition at line 107 of file systemvars.h.

#define GM_CAMPAIGN_MODE   (1 << 10)

Definition at line 29 of file systemvars.h.

#define GM_DEAD   (GM_DEAD_DIED | GM_DEAD_BLEW_UP | GM_DEAD_ABORTED)

Definition at line 25 of file systemvars.h.

#define GM_DEAD_ABORTED   (1 << 4)

Definition at line 22 of file systemvars.h.

#define GM_DEAD_BLEW_UP   (1 << 3)

Definition at line 21 of file systemvars.h.

#define GM_DEAD_DIED   (1 << 2)

Definition at line 20 of file systemvars.h.

#define GM_IN_MISSION   (1 << 5)

Definition at line 23 of file systemvars.h.

#define GM_MULTIPLAYER   (1 << 0)

Definition at line 18 of file systemvars.h.

#define GM_NORMAL   (1 << 1)

Definition at line 19 of file systemvars.h.

#define GM_STANDALONE_SERVER   (1 << 8)

Definition at line 27 of file systemvars.h.

#define GM_STATS_TRANSFER   (1 << 9)

Definition at line 28 of file systemvars.h.

#define MAX_DETAIL_LEVEL   4

Definition at line 159 of file systemvars.h.

#define MAX_LIGHT_LEVELS   16

Definition at line 259 of file systemvars.h.

#define MAX_LIGHTS   256

Definition at line 258 of file systemvars.h.

#define NOISE_NUM_FRAMES   15

Definition at line 130 of file systemvars.h.

#define NUM_DEFAULT_DETAIL_LEVELS   4

Definition at line 185 of file systemvars.h.

#define NUM_SKILL_LEVELS   5

Definition at line 150 of file systemvars.h.

#define PROFILE	(		name,
			function
	)		{ profile_begin(name); function; profile_end(name); }

Definition at line 251 of file systemvars.h.

#define safe_kill

(

a

)

if(a)vm_free(a)

Definition at line 261 of file systemvars.h.

#define SINGLEPLAYER   !(Game_mode & GM_MULTIPLAYER)

Definition at line 89 of file systemvars.h.

#define VM_CHASE   (1 << 3)

Definition at line 34 of file systemvars.h.

#define VM_DEAD_VIEW   (1 << 2)

Definition at line 33 of file systemvars.h.

#define VM_EXTERNAL   (1 << 0)

Definition at line 31 of file systemvars.h.

#define VM_EXTERNAL_CAMERA_LOCKED   (1 << 5)

Definition at line 36 of file systemvars.h.

#define VM_FREECAMERA   (1 << 13)

Definition at line 44 of file systemvars.h.

#define VM_OTHER_SHIP   (1 << 4)

Definition at line 35 of file systemvars.h.

#define VM_PADLOCK_ANY   (VM_PADLOCK_UP|VM_PADLOCK_REAR|VM_PADLOCK_LEFT|VM_PADLOCK_RIGHT)

Definition at line 46 of file systemvars.h.

#define VM_PADLOCK_LEFT   (1 << 9)

Definition at line 40 of file systemvars.h.

#define VM_PADLOCK_REAR   (1 << 8)

Definition at line 39 of file systemvars.h.

#define VM_PADLOCK_RIGHT   (1 << 10)

Definition at line 41 of file systemvars.h.

#define VM_PADLOCK_UP   (1 << 7)

Definition at line 38 of file systemvars.h.

#define VM_TOPDOWN   (1 << 12)

Definition at line 43 of file systemvars.h.

#define VM_TRACK   (1 << 1)

Definition at line 32 of file systemvars.h.

#define VM_WARP_CHASE   (1 << 6)

Definition at line 37 of file systemvars.h.

#define VM_WARPIN_ANCHOR   (1 << 11)

Definition at line 42 of file systemvars.h.

Typedef Documentation

typedef struct detail_levels detail_levels

typedef struct profile_sample profile_sample

typedef struct profile_sample_history profile_sample_history

typedef struct vci vci

typedef struct vei vei

Enumeration Type Documentation

enum FadeType

Enumerator
FI_NONE
FI_FADEIN
FI_FADEOUT

Definition at line 62 of file systemvars.h.

Function Documentation

int current_detail_level

(

)

Definition at line 500 of file systemvars.cpp.

void detail_level_set

(

int

level

)

Definition at line 484 of file systemvars.cpp.

void get_profile_from_history	(	SCP_string &	name,
		float *	avg,
		float *	min,
		float *	max,
		uint *	avg_micro_sec,
		uint *	min_micro_sec,
		uint *	max_micro_sec
	)

Gets the min, max and average values for a given profile

Parameters

name	The globally unique name for this profile (see profile_begin()/profile_end())
avg	Pointer to a float in which the average value will be stored (or 0.0 if no value has been saved)
min	Pointer to a float in which the minimum value will be stored (or 0.0 if no value has been saved)
max	Pointer to a float in which the maximum value will be stored (or 0.0 if no value has been saved)

Definition at line 326 of file profiling.cpp.

void insertion_sort	(	void *	array,
		size_t	array_size,
		size_t	element_size,
		int(*)(const void *, const void *)	fncompare
	)

Definition at line 599 of file systemvars.cpp.

void profile_begin

(

const char *

name

)

Used to start profiling a section of code. A section started by profile_begin needs to be closed off by calling profile_end with the same argument.

Parameters

name	A globally unique string that will be displayed in the HUD readout

Definition at line 80 of file profiling.cpp.

void profile_begin	(	SCP_string &	output_handle,
		const char *	name
	)

void profile_deinit

(

)

Definition at line 63 of file profiling.cpp.

void profile_dump_output

(

)

Builds the output text.

Definition at line 196 of file profiling.cpp.

void profile_end

(

const char *

name

)

Used to end profiling of a section of code. Note that the parameter given MUST match that of the preceding call to profile_begin

Parameters

name	A globally unique string that will be displayed in the HUD readout

Definition at line 130 of file profiling.cpp.

void profile_init

(

)

Called once at engine initialization to set the timer.

Definition at line 48 of file profiling.cpp.

void store_profile_in_history	(	SCP_string &	name,
		float	percent,
		uint	time
	)

Stores profile data in in the profile history lookup. This is used internally by the profiling code and should not be called outside of it.

Parameters

name	The globally unique name for this profile (see profile_begin()/profile_end())
percent	How much time the profiled section took to execute (as a percentage of overall frametime)

Definition at line 263 of file profiling.cpp.

void windebug_memwatch_init

(

)

Definition at line 1645 of file windebug.cpp.

Variable Documentation

bool Basemap_override

Definition at line 70 of file systemvars.cpp.

int Cutscene_bar_flags

Definition at line 32 of file systemvars.cpp.

float Cutscene_bars_progress

Definition at line 36 of file systemvars.cpp.

float Cutscene_delta_time

Definition at line 34 of file systemvars.cpp.

detail_levels Detail

Definition at line 478 of file systemvars.cpp.

bool Envmap_override

Definition at line 71 of file systemvars.cpp.

int Fade_end_timestamp

Definition at line 42 of file systemvars.cpp.

int Fade_start_timestamp

Definition at line 41 of file systemvars.cpp.

FadeType Fade_type

Definition at line 40 of file systemvars.cpp.

int Framecount

Definition at line 22 of file systemvars.cpp.

fix Frametime

Definition at line 21 of file systemvars.cpp.

uint Game_detail_flags

Definition at line 52 of file systemvars.cpp.

int Game_detail_level

Definition at line 51 of file systemvars.cpp.

int Game_mode

Definition at line 24 of file systemvars.cpp.

int Game_restoring

Definition at line 26 of file systemvars.cpp.

bool Glowpoint_override

Definition at line 75 of file systemvars.cpp.

bool Glowpoint_use_depth_buffer

Definition at line 76 of file systemvars.cpp.

bool GLSL_override

Definition at line 77 of file systemvars.cpp.

bool Heightmap_override

Definition at line 74 of file systemvars.cpp.

int Interface_framerate

Definition at line 173 of file fredstubs.cpp.

int Interface_last_tick

Definition at line 62 of file systemvars.cpp.

int Is_standalone

Definition at line 59 of file systemvars.cpp.

vec3d leaning_position

Definition at line 57 of file systemvars.cpp.

fix Missiontime

Definition at line 19 of file systemvars.cpp.

float Noise[NOISE_NUM_FRAMES]

Definition at line 83 of file systemvars.cpp.

bool Normalmap_override

Definition at line 73 of file systemvars.cpp.

bool PostProcessing_override

Definition at line 78 of file systemvars.cpp.

SCP_string profile_output

Definition at line 42 of file profiling.cpp.

int Rand_count

Definition at line 60 of file systemvars.cpp.

bool Shadow_override

Definition at line 80 of file systemvars.cpp.

fix Skybox_timestamp

Definition at line 20 of file systemvars.cpp.

bool Specmap_override

Definition at line 72 of file systemvars.cpp.

bool Teamcolor_override

Definition at line 79 of file systemvars.cpp.

int TotalRam

Definition at line 1580 of file windebug.cpp.

vci Viewer_chase_info

Definition at line 56 of file systemvars.cpp.

vei Viewer_external_info

Definition at line 55 of file systemvars.cpp.

int Viewer_mode

Definition at line 28 of file systemvars.cpp.

shader Viewer_shader

Definition at line 39 of file systemvars.cpp.

angles Viewer_slew_angles

Definition at line 54 of file systemvars.cpp.