<!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>Crystal Space 1.2.1: csBitmaskToString Class Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>csBitmaskToString Class Reference<br> <small> [<a class="el" href="group__util.html">Utilities</a>]</small> </h1><!-- doxytag: class="csBitmaskToString" -->Small helper to get a "pretty" string for a combination of bit masks. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="bitmasktostr_8h-source.html">cstool/bitmasktostr.h</a>></code> <p> <p> <a href="classcsBitmaskToString-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBitmaskToString.html#92908c3153facc9e054be8b2c999b0cd">GetStr</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> mask, const <a class="el" href="structcsBitmaskToString_1_1MaskNames.html">MaskNames</a> *names)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">string used to store the prettified strings. <a href="#92908c3153facc9e054be8b2c999b0cd"></a><br></td></tr> <tr><td colspan="2"><br><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsBitmaskToString_1_1MaskNames.html">MaskNames</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Structure containing a name for possible bit masks. <a href="structcsBitmaskToString_1_1MaskNames.html#_details">More...</a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Small helper to get a "pretty" string for a combination of bit masks. <p>Definition at line <a class="el" href="bitmasktostr_8h-source.html#l00036">36</a> of file <a class="el" href="bitmasktostr_8h-source.html">bitmasktostr.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="92908c3153facc9e054be8b2c999b0cd"></a><!-- doxytag: member="csBitmaskToString::GetStr" ref="92908c3153facc9e054be8b2c999b0cd" args="(uint mask, const MaskNames *names)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static const char* csBitmaskToString::GetStr </td> <td>(</td> <td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td> <td class="paramname"> <em>mask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structcsBitmaskToString_1_1MaskNames.html">MaskNames</a> * </td> <td class="paramname"> <em>names</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> string used to store the prettified strings. <p> Retrieve "pretty" string for value composed of bit masks ORed together. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>The value for which a string should be retrieved. </td></tr> <tr><td valign="top"></td><td valign="top"><em>names</em> </td><td>Table with bitmask-to-name mappings. Last entry must be {0, 0}. </td></tr> </table> </dl> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The returned string is only valid until the next call to <a class="el" href="classcsBitmaskToString.html#92908c3153facc9e054be8b2c999b0cd" title="string used to store the prettified strings.">GetStr()</a>. </dd></dl> <p>Definition at line <a class="el" href="bitmasktostr_8h-source.html#l00057">57</a> of file <a class="el" href="bitmasktostr_8h-source.html">bitmasktostr.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>cstool/<a class="el" href="bitmasktostr_8h-source.html">bitmasktostr.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>