148 lines
6.2 KiB
HTML
Executable File
148 lines
6.2 KiB
HTML
Executable File
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>ZE_Utility.h File Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3-rc2 -->
|
|
<center>
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
|
|
<hr><h1>/include/ZE_Utility.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
<dl compact><dt><b>File Header: </b></dt><dd>File: <a class="el" href="ZE__Utility_8h.html">ZE_Utility.h</a> <br>
|
|
Description: Header file for ZEngine Utilities. <br>
|
|
Author(s): James Turk <br>
|
|
<dl compact><dt><b>Id</b></dt><dd><a class="el" href="ZE__Utility_8h.html">ZE_Utility.h</a>,v 1.1 2003/01/15 05:31:51 cozman Exp </dd></dl>
|
|
<br>
|
|
</dd></dl>
|
|
|
|
<p>
|
|
Definition file for ZEngine Utilities which are used throughout the engine and can be used in conjunction with ZEngine.
|
|
<p>
|
|
<code>#include "<a class="el" href="ZE__Includes_8h-source.html">ZE_Includes.h</a>"</code><br>
|
|
|
|
<p>
|
|
<a href="ZE__Utility_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>namespace </td><td valign=bottom><a class="el" href="namespaceZE.html">ZE</a></td></tr>
|
|
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a0">FreeImage</a>(image) if(image){SDL_FreeSurface(image); image = NULL;}</td></tr>
|
|
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a1">FreeSound</a>(sound) if(sound){Mix_FreeChunk(sound); sound = NULL;}</td></tr>
|
|
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a2">FreeMusic</a>(music) if(music){Mix_FreeMusic(music); music = NULL;}</td></tr>
|
|
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="ZE__Utility_8h.html#a3">FreeFont</a>(font) if(font){TTF_CloseFont(font); font = NULL;}</td></tr>
|
|
</table>
|
|
<hr><h2>Define Documentation</h2>
|
|
<a name="a0" doxytag="ZE_Utility.h::FreeImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> #define FreeImage</td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">image </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap> if(image){SDL_FreeSurface(image); image = NULL;}
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Safely free an SDL_Surface* and set it to NULL. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a1" doxytag="ZE_Utility.h::FreeSound"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> #define FreeSound</td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">sound </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap> if(sound){Mix_FreeChunk(sound); sound = NULL;}
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Safely free a Mix_Chunk* and set it to NULL. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="ZE_Utility.h::FreeMusic"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> #define FreeMusic</td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">music </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap> if(music){Mix_FreeMusic(music); music = NULL;}
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Safely free a Mix_Music* and set it to NULL. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="ZE_Utility.h::FreeFont"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> #define FreeFont</td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">font </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap> if(font){TTF_CloseFont(font); font = NULL;}
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Safely free a TTF_Font and set it to NULL. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><address style="align: right;"><small>Generated on Sun Apr 27 17:56:46 2003 for ZEngine by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0
|
|
width=110 height=53></a>1.3-rc2 </small></address>
|
|
</body>
|
|
</html>
|