User:Monster Iestyn/Source Code Documentation/w_wad.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	__W_WAD__

Includes

The files below will be included if HWRENDER is defined:

• hardware/hw_data.h
• m_aatree.h

Typedefs

Name	Type	Attributes	Description
filelump_t	struct	ATTRPACK	A raw entry of the WAD directory.
wadinfo_t	struct		The header of a WAD file.
compmethod	enum		Available compression methods for lumps.
lumpinfo_t	struct		A memory entry of the WAD directory.
restype_t enum restype	enum		Resource type of the WAD.
wadfile_t struct wadfile_s	struct		A WAD file loaded into SRB2.

Macros

Macro	Defined as	Description
MAX_WADPATH	512
MAX_WADFILES	48
lumpcache_t	void *
WADFILENUM(lumpnum)	(UINT16)((lumpnum)>>16)
LUMPNUM(lumpnum)	(UINT16)((lumpnum)&0xFFFF)
W_CachePatchNum(lumpnum, tag)	W_CacheLumpNum(lumpnum, tag)	This definition is used only if HWRENDER is not defined

Externs

Data name	Data type	Non-extern location(s)	Description
numwadfiles	UINT16	w_wad.c	Number of files loaded in SRB2.
*wadfiles[MAX_WADFILES]	wadfile_t	w_wad.c	The array storing data for all files loaded in SRB2.

Function prototypes

Function name	Return type	Params	Defined in	Description
W_Shutdown	void	none	w_wad.c
W_OpenWadFile	FILE *	const char **filename, boolean useerrors	w_wad.c
W_InitFile	INT16	const char *filename, boolean mainfile	w_wad.c
W_InitMultipleFiles	INT32	char **filenames, UINT16 mainfiles	w_wad.c
W_CheckNameForNumPwad	const char *	UINT16 wad, UINT16 lump	w_wad.c
W_CheckNumForFullNamePK3	const char *	UINT16 wad, UINT16 lump	w_wad.c
W_CheckNumForFolderStartPK3	const char *	UINT16 wad, UINT16 lump	w_wad.c
W_CheckNumForFolderEndPK3	const char *	UINT16 wad, UINT16 lump	w_wad.c
W_CheckNumForMap	const char *	lumpnum_t lumpnum	w_wad.c
W_CheckNameForNum	const char *	lumpnum_t lumpnum	w_wad.c
W_CheckNumForNamePwad	UINT16	const char *name, UINT16 wad, UINT16 startlump	w_wad.c
W_CheckNumForName	lumpnum_t	const char *name	w_wad.c
W_GetNumForName	lumpnum_t	const char *name	w_wad.c
W_CheckNumForNameInBlock	lumpnum_t	const char *name, ,const char *blockstart const char *blockend	w_wad.c
W_LumpExists	UINT8	const char *name	w_wad.c
W_LumpLengthPwad	size_t	UINT16 wad, UINT16 lump	w_wad.c
W_LumpLength	size_t	lumpnum_t lumpnum	w_wad.c
W_IsLumpWad	boolean	lumpnum_t lumpnum	w_wad.c
W_IsLumpFolder	boolean	UINT16 wad, UINT16 lump	w_wad.c
zerr	int	int ret	w_wad.c	Declared only if HAVE_ZLIB is defined
W_ReadLumpHeaderPwad	size_t	UINT16 wad, UINT16 lump, void *dest, size_t size, size_t offset	w_wad.c
W_ReadLumpHeader	size_t	lumpnum_t lump, void *dest, size_t size, size_t offset	w_wad.c
W_ReadLumpPwad	void	UINT16 wad, UINT16 lump, void *dest	w_wad.c
W_ReadLump	void	lumpnum_t lump, void *dest	w_wad.c
W_CacheLumpNumPwad	void *	UINT16 wad, UINT16 lump, INT32 tag	w_wad.c
W_CacheLumpNum	void *	lumpnum_t lump, INT32 tag	w_wad.c
W_CacheLumpNumForce	void *	lumpnum_t lumpnum, INT32 tag	w_wad.c
W_IsLumpCached	boolean	lumpnum_t lump, void *ptr	w_wad.c
W_IsPatchCached	boolean	lumpnum_t lump, void *ptr	w_wad.c
W_CacheLumpName	void *	const char *name	w_wad.c
W_CachePatchName	void *	const char *name	w_wad.c
W_CachePatchNumPwad	void *	UINT16 wad, UINT16 lump, INT32 tag	w_wad.c
W_CachePatchNum	void *	lumpnum_t lump, INT32 tag	w_wad.c
W_UnlockCachedPatch	void	void *patch	w_wad.c
W_VerifyFileMD5	void	UINT16 wadfilenum, const char *matchmd5	w_wad.c
W_VerifyNMUSlumps	int	const char *filename	w_wad.c