From 663609de317b8d65290b8d6a3bf9996d32ac8a94 Mon Sep 17 00:00:00 2001 From: James Turk Date: Sun, 5 Oct 2003 19:42:34 +0000 Subject: [PATCH] documentation --- include/ZE_Utility.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/include/ZE_Utility.h b/include/ZE_Utility.h index 6997d24..de13936 100755 --- a/include/ZE_Utility.h +++ b/include/ZE_Utility.h @@ -14,7 +14,7 @@ Definition file for ZEngine Utilities which are used throughout the engine and can be used in conjunction with ZEngine. -
$Id: ZE_Utility.h,v 1.6 2003/09/24 01:49:52 cozman Exp $
+
$Id: ZE_Utility.h,v 1.7 2003/10/05 19:42:34 cozman Exp $
\author James Turk **/ @@ -38,6 +38,17 @@ namespace ZE **/ std::string FormatStr(const char *fmtstr, ...); +/*! + \brief Extracts a SDL_RWops memory structure from a zip archive. + + Attempts to open a file from within a zipfile and return a SDL_RWops which can be used + to load a resource from memory. Used by 'LoadFromZip' members of ZImage/ZSound/ZFont + so generally not called. + \param zipname Name of zip-format archive to open. + \param filename Name of file within archive to access. + \return On success, pointer to SDL_RWops, on failure, NULL. + \since 0.8.5 +**/ SDL_RWops* RWFromZip(std::string zipname, std::string filename); /*!