[692] | 1 | <html> |
---|
| 2 | <head> |
---|
| 3 | <title>Ogre::FileHandleDataStream class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
| 4 | <link type="text/css" rel="stylesheet" href="style.css"> |
---|
| 5 | </head> |
---|
| 6 | |
---|
| 7 | <body> |
---|
| 8 | <!-- Generated by Doxygen 1.3.6 --> |
---|
| 9 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class 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">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
| 10 | <h1>Ogre::FileHandleDataStream Class Reference</h1>Common subclass of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> for handling data from C-style file handles. |
---|
| 11 | <a href="#_details">More...</a> |
---|
| 12 | <p> |
---|
| 13 | <code>#include <<a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>></code> |
---|
| 14 | <p> |
---|
| 15 | <p>Inheritance diagram for Ogre::FileHandleDataStream: |
---|
| 16 | <p><center><img src="classOgre_1_1FileHandleDataStream.png" usemap="#Ogre::FileHandleDataStream_map" border="0" alt=""></center> |
---|
| 17 | <map name="Ogre::FileHandleDataStream_map"> |
---|
| 18 | <area href="classOgre_1_1DataStream.html" alt="Ogre::DataStream" shape="rect" coords="0,0,173,24"> |
---|
| 19 | </map> |
---|
| 20 | <a href="classOgre_1_1FileHandleDataStream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
---|
| 21 | <tr><td></td></tr> |
---|
| 22 | <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
---|
| 23 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama0">FileHandleDataStream</a> (FILE *handle)</td></tr> |
---|
| 24 | |
---|
| 25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create stream from a C file handle. <a href="#Ogre_1_1FileHandleDataStreama0"></a><br><br></td></tr> |
---|
| 26 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama1">FileHandleDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, FILE *handle)</td></tr> |
---|
| 27 | |
---|
| 28 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create named stream from a C file handle. <a href="#Ogre_1_1FileHandleDataStreama1"></a><br><br></td></tr> |
---|
| 29 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama2">~FileHandleDataStream</a> ()</td></tr> |
---|
| 30 | |
---|
| 31 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama3">read</a> (void *buf, size_t count)</td></tr> |
---|
| 32 | |
---|
| 33 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 34 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 35 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
| 36 | <tr><td valign=top><em>count</em> </td><td>Number of bytes to read </td></tr> |
---|
| 37 | </table> |
---|
| 38 | </dl> |
---|
| 39 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl> |
---|
| 40 | <a href="#Ogre_1_1FileHandleDataStreama3"></a><br><br></td></tr> |
---|
| 41 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama4">readLine</a> (char *buf, size_t maxCount, const <a class="el" href="namespaceOgre.html#a471">String</a> &delim="\n")</td></tr> |
---|
| 42 | |
---|
| 43 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Remarks:</b></dt><dd>The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character. </dd></dl> |
---|
| 44 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 45 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 46 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
| 47 | <tr><td valign=top><em>maxCount</em> </td><td>The maximum length of data to be read, excluding the terminating character </td></tr> |
---|
| 48 | <tr><td valign=top><em>delim</em> </td><td>The delimiter to stop at </td></tr> |
---|
| 49 | </table> |
---|
| 50 | </dl> |
---|
| 51 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read, excluding the terminating character </dd></dl> |
---|
| 52 | <a href="#Ogre_1_1FileHandleDataStreama4"></a><br><br></td></tr> |
---|
| 53 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama5">skipLine</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &delim="\n")</td></tr> |
---|
| 54 | |
---|
| 55 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 56 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 57 | <tr><td valign=top><em>delim</em> </td><td>The delimiter(s) to stop at </td></tr> |
---|
| 58 | </table> |
---|
| 59 | </dl> |
---|
| 60 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl> |
---|
| 61 | <a href="#Ogre_1_1FileHandleDataStreama5"></a><br><br></td></tr> |
---|
| 62 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama6">skip</a> (long count)</td></tr> |
---|
| 63 | |
---|
| 64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This can also be a negative value, in which case the file pointer rewinds a defined number of bytes. <a href="#Ogre_1_1FileHandleDataStreama6"></a><br><br></td></tr> |
---|
| 65 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama7">seek</a> (size_t pos)</td></tr> |
---|
| 66 | |
---|
| 67 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileHandleDataStreama7"></a><br><br></td></tr> |
---|
| 68 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama8">tell</a> (void) const </td></tr> |
---|
| 69 | |
---|
| 70 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileHandleDataStreama8"></a><br><br></td></tr> |
---|
| 71 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama9">eof</a> (void) const </td></tr> |
---|
| 72 | |
---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileHandleDataStreama9"></a><br><br></td></tr> |
---|
| 74 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreama10">close</a> (void)</td></tr> |
---|
| 75 | |
---|
| 76 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileHandleDataStreama10"></a><br><br></td></tr> |
---|
| 77 | <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama11">getName</a> (void)</td></tr> |
---|
| 78 | |
---|
| 79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the stream, if it has one. <a href="#Ogre_1_1ZipDataStreama11"></a><br><br></td></tr> |
---|
| 80 | <tr><td class="memItemLeft" nowrap align=right valign=top>template<typename T> <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama12">operator>></a> (T &val)</td></tr> |
---|
| 81 | |
---|
| 82 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama13">getLine</a> (bool trimAfter=true)</td></tr> |
---|
| 83 | |
---|
| 84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a String containing the next line of data, optionally trimmed for whitespace. <a href="#Ogre_1_1ZipDataStreama13"></a><br><br></td></tr> |
---|
| 85 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama14">getAsString</a> (void)</td></tr> |
---|
| 86 | |
---|
| 87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a String containing the entire stream. <a href="#Ogre_1_1ZipDataStreama14"></a><br><br></td></tr> |
---|
| 88 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama15">size</a> (void) const </td></tr> |
---|
| 89 | |
---|
| 90 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. <a href="#Ogre_1_1ZipDataStreama15"></a><br><br></td></tr> |
---|
| 91 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
| 92 | <tr><td class="memItemLeft" nowrap align=right valign=top>FILE * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreamp0">mFileHandle</a></td></tr> |
---|
| 93 | |
---|
| 94 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">mName</a></td></tr> |
---|
| 95 | |
---|
| 96 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The name (e.g. resource name) that can be used to identify the source fot his data (optional). <a href="#Ogre_1_1ZipDataStreamp2"></a><br><br></td></tr> |
---|
| 97 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">mSize</a></td></tr> |
---|
| 98 | |
---|
| 99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Size of the data in the stream (may be 0 if size cannot be determined). <a href="#Ogre_1_1ZipDataStreamp3"></a><br><br></td></tr> |
---|
| 100 | <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">mTmpArea</a> [OGRE_STREAM_TEMP_SIZE]</td></tr> |
---|
| 101 | |
---|
| 102 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Temporary buffer area used for formatted read. <a href="#Ogre_1_1ZipDataStreamp4"></a><br><br></td></tr> |
---|
| 103 | </table> |
---|
| 104 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 105 | Common subclass of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> for handling data from C-style file handles. |
---|
| 106 | <p> |
---|
| 107 | <dl compact><dt><b>Remarks:</b></dt><dd>Use of this class is generally discouraged; if you want to wrap file access in a <a class="el" href="classOgre_1_1DataStream.html">DataStream</a>, you should definitely be using the C++ friendly <a class="el" href="classOgre_1_1FileStreamDataStream.html">FileStreamDataStream</a>. However, since there are quite a few applications and libraries still wedded to the old FILE handle access, this stream wrapper provides some backwards compatibility.</dd></dl> |
---|
| 108 | |
---|
| 109 | <p> |
---|
| 110 | |
---|
| 111 | <p> |
---|
| 112 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00397">397</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 113 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama0" doxytag="Ogre::FileHandleDataStream::FileHandleDataStream" ></a><p> |
---|
| 114 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 115 | <tr> |
---|
| 116 | <td class="mdRow"> |
---|
| 117 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 118 | <tr> |
---|
| 119 | <td class="md" nowrap valign="top"> Ogre::FileHandleDataStream::FileHandleDataStream </td> |
---|
| 120 | <td class="md" valign="top">( </td> |
---|
| 121 | <td class="md" nowrap valign="top">FILE * </td> |
---|
| 122 | <td class="mdname1" valign="top" nowrap> <em>handle</em> </td> |
---|
| 123 | <td class="md" valign="top"> ) </td> |
---|
| 124 | <td class="md" nowrap></td> |
---|
| 125 | </tr> |
---|
| 126 | |
---|
| 127 | </table> |
---|
| 128 | </td> |
---|
| 129 | </tr> |
---|
| 130 | </table> |
---|
| 131 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 132 | <tr> |
---|
| 133 | <td> |
---|
| 134 | |
---|
| 135 | </td> |
---|
| 136 | <td> |
---|
| 137 | |
---|
| 138 | <p> |
---|
| 139 | Create stream from a C file handle. |
---|
| 140 | <p> |
---|
| 141 | </td> |
---|
| 142 | </tr> |
---|
| 143 | </table> |
---|
| 144 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama1" doxytag="Ogre::FileHandleDataStream::FileHandleDataStream" ></a><p> |
---|
| 145 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 146 | <tr> |
---|
| 147 | <td class="mdRow"> |
---|
| 148 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 149 | <tr> |
---|
| 150 | <td class="md" nowrap valign="top"> Ogre::FileHandleDataStream::FileHandleDataStream </td> |
---|
| 151 | <td class="md" valign="top">( </td> |
---|
| 152 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
| 153 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
| 154 | </tr> |
---|
| 155 | <tr> |
---|
| 156 | <td class="md" nowrap align="right"></td> |
---|
| 157 | <td></td> |
---|
| 158 | <td class="md" nowrap>FILE * </td> |
---|
| 159 | <td class="mdname" nowrap> <em>handle</em></td> |
---|
| 160 | </tr> |
---|
| 161 | <tr> |
---|
| 162 | <td></td> |
---|
| 163 | <td class="md">) </td> |
---|
| 164 | <td class="md" colspan="2"></td> |
---|
| 165 | </tr> |
---|
| 166 | |
---|
| 167 | </table> |
---|
| 168 | </td> |
---|
| 169 | </tr> |
---|
| 170 | </table> |
---|
| 171 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 172 | <tr> |
---|
| 173 | <td> |
---|
| 174 | |
---|
| 175 | </td> |
---|
| 176 | <td> |
---|
| 177 | |
---|
| 178 | <p> |
---|
| 179 | Create named stream from a C file handle. |
---|
| 180 | <p> |
---|
| 181 | </td> |
---|
| 182 | </tr> |
---|
| 183 | </table> |
---|
| 184 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama2" doxytag="Ogre::FileHandleDataStream::~FileHandleDataStream" ></a><p> |
---|
| 185 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 186 | <tr> |
---|
| 187 | <td class="mdRow"> |
---|
| 188 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 189 | <tr> |
---|
| 190 | <td class="md" nowrap valign="top"> Ogre::FileHandleDataStream::~<a class="el" href="classOgre_1_1FileHandleDataStream.html">FileHandleDataStream</a> </td> |
---|
| 191 | <td class="md" valign="top">( </td> |
---|
| 192 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 193 | <td class="md" valign="top"> ) </td> |
---|
| 194 | <td class="md" nowrap></td> |
---|
| 195 | </tr> |
---|
| 196 | |
---|
| 197 | </table> |
---|
| 198 | </td> |
---|
| 199 | </tr> |
---|
| 200 | </table> |
---|
| 201 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 202 | <tr> |
---|
| 203 | <td> |
---|
| 204 | |
---|
| 205 | </td> |
---|
| 206 | <td> |
---|
| 207 | |
---|
| 208 | <p> |
---|
| 209 | </td> |
---|
| 210 | </tr> |
---|
| 211 | </table> |
---|
| 212 | <hr><h2>Member Function Documentation</h2> |
---|
| 213 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama10" doxytag="Ogre::FileHandleDataStream::close" ></a><p> |
---|
| 214 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 215 | <tr> |
---|
| 216 | <td class="mdRow"> |
---|
| 217 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 218 | <tr> |
---|
| 219 | <td class="md" nowrap valign="top"> void Ogre::FileHandleDataStream::close </td> |
---|
| 220 | <td class="md" valign="top">( </td> |
---|
| 221 | <td class="md" nowrap valign="top">void </td> |
---|
| 222 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 223 | <td class="md" valign="top"> ) </td> |
---|
| 224 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 225 | </tr> |
---|
| 226 | |
---|
| 227 | </table> |
---|
| 228 | </td> |
---|
| 229 | </tr> |
---|
| 230 | </table> |
---|
| 231 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 232 | <tr> |
---|
| 233 | <td> |
---|
| 234 | |
---|
| 235 | </td> |
---|
| 236 | <td> |
---|
| 237 | |
---|
| 238 | <p> |
---|
| 239 | |
---|
| 240 | <p> |
---|
| 241 | |
---|
| 242 | <p> |
---|
| 243 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama15">Ogre::DataStream</a>. </td> |
---|
| 244 | </tr> |
---|
| 245 | </table> |
---|
| 246 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama9" doxytag="Ogre::FileHandleDataStream::eof" ></a><p> |
---|
| 247 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 248 | <tr> |
---|
| 249 | <td class="mdRow"> |
---|
| 250 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 251 | <tr> |
---|
| 252 | <td class="md" nowrap valign="top"> bool Ogre::FileHandleDataStream::eof </td> |
---|
| 253 | <td class="md" valign="top">( </td> |
---|
| 254 | <td class="md" nowrap valign="top">void </td> |
---|
| 255 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 256 | <td class="md" valign="top"> ) </td> |
---|
| 257 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 258 | </tr> |
---|
| 259 | |
---|
| 260 | </table> |
---|
| 261 | </td> |
---|
| 262 | </tr> |
---|
| 263 | </table> |
---|
| 264 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 265 | <tr> |
---|
| 266 | <td> |
---|
| 267 | |
---|
| 268 | </td> |
---|
| 269 | <td> |
---|
| 270 | |
---|
| 271 | <p> |
---|
| 272 | |
---|
| 273 | <p> |
---|
| 274 | |
---|
| 275 | <p> |
---|
| 276 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama13">Ogre::DataStream</a>. </td> |
---|
| 277 | </tr> |
---|
| 278 | </table> |
---|
| 279 | <a class="anchor" name="Ogre_1_1ZipDataStreama14" doxytag="Ogre::FileHandleDataStream::getAsString" ></a><p> |
---|
| 280 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 281 | <tr> |
---|
| 282 | <td class="mdRow"> |
---|
| 283 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 284 | <tr> |
---|
| 285 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DataStream::getAsString </td> |
---|
| 286 | <td class="md" valign="top">( </td> |
---|
| 287 | <td class="md" nowrap valign="top">void </td> |
---|
| 288 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 289 | <td class="md" valign="top"> ) </td> |
---|
| 290 | <td class="md" nowrap><code> [virtual, inherited]</code></td> |
---|
| 291 | </tr> |
---|
| 292 | |
---|
| 293 | </table> |
---|
| 294 | </td> |
---|
| 295 | </tr> |
---|
| 296 | </table> |
---|
| 297 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 298 | <tr> |
---|
| 299 | <td> |
---|
| 300 | |
---|
| 301 | </td> |
---|
| 302 | <td> |
---|
| 303 | |
---|
| 304 | <p> |
---|
| 305 | Returns a String containing the entire stream. |
---|
| 306 | <p> |
---|
| 307 | <dl compact><dt><b>Remarks:</b></dt><dd>This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.</dd></dl> |
---|
| 308 | </td> |
---|
| 309 | </tr> |
---|
| 310 | </table> |
---|
| 311 | <a class="anchor" name="Ogre_1_1ZipDataStreama13" doxytag="Ogre::FileHandleDataStream::getLine" ></a><p> |
---|
| 312 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 313 | <tr> |
---|
| 314 | <td class="mdRow"> |
---|
| 315 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 316 | <tr> |
---|
| 317 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DataStream::getLine </td> |
---|
| 318 | <td class="md" valign="top">( </td> |
---|
| 319 | <td class="md" nowrap valign="top">bool </td> |
---|
| 320 | <td class="mdname1" valign="top" nowrap> <em>trimAfter</em> = true </td> |
---|
| 321 | <td class="md" valign="top"> ) </td> |
---|
| 322 | <td class="md" nowrap><code> [virtual, inherited]</code></td> |
---|
| 323 | </tr> |
---|
| 324 | |
---|
| 325 | </table> |
---|
| 326 | </td> |
---|
| 327 | </tr> |
---|
| 328 | </table> |
---|
| 329 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 330 | <tr> |
---|
| 331 | <td> |
---|
| 332 | |
---|
| 333 | </td> |
---|
| 334 | <td> |
---|
| 335 | |
---|
| 336 | <p> |
---|
| 337 | Returns a String containing the next line of data, optionally trimmed for whitespace. |
---|
| 338 | <p> |
---|
| 339 | <dl compact><dt><b>Remarks:</b></dt><dd>This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required. </dd></dl> |
---|
| 340 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 341 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 342 | <tr><td valign=top><em>trimAfter</em> </td><td>If true, the line is trimmed for whitespace (as in String.trim(true,true))</td></tr> |
---|
| 343 | </table> |
---|
| 344 | </dl> |
---|
| 345 | </td> |
---|
| 346 | </tr> |
---|
| 347 | </table> |
---|
| 348 | <a class="anchor" name="Ogre_1_1ZipDataStreama11" doxytag="Ogre::FileHandleDataStream::getName" ></a><p> |
---|
| 349 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 350 | <tr> |
---|
| 351 | <td class="mdRow"> |
---|
| 352 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 353 | <tr> |
---|
| 354 | <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>& Ogre::DataStream::getName </td> |
---|
| 355 | <td class="md" valign="top">( </td> |
---|
| 356 | <td class="md" nowrap valign="top">void </td> |
---|
| 357 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 358 | <td class="md" valign="top"> ) </td> |
---|
| 359 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
| 360 | </tr> |
---|
| 361 | |
---|
| 362 | </table> |
---|
| 363 | </td> |
---|
| 364 | </tr> |
---|
| 365 | </table> |
---|
| 366 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 367 | <tr> |
---|
| 368 | <td> |
---|
| 369 | |
---|
| 370 | </td> |
---|
| 371 | <td> |
---|
| 372 | |
---|
| 373 | <p> |
---|
| 374 | Returns the name of the stream, if it has one. |
---|
| 375 | <p> |
---|
| 376 | |
---|
| 377 | <p> |
---|
| 378 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00070">70</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. |
---|
| 379 | <p> |
---|
| 380 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>. </td> |
---|
| 381 | </tr> |
---|
| 382 | </table> |
---|
| 383 | <a class="anchor" name="Ogre_1_1ZipDataStreama12" doxytag="Ogre::FileHandleDataStream::operator>>" ></a><p> |
---|
| 384 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 385 | <tr> |
---|
| 386 | <td class="mdRow"> |
---|
| 387 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 388 | <tr> |
---|
| 389 | <td class="md" colspan="4"> |
---|
| 390 | template<typename T> </td> |
---|
| 391 | </tr> |
---|
| 392 | <tr> |
---|
| 393 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DataStream.html">DataStream</a>& Ogre::DataStream::operator>> </td> |
---|
| 394 | <td class="md" valign="top">( </td> |
---|
| 395 | <td class="md" nowrap valign="top">T & </td> |
---|
| 396 | <td class="mdname1" valign="top" nowrap> <em>val</em> </td> |
---|
| 397 | <td class="md" valign="top"> ) </td> |
---|
| 398 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
| 399 | </tr> |
---|
| 400 | |
---|
| 401 | </table> |
---|
| 402 | </td> |
---|
| 403 | </tr> |
---|
| 404 | </table> |
---|
| 405 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 406 | <tr> |
---|
| 407 | <td> |
---|
| 408 | |
---|
| 409 | </td> |
---|
| 410 | <td> |
---|
| 411 | |
---|
| 412 | <p> |
---|
| 413 | </td> |
---|
| 414 | </tr> |
---|
| 415 | </table> |
---|
| 416 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama3" doxytag="Ogre::FileHandleDataStream::read" ></a><p> |
---|
| 417 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 418 | <tr> |
---|
| 419 | <td class="mdRow"> |
---|
| 420 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 421 | <tr> |
---|
| 422 | <td class="md" nowrap valign="top"> size_t Ogre::FileHandleDataStream::read </td> |
---|
| 423 | <td class="md" valign="top">( </td> |
---|
| 424 | <td class="md" nowrap valign="top">void * </td> |
---|
| 425 | <td class="mdname" nowrap> <em>buf</em>, </td> |
---|
| 426 | </tr> |
---|
| 427 | <tr> |
---|
| 428 | <td class="md" nowrap align="right"></td> |
---|
| 429 | <td></td> |
---|
| 430 | <td class="md" nowrap>size_t </td> |
---|
| 431 | <td class="mdname" nowrap> <em>count</em></td> |
---|
| 432 | </tr> |
---|
| 433 | <tr> |
---|
| 434 | <td></td> |
---|
| 435 | <td class="md">) </td> |
---|
| 436 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
| 437 | </tr> |
---|
| 438 | |
---|
| 439 | </table> |
---|
| 440 | </td> |
---|
| 441 | </tr> |
---|
| 442 | </table> |
---|
| 443 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 444 | <tr> |
---|
| 445 | <td> |
---|
| 446 | |
---|
| 447 | </td> |
---|
| 448 | <td> |
---|
| 449 | |
---|
| 450 | <p> |
---|
| 451 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 452 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 453 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
| 454 | <tr><td valign=top><em>count</em> </td><td>Number of bytes to read </td></tr> |
---|
| 455 | </table> |
---|
| 456 | </dl> |
---|
| 457 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl> |
---|
| 458 | |
---|
| 459 | <p> |
---|
| 460 | |
---|
| 461 | <p> |
---|
| 462 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama5">Ogre::DataStream</a>. </td> |
---|
| 463 | </tr> |
---|
| 464 | </table> |
---|
| 465 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama4" doxytag="Ogre::FileHandleDataStream::readLine" ></a><p> |
---|
| 466 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 467 | <tr> |
---|
| 468 | <td class="mdRow"> |
---|
| 469 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 470 | <tr> |
---|
| 471 | <td class="md" nowrap valign="top"> size_t Ogre::FileHandleDataStream::readLine </td> |
---|
| 472 | <td class="md" valign="top">( </td> |
---|
| 473 | <td class="md" nowrap valign="top">char * </td> |
---|
| 474 | <td class="mdname" nowrap> <em>buf</em>, </td> |
---|
| 475 | </tr> |
---|
| 476 | <tr> |
---|
| 477 | <td class="md" nowrap align="right"></td> |
---|
| 478 | <td></td> |
---|
| 479 | <td class="md" nowrap>size_t </td> |
---|
| 480 | <td class="mdname" nowrap> <em>maxCount</em>, </td> |
---|
| 481 | </tr> |
---|
| 482 | <tr> |
---|
| 483 | <td class="md" nowrap align="right"></td> |
---|
| 484 | <td></td> |
---|
| 485 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
| 486 | <td class="mdname" nowrap> <em>delim</em> = "\n"</td> |
---|
| 487 | </tr> |
---|
| 488 | <tr> |
---|
| 489 | <td></td> |
---|
| 490 | <td class="md">) </td> |
---|
| 491 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
| 492 | </tr> |
---|
| 493 | |
---|
| 494 | </table> |
---|
| 495 | </td> |
---|
| 496 | </tr> |
---|
| 497 | </table> |
---|
| 498 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 499 | <tr> |
---|
| 500 | <td> |
---|
| 501 | |
---|
| 502 | </td> |
---|
| 503 | <td> |
---|
| 504 | |
---|
| 505 | <p> |
---|
| 506 | <dl compact><dt><b>Remarks:</b></dt><dd>The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character. </dd></dl> |
---|
| 507 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 508 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 509 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
| 510 | <tr><td valign=top><em>maxCount</em> </td><td>The maximum length of data to be read, excluding the terminating character </td></tr> |
---|
| 511 | <tr><td valign=top><em>delim</em> </td><td>The delimiter to stop at </td></tr> |
---|
| 512 | </table> |
---|
| 513 | </dl> |
---|
| 514 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read, excluding the terminating character </dd></dl> |
---|
| 515 | |
---|
| 516 | <p> |
---|
| 517 | |
---|
| 518 | <p> |
---|
| 519 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama6">Ogre::DataStream</a>. </td> |
---|
| 520 | </tr> |
---|
| 521 | </table> |
---|
| 522 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama7" doxytag="Ogre::FileHandleDataStream::seek" ></a><p> |
---|
| 523 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 524 | <tr> |
---|
| 525 | <td class="mdRow"> |
---|
| 526 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 527 | <tr> |
---|
| 528 | <td class="md" nowrap valign="top"> void Ogre::FileHandleDataStream::seek </td> |
---|
| 529 | <td class="md" valign="top">( </td> |
---|
| 530 | <td class="md" nowrap valign="top">size_t </td> |
---|
| 531 | <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> |
---|
| 532 | <td class="md" valign="top"> ) </td> |
---|
| 533 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 534 | </tr> |
---|
| 535 | |
---|
| 536 | </table> |
---|
| 537 | </td> |
---|
| 538 | </tr> |
---|
| 539 | </table> |
---|
| 540 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 541 | <tr> |
---|
| 542 | <td> |
---|
| 543 | |
---|
| 544 | </td> |
---|
| 545 | <td> |
---|
| 546 | |
---|
| 547 | <p> |
---|
| 548 | |
---|
| 549 | <p> |
---|
| 550 | |
---|
| 551 | <p> |
---|
| 552 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama11">Ogre::DataStream</a>. </td> |
---|
| 553 | </tr> |
---|
| 554 | </table> |
---|
| 555 | <a class="anchor" name="Ogre_1_1ZipDataStreama15" doxytag="Ogre::FileHandleDataStream::size" ></a><p> |
---|
| 556 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 557 | <tr> |
---|
| 558 | <td class="mdRow"> |
---|
| 559 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 560 | <tr> |
---|
| 561 | <td class="md" nowrap valign="top"> size_t Ogre::DataStream::size </td> |
---|
| 562 | <td class="md" valign="top">( </td> |
---|
| 563 | <td class="md" nowrap valign="top">void </td> |
---|
| 564 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 565 | <td class="md" valign="top"> ) </td> |
---|
| 566 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
| 567 | </tr> |
---|
| 568 | |
---|
| 569 | </table> |
---|
| 570 | </td> |
---|
| 571 | </tr> |
---|
| 572 | </table> |
---|
| 573 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 574 | <tr> |
---|
| 575 | <td> |
---|
| 576 | |
---|
| 577 | </td> |
---|
| 578 | <td> |
---|
| 579 | |
---|
| 580 | <p> |
---|
| 581 | Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. |
---|
| 582 | <p> |
---|
| 583 | |
---|
| 584 | <p> |
---|
| 585 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00138">138</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
| 586 | </tr> |
---|
| 587 | </table> |
---|
| 588 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama6" doxytag="Ogre::FileHandleDataStream::skip" ></a><p> |
---|
| 589 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 590 | <tr> |
---|
| 591 | <td class="mdRow"> |
---|
| 592 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 593 | <tr> |
---|
| 594 | <td class="md" nowrap valign="top"> void Ogre::FileHandleDataStream::skip </td> |
---|
| 595 | <td class="md" valign="top">( </td> |
---|
| 596 | <td class="md" nowrap valign="top">long </td> |
---|
| 597 | <td class="mdname1" valign="top" nowrap> <em>count</em> </td> |
---|
| 598 | <td class="md" valign="top"> ) </td> |
---|
| 599 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 600 | </tr> |
---|
| 601 | |
---|
| 602 | </table> |
---|
| 603 | </td> |
---|
| 604 | </tr> |
---|
| 605 | </table> |
---|
| 606 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 607 | <tr> |
---|
| 608 | <td> |
---|
| 609 | |
---|
| 610 | </td> |
---|
| 611 | <td> |
---|
| 612 | |
---|
| 613 | <p> |
---|
| 614 | This can also be a negative value, in which case the file pointer rewinds a defined number of bytes. |
---|
| 615 | <p> |
---|
| 616 | |
---|
| 617 | <p> |
---|
| 618 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama10">Ogre::DataStream</a>. </td> |
---|
| 619 | </tr> |
---|
| 620 | </table> |
---|
| 621 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama5" doxytag="Ogre::FileHandleDataStream::skipLine" ></a><p> |
---|
| 622 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 623 | <tr> |
---|
| 624 | <td class="mdRow"> |
---|
| 625 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 626 | <tr> |
---|
| 627 | <td class="md" nowrap valign="top"> size_t Ogre::FileHandleDataStream::skipLine </td> |
---|
| 628 | <td class="md" valign="top">( </td> |
---|
| 629 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
| 630 | <td class="mdname1" valign="top" nowrap> <em>delim</em> = "\n" </td> |
---|
| 631 | <td class="md" valign="top"> ) </td> |
---|
| 632 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 633 | </tr> |
---|
| 634 | |
---|
| 635 | </table> |
---|
| 636 | </td> |
---|
| 637 | </tr> |
---|
| 638 | </table> |
---|
| 639 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 640 | <tr> |
---|
| 641 | <td> |
---|
| 642 | |
---|
| 643 | </td> |
---|
| 644 | <td> |
---|
| 645 | |
---|
| 646 | <p> |
---|
| 647 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 648 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 649 | <tr><td valign=top><em>delim</em> </td><td>The delimiter(s) to stop at </td></tr> |
---|
| 650 | </table> |
---|
| 651 | </dl> |
---|
| 652 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl> |
---|
| 653 | |
---|
| 654 | <p> |
---|
| 655 | |
---|
| 656 | <p> |
---|
| 657 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama9">Ogre::DataStream</a>. </td> |
---|
| 658 | </tr> |
---|
| 659 | </table> |
---|
| 660 | <a class="anchor" name="Ogre_1_1FileHandleDataStreama8" doxytag="Ogre::FileHandleDataStream::tell" ></a><p> |
---|
| 661 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 662 | <tr> |
---|
| 663 | <td class="mdRow"> |
---|
| 664 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 665 | <tr> |
---|
| 666 | <td class="md" nowrap valign="top"> size_t Ogre::FileHandleDataStream::tell </td> |
---|
| 667 | <td class="md" valign="top">( </td> |
---|
| 668 | <td class="md" nowrap valign="top">void </td> |
---|
| 669 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 670 | <td class="md" valign="top"> ) </td> |
---|
| 671 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 672 | </tr> |
---|
| 673 | |
---|
| 674 | </table> |
---|
| 675 | </td> |
---|
| 676 | </tr> |
---|
| 677 | </table> |
---|
| 678 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 679 | <tr> |
---|
| 680 | <td> |
---|
| 681 | |
---|
| 682 | </td> |
---|
| 683 | <td> |
---|
| 684 | |
---|
| 685 | <p> |
---|
| 686 | |
---|
| 687 | <p> |
---|
| 688 | |
---|
| 689 | <p> |
---|
| 690 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama12">Ogre::DataStream</a>. </td> |
---|
| 691 | </tr> |
---|
| 692 | </table> |
---|
| 693 | <hr><h2>Member Data Documentation</h2> |
---|
| 694 | <a class="anchor" name="Ogre_1_1FileHandleDataStreamp0" doxytag="Ogre::FileHandleDataStream::mFileHandle" ></a><p> |
---|
| 695 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 696 | <tr> |
---|
| 697 | <td class="mdRow"> |
---|
| 698 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 699 | <tr> |
---|
| 700 | <td class="md" nowrap valign="top"> FILE* <a class="el" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreamp0">Ogre::FileHandleDataStream::mFileHandle</a><code> [protected]</code> |
---|
| 701 | </table> |
---|
| 702 | </td> |
---|
| 703 | </tr> |
---|
| 704 | </table> |
---|
| 705 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 706 | <tr> |
---|
| 707 | <td> |
---|
| 708 | |
---|
| 709 | </td> |
---|
| 710 | <td> |
---|
| 711 | |
---|
| 712 | <p> |
---|
| 713 | |
---|
| 714 | <p> |
---|
| 715 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00400">400</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
| 716 | </tr> |
---|
| 717 | </table> |
---|
| 718 | <a class="anchor" name="Ogre_1_1ZipDataStreamp2" doxytag="Ogre::FileHandleDataStream::mName" ></a><p> |
---|
| 719 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 720 | <tr> |
---|
| 721 | <td class="mdRow"> |
---|
| 722 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 723 | <tr> |
---|
| 724 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">Ogre::DataStream::mName</a><code> [protected, inherited]</code> |
---|
| 725 | </table> |
---|
| 726 | </td> |
---|
| 727 | </tr> |
---|
| 728 | </table> |
---|
| 729 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 730 | <tr> |
---|
| 731 | <td> |
---|
| 732 | |
---|
| 733 | </td> |
---|
| 734 | <td> |
---|
| 735 | |
---|
| 736 | <p> |
---|
| 737 | The name (e.g. resource name) that can be used to identify the source fot his data (optional). |
---|
| 738 | <p> |
---|
| 739 | |
---|
| 740 | <p> |
---|
| 741 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00058">58</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
| 742 | </tr> |
---|
| 743 | </table> |
---|
| 744 | <a class="anchor" name="Ogre_1_1ZipDataStreamp3" doxytag="Ogre::FileHandleDataStream::mSize" ></a><p> |
---|
| 745 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 746 | <tr> |
---|
| 747 | <td class="mdRow"> |
---|
| 748 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 749 | <tr> |
---|
| 750 | <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">Ogre::DataStream::mSize</a><code> [protected, inherited]</code> |
---|
| 751 | </table> |
---|
| 752 | </td> |
---|
| 753 | </tr> |
---|
| 754 | </table> |
---|
| 755 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 756 | <tr> |
---|
| 757 | <td> |
---|
| 758 | |
---|
| 759 | </td> |
---|
| 760 | <td> |
---|
| 761 | |
---|
| 762 | <p> |
---|
| 763 | Size of the data in the stream (may be 0 if size cannot be determined). |
---|
| 764 | <p> |
---|
| 765 | |
---|
| 766 | <p> |
---|
| 767 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00060">60</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
| 768 | </tr> |
---|
| 769 | </table> |
---|
| 770 | <a class="anchor" name="Ogre_1_1ZipDataStreamp4" doxytag="Ogre::FileHandleDataStream::mTmpArea" ></a><p> |
---|
| 771 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 772 | <tr> |
---|
| 773 | <td class="mdRow"> |
---|
| 774 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 775 | <tr> |
---|
| 776 | <td class="md" nowrap valign="top"> char <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">Ogre::DataStream::mTmpArea</a>[OGRE_STREAM_TEMP_SIZE]<code> [protected, inherited]</code> |
---|
| 777 | </table> |
---|
| 778 | </td> |
---|
| 779 | </tr> |
---|
| 780 | </table> |
---|
| 781 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 782 | <tr> |
---|
| 783 | <td> |
---|
| 784 | |
---|
| 785 | </td> |
---|
| 786 | <td> |
---|
| 787 | |
---|
| 788 | <p> |
---|
| 789 | Temporary buffer area used for formatted read. |
---|
| 790 | <p> |
---|
| 791 | |
---|
| 792 | <p> |
---|
| 793 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00063">63</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
| 794 | </tr> |
---|
| 795 | </table> |
---|
| 796 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 797 | <li><a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a></ul> |
---|
| 798 | <hr> |
---|
| 799 | <p> |
---|
| 800 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
| 801 | <!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/> |
---|
| 802 | This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/> |
---|
| 803 | <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> |
---|
| 804 | <Work rdf:about=""> |
---|
| 805 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
| 806 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
| 807 | </Work> |
---|
| 808 | <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> --> |
---|
| 809 | |
---|
| 810 | Last modified Sun Mar 12 14:38:39 2006 |
---|
| 811 | </p> |
---|
| 812 | </body> |
---|
| 813 | </html> |
---|