1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::MemoryDataStream 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::MemoryDataStream Class Reference</h1>Common subclass of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> for handling data from chunks of memory. |
---|
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::MemoryDataStream: |
---|
16 | <p><center><img src="classOgre_1_1MemoryDataStream.png" usemap="#Ogre::MemoryDataStream_map" border="0" alt=""></center> |
---|
17 | <map name="Ogre::MemoryDataStream_map"> |
---|
18 | <area href="classOgre_1_1DataStream.html" alt="Ogre::DataStream" shape="rect" coords="0,0,158,24"> |
---|
19 | </map> |
---|
20 | <a href="classOgre_1_1MemoryDataStream-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_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama0">MemoryDataStream</a> (void *pMem, size_t size, bool freeOnClose=false)</td></tr> |
---|
24 | |
---|
25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Wrap an existing memory chunk in a stream. <a href="#Ogre_1_1MemoryDataStreama0"></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_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama1">MemoryDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, void *pMem, size_t size, bool freeOnClose=false)</td></tr> |
---|
27 | |
---|
28 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Wrap an existing memory chunk in a named stream. <a href="#Ogre_1_1MemoryDataStreama1"></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_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama2">MemoryDataStream</a> (<a class="el" href="classOgre_1_1DataStream.html">DataStream</a> &sourceStream, bool freeOnClose=true)</td></tr> |
---|
30 | |
---|
31 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a stream which pre-buffers the contents of another stream. <a href="#Ogre_1_1MemoryDataStreama2"></a><br><br></td></tr> |
---|
32 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama3">MemoryDataStream</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &sourceStream, bool freeOnClose=true)</td></tr> |
---|
33 | |
---|
34 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a stream which pre-buffers the contents of another stream. <a href="#Ogre_1_1MemoryDataStreama3"></a><br><br></td></tr> |
---|
35 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama4">MemoryDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> &sourceStream, bool freeOnClose=true)</td></tr> |
---|
36 | |
---|
37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named stream which pre-buffers the contents of another stream. <a href="#Ogre_1_1MemoryDataStreama4"></a><br><br></td></tr> |
---|
38 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama5">MemoryDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, const <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &sourceStream, bool freeOnClose=true)</td></tr> |
---|
39 | |
---|
40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named stream which pre-buffers the contents of another stream. <a href="#Ogre_1_1MemoryDataStreama5"></a><br><br></td></tr> |
---|
41 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama6">MemoryDataStream</a> (size_t size, bool freeOnClose=true)</td></tr> |
---|
42 | |
---|
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a stream with a brand new empty memory chunk. <a href="#Ogre_1_1MemoryDataStreama6"></a><br><br></td></tr> |
---|
44 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama7">MemoryDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, size_t size, bool freeOnClose=true)</td></tr> |
---|
45 | |
---|
46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named stream with a brand new empty memory chunk. <a href="#Ogre_1_1MemoryDataStreama7"></a><br><br></td></tr> |
---|
47 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama8">~MemoryDataStream</a> ()</td></tr> |
---|
48 | |
---|
49 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a466">uchar</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama9">getPtr</a> (void)</td></tr> |
---|
50 | |
---|
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the start of the memory block this stream holds. <a href="#Ogre_1_1MemoryDataStreama9"></a><br><br></td></tr> |
---|
52 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a466">uchar</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama10">getCurrentPtr</a> (void)</td></tr> |
---|
53 | |
---|
54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the current position in the memory block this stream holds. <a href="#Ogre_1_1MemoryDataStreama10"></a><br><br></td></tr> |
---|
55 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama11">read</a> (void *buf, size_t count)</td></tr> |
---|
56 | |
---|
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
58 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
59 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
60 | <tr><td valign=top><em>count</em> </td><td>Number of bytes to read </td></tr> |
---|
61 | </table> |
---|
62 | </dl> |
---|
63 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl> |
---|
64 | <a href="#Ogre_1_1MemoryDataStreama11"></a><br><br></td></tr> |
---|
65 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama12">readLine</a> (char *buf, size_t maxCount, const <a class="el" href="namespaceOgre.html#a471">String</a> &delim="\n")</td></tr> |
---|
66 | |
---|
67 | <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> |
---|
68 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
69 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
70 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
71 | <tr><td valign=top><em>maxCount</em> </td><td>The maximum length of data to be read, excluding the terminating character </td></tr> |
---|
72 | <tr><td valign=top><em>delim</em> </td><td>The delimiter to stop at </td></tr> |
---|
73 | </table> |
---|
74 | </dl> |
---|
75 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read, excluding the terminating character </dd></dl> |
---|
76 | <a href="#Ogre_1_1MemoryDataStreama12"></a><br><br></td></tr> |
---|
77 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama13">skipLine</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &delim="\n")</td></tr> |
---|
78 | |
---|
79 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
80 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
81 | <tr><td valign=top><em>delim</em> </td><td>The delimiter(s) to stop at </td></tr> |
---|
82 | </table> |
---|
83 | </dl> |
---|
84 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl> |
---|
85 | <a href="#Ogre_1_1MemoryDataStreama13"></a><br><br></td></tr> |
---|
86 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama14">skip</a> (long count)</td></tr> |
---|
87 | |
---|
88 | <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_1MemoryDataStreama14"></a><br><br></td></tr> |
---|
89 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama15">seek</a> (size_t pos)</td></tr> |
---|
90 | |
---|
91 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1MemoryDataStreama15"></a><br><br></td></tr> |
---|
92 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama16">tell</a> (void) const </td></tr> |
---|
93 | |
---|
94 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1MemoryDataStreama16"></a><br><br></td></tr> |
---|
95 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama17">eof</a> (void) const </td></tr> |
---|
96 | |
---|
97 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1MemoryDataStreama17"></a><br><br></td></tr> |
---|
98 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama18">close</a> (void)</td></tr> |
---|
99 | |
---|
100 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1MemoryDataStreama18"></a><br><br></td></tr> |
---|
101 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama19">setFreeOnClose</a> (bool free)</td></tr> |
---|
102 | |
---|
103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether or not to free the encapsulated memory on close. <a href="#Ogre_1_1MemoryDataStreama19"></a><br><br></td></tr> |
---|
104 | <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> |
---|
105 | |
---|
106 | <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> |
---|
107 | <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> |
---|
108 | |
---|
109 | <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> |
---|
110 | |
---|
111 | <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> |
---|
112 | <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> |
---|
113 | |
---|
114 | <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> |
---|
115 | <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> |
---|
116 | |
---|
117 | <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> |
---|
118 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
119 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a466">uchar</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp0">mData</a></td></tr> |
---|
120 | |
---|
121 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the start of the data area. <a href="#Ogre_1_1MemoryDataStreamp0"></a><br><br></td></tr> |
---|
122 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a466">uchar</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp1">mPos</a></td></tr> |
---|
123 | |
---|
124 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the current position in the memory. <a href="#Ogre_1_1MemoryDataStreamp1"></a><br><br></td></tr> |
---|
125 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a466">uchar</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp2">mEnd</a></td></tr> |
---|
126 | |
---|
127 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the end of the memory. <a href="#Ogre_1_1MemoryDataStreamp2"></a><br><br></td></tr> |
---|
128 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp3">mFreeOnClose</a></td></tr> |
---|
129 | |
---|
130 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Do we delete the memory on close. <a href="#Ogre_1_1MemoryDataStreamp3"></a><br><br></td></tr> |
---|
131 | <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> |
---|
132 | |
---|
133 | <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> |
---|
134 | <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> |
---|
135 | |
---|
136 | <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> |
---|
137 | <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> |
---|
138 | |
---|
139 | <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> |
---|
140 | </table> |
---|
141 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
142 | Common subclass of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> for handling data from chunks of memory. |
---|
143 | <p> |
---|
144 | |
---|
145 | <p> |
---|
146 | |
---|
147 | <p> |
---|
148 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00158">158</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> |
---|
149 | <a class="anchor" name="Ogre_1_1MemoryDataStreama0" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
150 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
151 | <tr> |
---|
152 | <td class="mdRow"> |
---|
153 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
154 | <tr> |
---|
155 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
156 | <td class="md" valign="top">( </td> |
---|
157 | <td class="md" nowrap valign="top">void * </td> |
---|
158 | <td class="mdname" nowrap> <em>pMem</em>, </td> |
---|
159 | </tr> |
---|
160 | <tr> |
---|
161 | <td class="md" nowrap align="right"></td> |
---|
162 | <td></td> |
---|
163 | <td class="md" nowrap>size_t </td> |
---|
164 | <td class="mdname" nowrap> <em>size</em>, </td> |
---|
165 | </tr> |
---|
166 | <tr> |
---|
167 | <td class="md" nowrap align="right"></td> |
---|
168 | <td></td> |
---|
169 | <td class="md" nowrap>bool </td> |
---|
170 | <td class="mdname" nowrap> <em>freeOnClose</em> = false</td> |
---|
171 | </tr> |
---|
172 | <tr> |
---|
173 | <td></td> |
---|
174 | <td class="md">) </td> |
---|
175 | <td class="md" colspan="2"></td> |
---|
176 | </tr> |
---|
177 | |
---|
178 | </table> |
---|
179 | </td> |
---|
180 | </tr> |
---|
181 | </table> |
---|
182 | <table cellspacing=5 cellpadding=0 border=0> |
---|
183 | <tr> |
---|
184 | <td> |
---|
185 | |
---|
186 | </td> |
---|
187 | <td> |
---|
188 | |
---|
189 | <p> |
---|
190 | Wrap an existing memory chunk in a stream. |
---|
191 | <p> |
---|
192 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
193 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
194 | <tr><td valign=top><em>pMem</em> </td><td>Pointer to the exising memory </td></tr> |
---|
195 | <tr><td valign=top><em>size</em> </td><td>The size of the memory chunk in bytes </td></tr> |
---|
196 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
197 | </table> |
---|
198 | </dl> |
---|
199 | </td> |
---|
200 | </tr> |
---|
201 | </table> |
---|
202 | <a class="anchor" name="Ogre_1_1MemoryDataStreama1" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
203 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
204 | <tr> |
---|
205 | <td class="mdRow"> |
---|
206 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
207 | <tr> |
---|
208 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
209 | <td class="md" valign="top">( </td> |
---|
210 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
211 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
212 | </tr> |
---|
213 | <tr> |
---|
214 | <td class="md" nowrap align="right"></td> |
---|
215 | <td></td> |
---|
216 | <td class="md" nowrap>void * </td> |
---|
217 | <td class="mdname" nowrap> <em>pMem</em>, </td> |
---|
218 | </tr> |
---|
219 | <tr> |
---|
220 | <td class="md" nowrap align="right"></td> |
---|
221 | <td></td> |
---|
222 | <td class="md" nowrap>size_t </td> |
---|
223 | <td class="mdname" nowrap> <em>size</em>, </td> |
---|
224 | </tr> |
---|
225 | <tr> |
---|
226 | <td class="md" nowrap align="right"></td> |
---|
227 | <td></td> |
---|
228 | <td class="md" nowrap>bool </td> |
---|
229 | <td class="mdname" nowrap> <em>freeOnClose</em> = false</td> |
---|
230 | </tr> |
---|
231 | <tr> |
---|
232 | <td></td> |
---|
233 | <td class="md">) </td> |
---|
234 | <td class="md" colspan="2"></td> |
---|
235 | </tr> |
---|
236 | |
---|
237 | </table> |
---|
238 | </td> |
---|
239 | </tr> |
---|
240 | </table> |
---|
241 | <table cellspacing=5 cellpadding=0 border=0> |
---|
242 | <tr> |
---|
243 | <td> |
---|
244 | |
---|
245 | </td> |
---|
246 | <td> |
---|
247 | |
---|
248 | <p> |
---|
249 | Wrap an existing memory chunk in a named stream. |
---|
250 | <p> |
---|
251 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
252 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
253 | <tr><td valign=top><em>name</em> </td><td>The name to give the stream </td></tr> |
---|
254 | <tr><td valign=top><em>pMem</em> </td><td>Pointer to the exising memory </td></tr> |
---|
255 | <tr><td valign=top><em>size</em> </td><td>The size of the memory chunk in bytes </td></tr> |
---|
256 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
257 | </table> |
---|
258 | </dl> |
---|
259 | </td> |
---|
260 | </tr> |
---|
261 | </table> |
---|
262 | <a class="anchor" name="Ogre_1_1MemoryDataStreama2" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
263 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
264 | <tr> |
---|
265 | <td class="mdRow"> |
---|
266 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
267 | <tr> |
---|
268 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
269 | <td class="md" valign="top">( </td> |
---|
270 | <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1DataStream.html">DataStream</a> & </td> |
---|
271 | <td class="mdname" nowrap> <em>sourceStream</em>, </td> |
---|
272 | </tr> |
---|
273 | <tr> |
---|
274 | <td class="md" nowrap align="right"></td> |
---|
275 | <td></td> |
---|
276 | <td class="md" nowrap>bool </td> |
---|
277 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
278 | </tr> |
---|
279 | <tr> |
---|
280 | <td></td> |
---|
281 | <td class="md">) </td> |
---|
282 | <td class="md" colspan="2"></td> |
---|
283 | </tr> |
---|
284 | |
---|
285 | </table> |
---|
286 | </td> |
---|
287 | </tr> |
---|
288 | </table> |
---|
289 | <table cellspacing=5 cellpadding=0 border=0> |
---|
290 | <tr> |
---|
291 | <td> |
---|
292 | |
---|
293 | </td> |
---|
294 | <td> |
---|
295 | |
---|
296 | <p> |
---|
297 | Create a stream which pre-buffers the contents of another stream. |
---|
298 | <p> |
---|
299 | <dl compact><dt><b>Remarks:</b></dt><dd>This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit. </dd></dl> |
---|
300 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
301 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
302 | <tr><td valign=top><em>sourceStream</em> </td><td>Another <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which will provide the source of data </td></tr> |
---|
303 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
304 | </table> |
---|
305 | </dl> |
---|
306 | </td> |
---|
307 | </tr> |
---|
308 | </table> |
---|
309 | <a class="anchor" name="Ogre_1_1MemoryDataStreama3" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
310 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
311 | <tr> |
---|
312 | <td class="mdRow"> |
---|
313 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
314 | <tr> |
---|
315 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
316 | <td class="md" valign="top">( </td> |
---|
317 | <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> & </td> |
---|
318 | <td class="mdname" nowrap> <em>sourceStream</em>, </td> |
---|
319 | </tr> |
---|
320 | <tr> |
---|
321 | <td class="md" nowrap align="right"></td> |
---|
322 | <td></td> |
---|
323 | <td class="md" nowrap>bool </td> |
---|
324 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
325 | </tr> |
---|
326 | <tr> |
---|
327 | <td></td> |
---|
328 | <td class="md">) </td> |
---|
329 | <td class="md" colspan="2"></td> |
---|
330 | </tr> |
---|
331 | |
---|
332 | </table> |
---|
333 | </td> |
---|
334 | </tr> |
---|
335 | </table> |
---|
336 | <table cellspacing=5 cellpadding=0 border=0> |
---|
337 | <tr> |
---|
338 | <td> |
---|
339 | |
---|
340 | </td> |
---|
341 | <td> |
---|
342 | |
---|
343 | <p> |
---|
344 | Create a stream which pre-buffers the contents of another stream. |
---|
345 | <p> |
---|
346 | <dl compact><dt><b>Remarks:</b></dt><dd>This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit. </dd></dl> |
---|
347 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
348 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
349 | <tr><td valign=top><em>sourceStream</em> </td><td>Weak reference to another <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which will provide the source of data </td></tr> |
---|
350 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
351 | </table> |
---|
352 | </dl> |
---|
353 | </td> |
---|
354 | </tr> |
---|
355 | </table> |
---|
356 | <a class="anchor" name="Ogre_1_1MemoryDataStreama4" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
357 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
358 | <tr> |
---|
359 | <td class="mdRow"> |
---|
360 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
361 | <tr> |
---|
362 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
363 | <td class="md" valign="top">( </td> |
---|
364 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
365 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
366 | </tr> |
---|
367 | <tr> |
---|
368 | <td class="md" nowrap align="right"></td> |
---|
369 | <td></td> |
---|
370 | <td class="md" nowrap><a class="el" href="classOgre_1_1DataStream.html">DataStream</a> & </td> |
---|
371 | <td class="mdname" nowrap> <em>sourceStream</em>, </td> |
---|
372 | </tr> |
---|
373 | <tr> |
---|
374 | <td class="md" nowrap align="right"></td> |
---|
375 | <td></td> |
---|
376 | <td class="md" nowrap>bool </td> |
---|
377 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
378 | </tr> |
---|
379 | <tr> |
---|
380 | <td></td> |
---|
381 | <td class="md">) </td> |
---|
382 | <td class="md" colspan="2"></td> |
---|
383 | </tr> |
---|
384 | |
---|
385 | </table> |
---|
386 | </td> |
---|
387 | </tr> |
---|
388 | </table> |
---|
389 | <table cellspacing=5 cellpadding=0 border=0> |
---|
390 | <tr> |
---|
391 | <td> |
---|
392 | |
---|
393 | </td> |
---|
394 | <td> |
---|
395 | |
---|
396 | <p> |
---|
397 | Create a named stream which pre-buffers the contents of another stream. |
---|
398 | <p> |
---|
399 | <dl compact><dt><b>Remarks:</b></dt><dd>This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit. </dd></dl> |
---|
400 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
401 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
402 | <tr><td valign=top><em>name</em> </td><td>The name to give the stream </td></tr> |
---|
403 | <tr><td valign=top><em>sourceStream</em> </td><td>Another <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which will provide the source of data </td></tr> |
---|
404 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
405 | </table> |
---|
406 | </dl> |
---|
407 | </td> |
---|
408 | </tr> |
---|
409 | </table> |
---|
410 | <a class="anchor" name="Ogre_1_1MemoryDataStreama5" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
411 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
412 | <tr> |
---|
413 | <td class="mdRow"> |
---|
414 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
415 | <tr> |
---|
416 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
417 | <td class="md" valign="top">( </td> |
---|
418 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
419 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
420 | </tr> |
---|
421 | <tr> |
---|
422 | <td class="md" nowrap align="right"></td> |
---|
423 | <td></td> |
---|
424 | <td class="md" nowrap>const <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> & </td> |
---|
425 | <td class="mdname" nowrap> <em>sourceStream</em>, </td> |
---|
426 | </tr> |
---|
427 | <tr> |
---|
428 | <td class="md" nowrap align="right"></td> |
---|
429 | <td></td> |
---|
430 | <td class="md" nowrap>bool </td> |
---|
431 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
432 | </tr> |
---|
433 | <tr> |
---|
434 | <td></td> |
---|
435 | <td class="md">) </td> |
---|
436 | <td class="md" colspan="2"></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 | Create a named stream which pre-buffers the contents of another stream. |
---|
452 | <p> |
---|
453 | <dl compact><dt><b>Remarks:</b></dt><dd>This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit. </dd></dl> |
---|
454 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
455 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
456 | <tr><td valign=top><em>name</em> </td><td>The name to give the stream </td></tr> |
---|
457 | <tr><td valign=top><em>sourceStream</em> </td><td>Another <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which will provide the source of data </td></tr> |
---|
458 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed. </td></tr> |
---|
459 | </table> |
---|
460 | </dl> |
---|
461 | </td> |
---|
462 | </tr> |
---|
463 | </table> |
---|
464 | <a class="anchor" name="Ogre_1_1MemoryDataStreama6" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
465 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
466 | <tr> |
---|
467 | <td class="mdRow"> |
---|
468 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
469 | <tr> |
---|
470 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
471 | <td class="md" valign="top">( </td> |
---|
472 | <td class="md" nowrap valign="top">size_t </td> |
---|
473 | <td class="mdname" nowrap> <em>size</em>, </td> |
---|
474 | </tr> |
---|
475 | <tr> |
---|
476 | <td class="md" nowrap align="right"></td> |
---|
477 | <td></td> |
---|
478 | <td class="md" nowrap>bool </td> |
---|
479 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
480 | </tr> |
---|
481 | <tr> |
---|
482 | <td></td> |
---|
483 | <td class="md">) </td> |
---|
484 | <td class="md" colspan="2"></td> |
---|
485 | </tr> |
---|
486 | |
---|
487 | </table> |
---|
488 | </td> |
---|
489 | </tr> |
---|
490 | </table> |
---|
491 | <table cellspacing=5 cellpadding=0 border=0> |
---|
492 | <tr> |
---|
493 | <td> |
---|
494 | |
---|
495 | </td> |
---|
496 | <td> |
---|
497 | |
---|
498 | <p> |
---|
499 | Create a stream with a brand new empty memory chunk. |
---|
500 | <p> |
---|
501 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
502 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
503 | <tr><td valign=top><em>size</em> </td><td>The size of the memory chunk to create in bytes </td></tr> |
---|
504 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
505 | </table> |
---|
506 | </dl> |
---|
507 | </td> |
---|
508 | </tr> |
---|
509 | </table> |
---|
510 | <a class="anchor" name="Ogre_1_1MemoryDataStreama7" doxytag="Ogre::MemoryDataStream::MemoryDataStream" ></a><p> |
---|
511 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
512 | <tr> |
---|
513 | <td class="mdRow"> |
---|
514 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
515 | <tr> |
---|
516 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::MemoryDataStream </td> |
---|
517 | <td class="md" valign="top">( </td> |
---|
518 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
519 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
520 | </tr> |
---|
521 | <tr> |
---|
522 | <td class="md" nowrap align="right"></td> |
---|
523 | <td></td> |
---|
524 | <td class="md" nowrap>size_t </td> |
---|
525 | <td class="mdname" nowrap> <em>size</em>, </td> |
---|
526 | </tr> |
---|
527 | <tr> |
---|
528 | <td class="md" nowrap align="right"></td> |
---|
529 | <td></td> |
---|
530 | <td class="md" nowrap>bool </td> |
---|
531 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
532 | </tr> |
---|
533 | <tr> |
---|
534 | <td></td> |
---|
535 | <td class="md">) </td> |
---|
536 | <td class="md" colspan="2"></td> |
---|
537 | </tr> |
---|
538 | |
---|
539 | </table> |
---|
540 | </td> |
---|
541 | </tr> |
---|
542 | </table> |
---|
543 | <table cellspacing=5 cellpadding=0 border=0> |
---|
544 | <tr> |
---|
545 | <td> |
---|
546 | |
---|
547 | </td> |
---|
548 | <td> |
---|
549 | |
---|
550 | <p> |
---|
551 | Create a named stream with a brand new empty memory chunk. |
---|
552 | <p> |
---|
553 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
554 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
555 | <tr><td valign=top><em>name</em> </td><td>The name to give the stream </td></tr> |
---|
556 | <tr><td valign=top><em>size</em> </td><td>The size of the memory chunk to create in bytes </td></tr> |
---|
557 | <tr><td valign=top><em>freeOnClose</em> </td><td>If true, the memory associated will be destroyed when the stream is destroyed.</td></tr> |
---|
558 | </table> |
---|
559 | </dl> |
---|
560 | </td> |
---|
561 | </tr> |
---|
562 | </table> |
---|
563 | <a class="anchor" name="Ogre_1_1MemoryDataStreama8" doxytag="Ogre::MemoryDataStream::~MemoryDataStream" ></a><p> |
---|
564 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
565 | <tr> |
---|
566 | <td class="mdRow"> |
---|
567 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
568 | <tr> |
---|
569 | <td class="md" nowrap valign="top"> Ogre::MemoryDataStream::~<a class="el" href="classOgre_1_1MemoryDataStream.html">MemoryDataStream</a> </td> |
---|
570 | <td class="md" valign="top">( </td> |
---|
571 | <td class="mdname1" valign="top" nowrap> </td> |
---|
572 | <td class="md" valign="top"> ) </td> |
---|
573 | <td class="md" nowrap></td> |
---|
574 | </tr> |
---|
575 | |
---|
576 | </table> |
---|
577 | </td> |
---|
578 | </tr> |
---|
579 | </table> |
---|
580 | <table cellspacing=5 cellpadding=0 border=0> |
---|
581 | <tr> |
---|
582 | <td> |
---|
583 | |
---|
584 | </td> |
---|
585 | <td> |
---|
586 | |
---|
587 | <p> |
---|
588 | </td> |
---|
589 | </tr> |
---|
590 | </table> |
---|
591 | <hr><h2>Member Function Documentation</h2> |
---|
592 | <a class="anchor" name="Ogre_1_1MemoryDataStreama18" doxytag="Ogre::MemoryDataStream::close" ></a><p> |
---|
593 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
594 | <tr> |
---|
595 | <td class="mdRow"> |
---|
596 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
597 | <tr> |
---|
598 | <td class="md" nowrap valign="top"> void Ogre::MemoryDataStream::close </td> |
---|
599 | <td class="md" valign="top">( </td> |
---|
600 | <td class="md" nowrap valign="top">void </td> |
---|
601 | <td class="mdname1" valign="top" nowrap> </td> |
---|
602 | <td class="md" valign="top"> ) </td> |
---|
603 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
604 | </tr> |
---|
605 | |
---|
606 | </table> |
---|
607 | </td> |
---|
608 | </tr> |
---|
609 | </table> |
---|
610 | <table cellspacing=5 cellpadding=0 border=0> |
---|
611 | <tr> |
---|
612 | <td> |
---|
613 | |
---|
614 | </td> |
---|
615 | <td> |
---|
616 | |
---|
617 | <p> |
---|
618 | |
---|
619 | <p> |
---|
620 | |
---|
621 | <p> |
---|
622 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama15">Ogre::DataStream</a>. </td> |
---|
623 | </tr> |
---|
624 | </table> |
---|
625 | <a class="anchor" name="Ogre_1_1MemoryDataStreama17" doxytag="Ogre::MemoryDataStream::eof" ></a><p> |
---|
626 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
627 | <tr> |
---|
628 | <td class="mdRow"> |
---|
629 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
630 | <tr> |
---|
631 | <td class="md" nowrap valign="top"> bool Ogre::MemoryDataStream::eof </td> |
---|
632 | <td class="md" valign="top">( </td> |
---|
633 | <td class="md" nowrap valign="top">void </td> |
---|
634 | <td class="mdname1" valign="top" nowrap> </td> |
---|
635 | <td class="md" valign="top"> ) </td> |
---|
636 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
637 | </tr> |
---|
638 | |
---|
639 | </table> |
---|
640 | </td> |
---|
641 | </tr> |
---|
642 | </table> |
---|
643 | <table cellspacing=5 cellpadding=0 border=0> |
---|
644 | <tr> |
---|
645 | <td> |
---|
646 | |
---|
647 | </td> |
---|
648 | <td> |
---|
649 | |
---|
650 | <p> |
---|
651 | |
---|
652 | <p> |
---|
653 | |
---|
654 | <p> |
---|
655 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama13">Ogre::DataStream</a>. </td> |
---|
656 | </tr> |
---|
657 | </table> |
---|
658 | <a class="anchor" name="Ogre_1_1ZipDataStreama14" doxytag="Ogre::MemoryDataStream::getAsString" ></a><p> |
---|
659 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
660 | <tr> |
---|
661 | <td class="mdRow"> |
---|
662 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
663 | <tr> |
---|
664 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DataStream::getAsString </td> |
---|
665 | <td class="md" valign="top">( </td> |
---|
666 | <td class="md" nowrap valign="top">void </td> |
---|
667 | <td class="mdname1" valign="top" nowrap> </td> |
---|
668 | <td class="md" valign="top"> ) </td> |
---|
669 | <td class="md" nowrap><code> [virtual, inherited]</code></td> |
---|
670 | </tr> |
---|
671 | |
---|
672 | </table> |
---|
673 | </td> |
---|
674 | </tr> |
---|
675 | </table> |
---|
676 | <table cellspacing=5 cellpadding=0 border=0> |
---|
677 | <tr> |
---|
678 | <td> |
---|
679 | |
---|
680 | </td> |
---|
681 | <td> |
---|
682 | |
---|
683 | <p> |
---|
684 | Returns a String containing the entire stream. |
---|
685 | <p> |
---|
686 | <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> |
---|
687 | </td> |
---|
688 | </tr> |
---|
689 | </table> |
---|
690 | <a class="anchor" name="Ogre_1_1MemoryDataStreama10" doxytag="Ogre::MemoryDataStream::getCurrentPtr" ></a><p> |
---|
691 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
692 | <tr> |
---|
693 | <td class="mdRow"> |
---|
694 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
695 | <tr> |
---|
696 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a466">uchar</a>* Ogre::MemoryDataStream::getCurrentPtr </td> |
---|
697 | <td class="md" valign="top">( </td> |
---|
698 | <td class="md" nowrap valign="top">void </td> |
---|
699 | <td class="mdname1" valign="top" nowrap> </td> |
---|
700 | <td class="md" valign="top"> ) </td> |
---|
701 | <td class="md" nowrap></td> |
---|
702 | </tr> |
---|
703 | |
---|
704 | </table> |
---|
705 | </td> |
---|
706 | </tr> |
---|
707 | </table> |
---|
708 | <table cellspacing=5 cellpadding=0 border=0> |
---|
709 | <tr> |
---|
710 | <td> |
---|
711 | |
---|
712 | </td> |
---|
713 | <td> |
---|
714 | |
---|
715 | <p> |
---|
716 | Get a pointer to the current position in the memory block this stream holds. |
---|
717 | <p> |
---|
718 | |
---|
719 | <p> |
---|
720 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00266">266</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. |
---|
721 | <p> |
---|
722 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00141">Ogre::uchar</a>. </td> |
---|
723 | </tr> |
---|
724 | </table> |
---|
725 | <a class="anchor" name="Ogre_1_1ZipDataStreama13" doxytag="Ogre::MemoryDataStream::getLine" ></a><p> |
---|
726 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
727 | <tr> |
---|
728 | <td class="mdRow"> |
---|
729 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
730 | <tr> |
---|
731 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DataStream::getLine </td> |
---|
732 | <td class="md" valign="top">( </td> |
---|
733 | <td class="md" nowrap valign="top">bool </td> |
---|
734 | <td class="mdname1" valign="top" nowrap> <em>trimAfter</em> = true </td> |
---|
735 | <td class="md" valign="top"> ) </td> |
---|
736 | <td class="md" nowrap><code> [virtual, inherited]</code></td> |
---|
737 | </tr> |
---|
738 | |
---|
739 | </table> |
---|
740 | </td> |
---|
741 | </tr> |
---|
742 | </table> |
---|
743 | <table cellspacing=5 cellpadding=0 border=0> |
---|
744 | <tr> |
---|
745 | <td> |
---|
746 | |
---|
747 | </td> |
---|
748 | <td> |
---|
749 | |
---|
750 | <p> |
---|
751 | Returns a String containing the next line of data, optionally trimmed for whitespace. |
---|
752 | <p> |
---|
753 | <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> |
---|
754 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
755 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
756 | <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> |
---|
757 | </table> |
---|
758 | </dl> |
---|
759 | </td> |
---|
760 | </tr> |
---|
761 | </table> |
---|
762 | <a class="anchor" name="Ogre_1_1ZipDataStreama11" doxytag="Ogre::MemoryDataStream::getName" ></a><p> |
---|
763 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
764 | <tr> |
---|
765 | <td class="mdRow"> |
---|
766 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
767 | <tr> |
---|
768 | <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>& Ogre::DataStream::getName </td> |
---|
769 | <td class="md" valign="top">( </td> |
---|
770 | <td class="md" nowrap valign="top">void </td> |
---|
771 | <td class="mdname1" valign="top" nowrap> </td> |
---|
772 | <td class="md" valign="top"> ) </td> |
---|
773 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
774 | </tr> |
---|
775 | |
---|
776 | </table> |
---|
777 | </td> |
---|
778 | </tr> |
---|
779 | </table> |
---|
780 | <table cellspacing=5 cellpadding=0 border=0> |
---|
781 | <tr> |
---|
782 | <td> |
---|
783 | |
---|
784 | </td> |
---|
785 | <td> |
---|
786 | |
---|
787 | <p> |
---|
788 | Returns the name of the stream, if it has one. |
---|
789 | <p> |
---|
790 | |
---|
791 | <p> |
---|
792 | 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>. |
---|
793 | <p> |
---|
794 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>. </td> |
---|
795 | </tr> |
---|
796 | </table> |
---|
797 | <a class="anchor" name="Ogre_1_1MemoryDataStreama9" doxytag="Ogre::MemoryDataStream::getPtr" ></a><p> |
---|
798 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
799 | <tr> |
---|
800 | <td class="mdRow"> |
---|
801 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
802 | <tr> |
---|
803 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a466">uchar</a>* Ogre::MemoryDataStream::getPtr </td> |
---|
804 | <td class="md" valign="top">( </td> |
---|
805 | <td class="md" nowrap valign="top">void </td> |
---|
806 | <td class="mdname1" valign="top" nowrap> </td> |
---|
807 | <td class="md" valign="top"> ) </td> |
---|
808 | <td class="md" nowrap></td> |
---|
809 | </tr> |
---|
810 | |
---|
811 | </table> |
---|
812 | </td> |
---|
813 | </tr> |
---|
814 | </table> |
---|
815 | <table cellspacing=5 cellpadding=0 border=0> |
---|
816 | <tr> |
---|
817 | <td> |
---|
818 | |
---|
819 | </td> |
---|
820 | <td> |
---|
821 | |
---|
822 | <p> |
---|
823 | Get a pointer to the start of the memory block this stream holds. |
---|
824 | <p> |
---|
825 | |
---|
826 | <p> |
---|
827 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00263">263</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. |
---|
828 | <p> |
---|
829 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00141">Ogre::uchar</a>. </td> |
---|
830 | </tr> |
---|
831 | </table> |
---|
832 | <a class="anchor" name="Ogre_1_1ZipDataStreama12" doxytag="Ogre::MemoryDataStream::operator>>" ></a><p> |
---|
833 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
834 | <tr> |
---|
835 | <td class="mdRow"> |
---|
836 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
837 | <tr> |
---|
838 | <td class="md" colspan="4"> |
---|
839 | template<typename T> </td> |
---|
840 | </tr> |
---|
841 | <tr> |
---|
842 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DataStream.html">DataStream</a>& Ogre::DataStream::operator>> </td> |
---|
843 | <td class="md" valign="top">( </td> |
---|
844 | <td class="md" nowrap valign="top">T & </td> |
---|
845 | <td class="mdname1" valign="top" nowrap> <em>val</em> </td> |
---|
846 | <td class="md" valign="top"> ) </td> |
---|
847 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
848 | </tr> |
---|
849 | |
---|
850 | </table> |
---|
851 | </td> |
---|
852 | </tr> |
---|
853 | </table> |
---|
854 | <table cellspacing=5 cellpadding=0 border=0> |
---|
855 | <tr> |
---|
856 | <td> |
---|
857 | |
---|
858 | </td> |
---|
859 | <td> |
---|
860 | |
---|
861 | <p> |
---|
862 | </td> |
---|
863 | </tr> |
---|
864 | </table> |
---|
865 | <a class="anchor" name="Ogre_1_1MemoryDataStreama11" doxytag="Ogre::MemoryDataStream::read" ></a><p> |
---|
866 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
867 | <tr> |
---|
868 | <td class="mdRow"> |
---|
869 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
870 | <tr> |
---|
871 | <td class="md" nowrap valign="top"> size_t Ogre::MemoryDataStream::read </td> |
---|
872 | <td class="md" valign="top">( </td> |
---|
873 | <td class="md" nowrap valign="top">void * </td> |
---|
874 | <td class="mdname" nowrap> <em>buf</em>, </td> |
---|
875 | </tr> |
---|
876 | <tr> |
---|
877 | <td class="md" nowrap align="right"></td> |
---|
878 | <td></td> |
---|
879 | <td class="md" nowrap>size_t </td> |
---|
880 | <td class="mdname" nowrap> <em>count</em></td> |
---|
881 | </tr> |
---|
882 | <tr> |
---|
883 | <td></td> |
---|
884 | <td class="md">) </td> |
---|
885 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
886 | </tr> |
---|
887 | |
---|
888 | </table> |
---|
889 | </td> |
---|
890 | </tr> |
---|
891 | </table> |
---|
892 | <table cellspacing=5 cellpadding=0 border=0> |
---|
893 | <tr> |
---|
894 | <td> |
---|
895 | |
---|
896 | </td> |
---|
897 | <td> |
---|
898 | |
---|
899 | <p> |
---|
900 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
901 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
902 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
903 | <tr><td valign=top><em>count</em> </td><td>Number of bytes to read </td></tr> |
---|
904 | </table> |
---|
905 | </dl> |
---|
906 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl> |
---|
907 | |
---|
908 | <p> |
---|
909 | |
---|
910 | <p> |
---|
911 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama5">Ogre::DataStream</a>. </td> |
---|
912 | </tr> |
---|
913 | </table> |
---|
914 | <a class="anchor" name="Ogre_1_1MemoryDataStreama12" doxytag="Ogre::MemoryDataStream::readLine" ></a><p> |
---|
915 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
916 | <tr> |
---|
917 | <td class="mdRow"> |
---|
918 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
919 | <tr> |
---|
920 | <td class="md" nowrap valign="top"> size_t Ogre::MemoryDataStream::readLine </td> |
---|
921 | <td class="md" valign="top">( </td> |
---|
922 | <td class="md" nowrap valign="top">char * </td> |
---|
923 | <td class="mdname" nowrap> <em>buf</em>, </td> |
---|
924 | </tr> |
---|
925 | <tr> |
---|
926 | <td class="md" nowrap align="right"></td> |
---|
927 | <td></td> |
---|
928 | <td class="md" nowrap>size_t </td> |
---|
929 | <td class="mdname" nowrap> <em>maxCount</em>, </td> |
---|
930 | </tr> |
---|
931 | <tr> |
---|
932 | <td class="md" nowrap align="right"></td> |
---|
933 | <td></td> |
---|
934 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
935 | <td class="mdname" nowrap> <em>delim</em> = "\n"</td> |
---|
936 | </tr> |
---|
937 | <tr> |
---|
938 | <td></td> |
---|
939 | <td class="md">) </td> |
---|
940 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
941 | </tr> |
---|
942 | |
---|
943 | </table> |
---|
944 | </td> |
---|
945 | </tr> |
---|
946 | </table> |
---|
947 | <table cellspacing=5 cellpadding=0 border=0> |
---|
948 | <tr> |
---|
949 | <td> |
---|
950 | |
---|
951 | </td> |
---|
952 | <td> |
---|
953 | |
---|
954 | <p> |
---|
955 | <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> |
---|
956 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
957 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
958 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
959 | <tr><td valign=top><em>maxCount</em> </td><td>The maximum length of data to be read, excluding the terminating character </td></tr> |
---|
960 | <tr><td valign=top><em>delim</em> </td><td>The delimiter to stop at </td></tr> |
---|
961 | </table> |
---|
962 | </dl> |
---|
963 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read, excluding the terminating character </dd></dl> |
---|
964 | |
---|
965 | <p> |
---|
966 | |
---|
967 | <p> |
---|
968 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama6">Ogre::DataStream</a>. </td> |
---|
969 | </tr> |
---|
970 | </table> |
---|
971 | <a class="anchor" name="Ogre_1_1MemoryDataStreama15" doxytag="Ogre::MemoryDataStream::seek" ></a><p> |
---|
972 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
973 | <tr> |
---|
974 | <td class="mdRow"> |
---|
975 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
976 | <tr> |
---|
977 | <td class="md" nowrap valign="top"> void Ogre::MemoryDataStream::seek </td> |
---|
978 | <td class="md" valign="top">( </td> |
---|
979 | <td class="md" nowrap valign="top">size_t </td> |
---|
980 | <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> |
---|
981 | <td class="md" valign="top"> ) </td> |
---|
982 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
983 | </tr> |
---|
984 | |
---|
985 | </table> |
---|
986 | </td> |
---|
987 | </tr> |
---|
988 | </table> |
---|
989 | <table cellspacing=5 cellpadding=0 border=0> |
---|
990 | <tr> |
---|
991 | <td> |
---|
992 | |
---|
993 | </td> |
---|
994 | <td> |
---|
995 | |
---|
996 | <p> |
---|
997 | |
---|
998 | <p> |
---|
999 | |
---|
1000 | <p> |
---|
1001 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama11">Ogre::DataStream</a>. </td> |
---|
1002 | </tr> |
---|
1003 | </table> |
---|
1004 | <a class="anchor" name="Ogre_1_1MemoryDataStreama19" doxytag="Ogre::MemoryDataStream::setFreeOnClose" ></a><p> |
---|
1005 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1006 | <tr> |
---|
1007 | <td class="mdRow"> |
---|
1008 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1009 | <tr> |
---|
1010 | <td class="md" nowrap valign="top"> void Ogre::MemoryDataStream::setFreeOnClose </td> |
---|
1011 | <td class="md" valign="top">( </td> |
---|
1012 | <td class="md" nowrap valign="top">bool </td> |
---|
1013 | <td class="mdname1" valign="top" nowrap> <em>free</em> </td> |
---|
1014 | <td class="md" valign="top"> ) </td> |
---|
1015 | <td class="md" nowrap></td> |
---|
1016 | </tr> |
---|
1017 | |
---|
1018 | </table> |
---|
1019 | </td> |
---|
1020 | </tr> |
---|
1021 | </table> |
---|
1022 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1023 | <tr> |
---|
1024 | <td> |
---|
1025 | |
---|
1026 | </td> |
---|
1027 | <td> |
---|
1028 | |
---|
1029 | <p> |
---|
1030 | Sets whether or not to free the encapsulated memory on close. |
---|
1031 | <p> |
---|
1032 | |
---|
1033 | <p> |
---|
1034 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00300">300</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
1035 | </tr> |
---|
1036 | </table> |
---|
1037 | <a class="anchor" name="Ogre_1_1ZipDataStreama15" doxytag="Ogre::MemoryDataStream::size" ></a><p> |
---|
1038 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1039 | <tr> |
---|
1040 | <td class="mdRow"> |
---|
1041 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1042 | <tr> |
---|
1043 | <td class="md" nowrap valign="top"> size_t Ogre::DataStream::size </td> |
---|
1044 | <td class="md" valign="top">( </td> |
---|
1045 | <td class="md" nowrap valign="top">void </td> |
---|
1046 | <td class="mdname1" valign="top" nowrap> </td> |
---|
1047 | <td class="md" valign="top"> ) </td> |
---|
1048 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
1049 | </tr> |
---|
1050 | |
---|
1051 | </table> |
---|
1052 | </td> |
---|
1053 | </tr> |
---|
1054 | </table> |
---|
1055 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1056 | <tr> |
---|
1057 | <td> |
---|
1058 | |
---|
1059 | </td> |
---|
1060 | <td> |
---|
1061 | |
---|
1062 | <p> |
---|
1063 | Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. |
---|
1064 | <p> |
---|
1065 | |
---|
1066 | <p> |
---|
1067 | 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> |
---|
1068 | </tr> |
---|
1069 | </table> |
---|
1070 | <a class="anchor" name="Ogre_1_1MemoryDataStreama14" doxytag="Ogre::MemoryDataStream::skip" ></a><p> |
---|
1071 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1072 | <tr> |
---|
1073 | <td class="mdRow"> |
---|
1074 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1075 | <tr> |
---|
1076 | <td class="md" nowrap valign="top"> void Ogre::MemoryDataStream::skip </td> |
---|
1077 | <td class="md" valign="top">( </td> |
---|
1078 | <td class="md" nowrap valign="top">long </td> |
---|
1079 | <td class="mdname1" valign="top" nowrap> <em>count</em> </td> |
---|
1080 | <td class="md" valign="top"> ) </td> |
---|
1081 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
1082 | </tr> |
---|
1083 | |
---|
1084 | </table> |
---|
1085 | </td> |
---|
1086 | </tr> |
---|
1087 | </table> |
---|
1088 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1089 | <tr> |
---|
1090 | <td> |
---|
1091 | |
---|
1092 | </td> |
---|
1093 | <td> |
---|
1094 | |
---|
1095 | <p> |
---|
1096 | This can also be a negative value, in which case the file pointer rewinds a defined number of bytes. |
---|
1097 | <p> |
---|
1098 | |
---|
1099 | <p> |
---|
1100 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama10">Ogre::DataStream</a>. </td> |
---|
1101 | </tr> |
---|
1102 | </table> |
---|
1103 | <a class="anchor" name="Ogre_1_1MemoryDataStreama13" doxytag="Ogre::MemoryDataStream::skipLine" ></a><p> |
---|
1104 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1105 | <tr> |
---|
1106 | <td class="mdRow"> |
---|
1107 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1108 | <tr> |
---|
1109 | <td class="md" nowrap valign="top"> size_t Ogre::MemoryDataStream::skipLine </td> |
---|
1110 | <td class="md" valign="top">( </td> |
---|
1111 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
1112 | <td class="mdname1" valign="top" nowrap> <em>delim</em> = "\n" </td> |
---|
1113 | <td class="md" valign="top"> ) </td> |
---|
1114 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
1115 | </tr> |
---|
1116 | |
---|
1117 | </table> |
---|
1118 | </td> |
---|
1119 | </tr> |
---|
1120 | </table> |
---|
1121 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1122 | <tr> |
---|
1123 | <td> |
---|
1124 | |
---|
1125 | </td> |
---|
1126 | <td> |
---|
1127 | |
---|
1128 | <p> |
---|
1129 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1130 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1131 | <tr><td valign=top><em>delim</em> </td><td>The delimiter(s) to stop at </td></tr> |
---|
1132 | </table> |
---|
1133 | </dl> |
---|
1134 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl> |
---|
1135 | |
---|
1136 | <p> |
---|
1137 | |
---|
1138 | <p> |
---|
1139 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama9">Ogre::DataStream</a>. </td> |
---|
1140 | </tr> |
---|
1141 | </table> |
---|
1142 | <a class="anchor" name="Ogre_1_1MemoryDataStreama16" doxytag="Ogre::MemoryDataStream::tell" ></a><p> |
---|
1143 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1144 | <tr> |
---|
1145 | <td class="mdRow"> |
---|
1146 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1147 | <tr> |
---|
1148 | <td class="md" nowrap valign="top"> size_t Ogre::MemoryDataStream::tell </td> |
---|
1149 | <td class="md" valign="top">( </td> |
---|
1150 | <td class="md" nowrap valign="top">void </td> |
---|
1151 | <td class="mdname1" valign="top" nowrap> </td> |
---|
1152 | <td class="md" valign="top"> ) </td> |
---|
1153 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
1154 | </tr> |
---|
1155 | |
---|
1156 | </table> |
---|
1157 | </td> |
---|
1158 | </tr> |
---|
1159 | </table> |
---|
1160 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1161 | <tr> |
---|
1162 | <td> |
---|
1163 | |
---|
1164 | </td> |
---|
1165 | <td> |
---|
1166 | |
---|
1167 | <p> |
---|
1168 | |
---|
1169 | <p> |
---|
1170 | |
---|
1171 | <p> |
---|
1172 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama12">Ogre::DataStream</a>. </td> |
---|
1173 | </tr> |
---|
1174 | </table> |
---|
1175 | <hr><h2>Member Data Documentation</h2> |
---|
1176 | <a class="anchor" name="Ogre_1_1MemoryDataStreamp0" doxytag="Ogre::MemoryDataStream::mData" ></a><p> |
---|
1177 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1178 | <tr> |
---|
1179 | <td class="mdRow"> |
---|
1180 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1181 | <tr> |
---|
1182 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a466">uchar</a>* <a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp0">Ogre::MemoryDataStream::mData</a><code> [protected]</code> |
---|
1183 | </table> |
---|
1184 | </td> |
---|
1185 | </tr> |
---|
1186 | </table> |
---|
1187 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1188 | <tr> |
---|
1189 | <td> |
---|
1190 | |
---|
1191 | </td> |
---|
1192 | <td> |
---|
1193 | |
---|
1194 | <p> |
---|
1195 | Pointer to the start of the data area. |
---|
1196 | <p> |
---|
1197 | |
---|
1198 | <p> |
---|
1199 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00162">162</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
1200 | </tr> |
---|
1201 | </table> |
---|
1202 | <a class="anchor" name="Ogre_1_1MemoryDataStreamp2" doxytag="Ogre::MemoryDataStream::mEnd" ></a><p> |
---|
1203 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1204 | <tr> |
---|
1205 | <td class="mdRow"> |
---|
1206 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1207 | <tr> |
---|
1208 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a466">uchar</a>* <a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp2">Ogre::MemoryDataStream::mEnd</a><code> [protected]</code> |
---|
1209 | </table> |
---|
1210 | </td> |
---|
1211 | </tr> |
---|
1212 | </table> |
---|
1213 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1214 | <tr> |
---|
1215 | <td> |
---|
1216 | |
---|
1217 | </td> |
---|
1218 | <td> |
---|
1219 | |
---|
1220 | <p> |
---|
1221 | Pointer to the end of the memory. |
---|
1222 | <p> |
---|
1223 | |
---|
1224 | <p> |
---|
1225 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00166">166</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
1226 | </tr> |
---|
1227 | </table> |
---|
1228 | <a class="anchor" name="Ogre_1_1MemoryDataStreamp3" doxytag="Ogre::MemoryDataStream::mFreeOnClose" ></a><p> |
---|
1229 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1230 | <tr> |
---|
1231 | <td class="mdRow"> |
---|
1232 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1233 | <tr> |
---|
1234 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp3">Ogre::MemoryDataStream::mFreeOnClose</a><code> [protected]</code> |
---|
1235 | </table> |
---|
1236 | </td> |
---|
1237 | </tr> |
---|
1238 | </table> |
---|
1239 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1240 | <tr> |
---|
1241 | <td> |
---|
1242 | |
---|
1243 | </td> |
---|
1244 | <td> |
---|
1245 | |
---|
1246 | <p> |
---|
1247 | Do we delete the memory on close. |
---|
1248 | <p> |
---|
1249 | |
---|
1250 | <p> |
---|
1251 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00168">168</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
1252 | </tr> |
---|
1253 | </table> |
---|
1254 | <a class="anchor" name="Ogre_1_1ZipDataStreamp2" doxytag="Ogre::MemoryDataStream::mName" ></a><p> |
---|
1255 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1256 | <tr> |
---|
1257 | <td class="mdRow"> |
---|
1258 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1259 | <tr> |
---|
1260 | <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> |
---|
1261 | </table> |
---|
1262 | </td> |
---|
1263 | </tr> |
---|
1264 | </table> |
---|
1265 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1266 | <tr> |
---|
1267 | <td> |
---|
1268 | |
---|
1269 | </td> |
---|
1270 | <td> |
---|
1271 | |
---|
1272 | <p> |
---|
1273 | The name (e.g. resource name) that can be used to identify the source fot his data (optional). |
---|
1274 | <p> |
---|
1275 | |
---|
1276 | <p> |
---|
1277 | 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> |
---|
1278 | </tr> |
---|
1279 | </table> |
---|
1280 | <a class="anchor" name="Ogre_1_1MemoryDataStreamp1" doxytag="Ogre::MemoryDataStream::mPos" ></a><p> |
---|
1281 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1282 | <tr> |
---|
1283 | <td class="mdRow"> |
---|
1284 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1285 | <tr> |
---|
1286 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a466">uchar</a>* <a class="el" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp1">Ogre::MemoryDataStream::mPos</a><code> [protected]</code> |
---|
1287 | </table> |
---|
1288 | </td> |
---|
1289 | </tr> |
---|
1290 | </table> |
---|
1291 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1292 | <tr> |
---|
1293 | <td> |
---|
1294 | |
---|
1295 | </td> |
---|
1296 | <td> |
---|
1297 | |
---|
1298 | <p> |
---|
1299 | Pointer to the current position in the memory. |
---|
1300 | <p> |
---|
1301 | |
---|
1302 | <p> |
---|
1303 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00164">164</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
1304 | </tr> |
---|
1305 | </table> |
---|
1306 | <a class="anchor" name="Ogre_1_1ZipDataStreamp3" doxytag="Ogre::MemoryDataStream::mSize" ></a><p> |
---|
1307 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1308 | <tr> |
---|
1309 | <td class="mdRow"> |
---|
1310 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1311 | <tr> |
---|
1312 | <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> |
---|
1313 | </table> |
---|
1314 | </td> |
---|
1315 | </tr> |
---|
1316 | </table> |
---|
1317 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1318 | <tr> |
---|
1319 | <td> |
---|
1320 | |
---|
1321 | </td> |
---|
1322 | <td> |
---|
1323 | |
---|
1324 | <p> |
---|
1325 | Size of the data in the stream (may be 0 if size cannot be determined). |
---|
1326 | <p> |
---|
1327 | |
---|
1328 | <p> |
---|
1329 | 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> |
---|
1330 | </tr> |
---|
1331 | </table> |
---|
1332 | <a class="anchor" name="Ogre_1_1ZipDataStreamp4" doxytag="Ogre::MemoryDataStream::mTmpArea" ></a><p> |
---|
1333 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1334 | <tr> |
---|
1335 | <td class="mdRow"> |
---|
1336 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1337 | <tr> |
---|
1338 | <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> |
---|
1339 | </table> |
---|
1340 | </td> |
---|
1341 | </tr> |
---|
1342 | </table> |
---|
1343 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1344 | <tr> |
---|
1345 | <td> |
---|
1346 | |
---|
1347 | </td> |
---|
1348 | <td> |
---|
1349 | |
---|
1350 | <p> |
---|
1351 | Temporary buffer area used for formatted read. |
---|
1352 | <p> |
---|
1353 | |
---|
1354 | <p> |
---|
1355 | 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> |
---|
1356 | </tr> |
---|
1357 | </table> |
---|
1358 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
1359 | <li><a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a></ul> |
---|
1360 | <hr> |
---|
1361 | <p> |
---|
1362 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
1363 | <!--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/> |
---|
1364 | 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/> |
---|
1365 | <!--/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#"> |
---|
1366 | <Work rdf:about=""> |
---|
1367 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
1368 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
1369 | </Work> |
---|
1370 | <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> --> |
---|
1371 | |
---|
1372 | Last modified Sun Mar 12 14:38:38 2006 |
---|
1373 | </p> |
---|
1374 | </body> |
---|
1375 | </html> |
---|