User:Monster Iestyn/Source Code Documentation/m_misc.h

This article or section is incomplete. It doesn't have all of the necessary core information on this topic. Please help the SRB2 Wiki by finishing this article.

Online link	GitHub entry
File type	C header file
#include guard	__M_MISC__

Includes

• doomtype.h
• tables.h
• d_event.h
• command.h
• w_wad.h

Typedefs

Name	Type	Description
moviemode_t	enum
TVector[4]	fixed_t	An array for storing a fixed_t four-element vector.
TMatrix[4][4]	fixed_t	A 2-dimensional array for storing a fixed_t 4×4 matrix. The first number is the column number, the second number is the row number. (?)

Enumerations

moviemode_t

Value	Name	Description
0	MM_OFF
1	MM_APNG
2	MM_GIF
3	MM_SCREENSHOT

Externs

Data name	Data type	Non-extern location(s)	Description
moviemode	moviemode_t	m_misc.c
cv_screenshot_option cv_screenshot_folder	consvar_t	m_misc.c	screenshot_option and screenshot_folder console variable structs
cv_moviemode	consvar_t	m_misc.c	moviemode_mode console variable struct
cv_zlib_level cv_zlib_memory cv_zlib_strategy cv_zlib_window_bits	consvar_t	m_misc.c	png_compress_level, png_memory_level, png_strategy and png_window_size console variable structs
cv_zlib_levela cv_zlib_memorya cv_zlib_strategya cv_zlib_window_bitsa	consvar_t	m_misc.c	apng_compress_level, apng_memory_level, apng_strategy and apng_window_size console variable structs
cv_apng_delay	consvar_t	m_misc.c	apng_speed console variable struct
takescreenshot	boolean	m_misc.c
configfile[MAX_WADPATH]	char	m_misc.c

Function prototypes

Function name	Return type	Params	Defined in	Attributes	Description
M_StartMovie	void	none	m_misc.c
M_SaveFrame	void	none	m_misc.c
M_StopMovie	void	none	m_misc.c
M_MapNumber	INT32	char first, char second	m_misc.c
FIL_WriteFile	boolean	char const *name, const void *source, size_t length	m_misc.c
FIL_ReadFileTag	size_t	char const *name, UINT8 **buffer, INT32 tag	m_misc.c
FIL_FileExists	boolean	const char *name	m_misc.c
FIL_WriteFileOK	boolean	char const *name	m_misc.c
FIL_ReadFileOK	boolean	char const *name	m_misc.c
FIL_FileOK	boolean	char const *name	m_misc.c
FIL_DefaultExtension	void	char *path, char const *extension	m_misc.c
FIL_ForceExtension	void	char *path, char const *extension	m_misc.c
FIL_CheckExtension	boolean	const char *in	m_misc.c
M_SavePNG	boolean	const char *filename, void *data, int width, int height, const UINT8 *palette	m_misc.c		Declared only if HAVE_PNG is defined
M_ScreenShot	void	none	m_misc.c
M_DoScreenShot	void	none	m_misc.c
M_ScreenshotResponder	boolean	event_t *ev	m_misc.c
Command_SaveConfig_f	void	none	m_misc.c
Command_LoadConfig_f	void	none	m_misc.c
Command_ChangeConfig_f	void	none	m_misc.c
M_FirstLoadConfig	void	none	m_misc.c
M_SaveConfig	void	const char *filename	m_misc.c
axtoi	INT32	const char *hexStg	m_misc.c		Converts an ASCII Hex string into an integer.
GetRevisionString	const char *	none	m_misc.c		Returns a string containing the revision number of the exe. If "r" is not already present at the start of the revision number string, this function will automatically add it on anyway. Note that this function is only called if both VERSION and SUBVERSION are set to zero (typically only for development versions of the game).
VectorMatrixMultiply	TVector *	TVector v, TMatrix m	m_misc.c		Multiplies a TMatrix by a TVector and returns the resulting TVector. See also Matrix multiplication.
RotateXMatrix	TMatrix *	angle_t rad	m_misc.c		Returns the rotation TMatrix for rotating a TVector by an angle about the X axis. See also Rotation matrix > In three dimensions.
RotateZMatrix	TMatrix *	angle_t rad	m_misc.c		Returns the rotation TMatrix for rotating a TVector by an angle about the Z axis. See also Rotation matrix > In three dimensions.
strcatbf	void	char *s1, const char *s2, const char *s3	m_misc.c		Creates a string in the first argument that is the second argument followed by the third argument followed by the first argument, i.e. s1 = s2+s3+s1. Useful for making filenames with full path.
M_SetupMemcpy	void	none	m_misc.c		Setups the M_Memcpy function, depending on the system's CPU info (or the command line parameters given). MMX, 3DNow, MMXExt, or SSE may be used internally for optimization.
M_CountBits	UINT8	UINT32 num, UINT8 size	m_misc.c	FUNCMATH	Count the number of bits turned on in an integer number. num is the integer to count bits from, and size is the total number of bits to check in the integer.

Macros

Macro	Defined as	Description
CONFIGFILENAME	Dreamcast: srb2dc.cfg PSP: srb2psp.cfg Other: config.cfg
FIL_ReadFile(n, b)	FIL_ReadFileTag(n, b, PU_STATIC)