diff options
Diffstat (limited to 'libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_read_file.html')
-rw-r--r-- | libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_read_file.html | 290 |
1 files changed, 290 insertions, 0 deletions
diff --git a/libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_read_file.html b/libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_read_file.html new file mode 100644 index 0000000..d28543a --- /dev/null +++ b/libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_read_file.html | |||
@@ -0,0 +1,290 @@ | |||
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
2 | <html xmlns="http://www.w3.org/1999/xhtml"> | ||
3 | <head> | ||
4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
5 | <title>Irrlicht 3D Engine: irr::io::IReadFile Class Reference</title> | ||
6 | |||
7 | <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
8 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
9 | <link href="navtree.css" rel="stylesheet" type="text/css"/> | ||
10 | <script type="text/javascript" src="jquery.js"></script> | ||
11 | <script type="text/javascript" src="resize.js"></script> | ||
12 | <script type="text/javascript" src="navtree.js"></script> | ||
13 | <script type="text/javascript"> | ||
14 | $(document).ready(initResizable); | ||
15 | </script> | ||
16 | <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
17 | <script type="text/javascript" src="search/search.js"></script> | ||
18 | <script type="text/javascript"> | ||
19 | $(document).ready(function() { searchBox.OnSelectItem(0); }); | ||
20 | </script> | ||
21 | |||
22 | </head> | ||
23 | <body> | ||
24 | <div id="top"><!-- do not remove this div! --> | ||
25 | |||
26 | |||
27 | <div id="titlearea"> | ||
28 | <table cellspacing="0" cellpadding="0"> | ||
29 | <tbody> | ||
30 | <tr style="height: 56px;"> | ||
31 | |||
32 | <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td> | ||
33 | |||
34 | |||
35 | <td style="padding-left: 0.5em;"> | ||
36 | <div id="projectname">Irrlicht 3D Engine | ||
37 | |||
38 | </div> | ||
39 | |||
40 | </td> | ||
41 | |||
42 | |||
43 | |||
44 | |||
45 | <td> <div id="MSearchBox" class="MSearchBoxInactive"> | ||
46 | <span class="left"> | ||
47 | <img id="MSearchSelect" src="search/mag_sel.png" | ||
48 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
49 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
50 | alt=""/> | ||
51 | <input type="text" id="MSearchField" value="Search" accesskey="S" | ||
52 | onfocus="searchBox.OnSearchFieldFocus(true)" | ||
53 | onblur="searchBox.OnSearchFieldFocus(false)" | ||
54 | onkeyup="searchBox.OnSearchFieldChange(event)"/> | ||
55 | </span><span class="right"> | ||
56 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> | ||
57 | </span> | ||
58 | </div> | ||
59 | </td> | ||
60 | |||
61 | |||
62 | </tr> | ||
63 | </tbody> | ||
64 | </table> | ||
65 | </div> | ||
66 | |||
67 | <!-- Generated by Doxygen 1.7.5.1 --> | ||
68 | <script type="text/javascript"> | ||
69 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); | ||
70 | </script> | ||
71 | <script type="text/javascript" src="dynsections.js"></script> | ||
72 | </div> | ||
73 | <div id="side-nav" class="ui-resizable side-nav-resizable"> | ||
74 | <div id="nav-tree"> | ||
75 | <div id="nav-tree-contents"> | ||
76 | </div> | ||
77 | </div> | ||
78 | <div id="splitbar" style="-moz-user-select:none;" | ||
79 | class="ui-resizable-handle"> | ||
80 | </div> | ||
81 | </div> | ||
82 | <script type="text/javascript"> | ||
83 | initNavTree('classirr_1_1io_1_1_i_read_file.html',''); | ||
84 | </script> | ||
85 | <div id="doc-content"> | ||
86 | <div class="header"> | ||
87 | <div class="summary"> | ||
88 | <a href="#pub-methods">Public Member Functions</a> </div> | ||
89 | <div class="headertitle"> | ||
90 | <div class="title">irr::io::IReadFile Class Reference</div> </div> | ||
91 | </div> | ||
92 | <div class="contents"> | ||
93 | <!-- doxytag: class="irr::io::IReadFile" --><!-- doxytag: inherits="irr::IReferenceCounted" --> | ||
94 | <p>Interface providing read acess to a file. | ||
95 | <a href="classirr_1_1io_1_1_i_read_file.html#details">More...</a></p> | ||
96 | |||
97 | <p><code>#include <<a class="el" href="_i_read_file_8h_source.html">IReadFile.h</a>></code></p> | ||
98 | <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> | ||
99 | <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::io::IReadFile:</div> | ||
100 | <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> | ||
101 | </div> | ||
102 | <div id="dynsection-0-content" class="dyncontent" style="display:none;"> | ||
103 | <div class="center"> | ||
104 | <img src="classirr_1_1io_1_1_i_read_file.png" usemap="#irr::io::IReadFile_map" alt=""/> | ||
105 | <map id="irr::io::IReadFile_map" name="irr::io::IReadFile_map"> | ||
106 | <area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24"/> | ||
107 | </map> | ||
108 | </div></div> | ||
109 | |||
110 | <p><a href="classirr_1_1io_1_1_i_read_file-members.html">List of all members.</a></p> | ||
111 | <h2><a name="pub-methods"></a> | ||
112 | Public Member Functions</h2> | ||
113 | <ul> | ||
114 | <li>virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> & <a class="el" href="classirr_1_1io_1_1_i_read_file.html#a73b9c884319d2e4b0ff9a7ea15cbf316">getFileName</a> () const =0 | ||
115 | <dl class="el"><dd class="mdescRight">Get name of file. <a href="#a73b9c884319d2e4b0ff9a7ea15cbf316"></a><br/></dl><li>virtual long <a class="el" href="classirr_1_1io_1_1_i_read_file.html#aeee143ee38871c30f240c025b100941d">getPos</a> () const =0 | ||
116 | <dl class="el"><dd class="mdescRight">Get the current position in the file. <a href="#aeee143ee38871c30f240c025b100941d"></a><br/></dl><li>virtual long <a class="el" href="classirr_1_1io_1_1_i_read_file.html#a9c64fca7f1d665d7e458cd7d766c35a2">getSize</a> () const =0 | ||
117 | <dl class="el"><dd class="mdescRight">Get size of file. <a href="#a9c64fca7f1d665d7e458cd7d766c35a2"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1io_1_1_i_read_file.html#ab51878d36bc9dd3964b664055fbeb13f">read</a> (void *buffer, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> sizeToRead)=0 | ||
118 | <dl class="el"><dd class="mdescRight">Reads an amount of bytes from the file. <a href="#ab51878d36bc9dd3964b664055fbeb13f"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_read_file.html#ac1cd81f18832e8703838d7abd495bf34">seek</a> (long finalPos, bool relativeMovement=false)=0 | ||
119 | <dl class="el"><dd class="mdescRight">Changes position in file. <a href="#ac1cd81f18832e8703838d7abd495bf34"></a><br/></dl></ul> | ||
120 | <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> | ||
121 | <div class="textblock"><p>Interface providing read acess to a file. </p> | ||
122 | |||
123 | <p>Definition at line <a class="el" href="_i_read_file_8h_source.html#l00017">17</a> of file <a class="el" href="_i_read_file_8h_source.html">IReadFile.h</a>.</p> | ||
124 | </div><hr/><h2>Member Function Documentation</h2> | ||
125 | <a class="anchor" id="a73b9c884319d2e4b0ff9a7ea15cbf316"></a><!-- doxytag: member="irr::io::IReadFile::getFileName" ref="a73b9c884319d2e4b0ff9a7ea15cbf316" args="() const =0" --> | ||
126 | <div class="memitem"> | ||
127 | <div class="memproto"> | ||
128 | <table class="memname"> | ||
129 | <tr> | ||
130 | <td class="memname">virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a>& irr::io::IReadFile::getFileName </td> | ||
131 | <td>(</td> | ||
132 | <td class="paramname"></td><td>)</td> | ||
133 | <td> const<code> [pure virtual]</code></td> | ||
134 | </tr> | ||
135 | </table> | ||
136 | </div> | ||
137 | <div class="memdoc"> | ||
138 | |||
139 | <p>Get name of file. </p> | ||
140 | <dl class="return"><dt><b>Returns:</b></dt><dd>File name as zero terminated character string. </dd></dl> | ||
141 | |||
142 | </div> | ||
143 | </div> | ||
144 | <a class="anchor" id="aeee143ee38871c30f240c025b100941d"></a><!-- doxytag: member="irr::io::IReadFile::getPos" ref="aeee143ee38871c30f240c025b100941d" args="() const =0" --> | ||
145 | <div class="memitem"> | ||
146 | <div class="memproto"> | ||
147 | <table class="memname"> | ||
148 | <tr> | ||
149 | <td class="memname">virtual long irr::io::IReadFile::getPos </td> | ||
150 | <td>(</td> | ||
151 | <td class="paramname"></td><td>)</td> | ||
152 | <td> const<code> [pure virtual]</code></td> | ||
153 | </tr> | ||
154 | </table> | ||
155 | </div> | ||
156 | <div class="memdoc"> | ||
157 | |||
158 | <p>Get the current position in the file. </p> | ||
159 | <dl class="return"><dt><b>Returns:</b></dt><dd>Current position in the file in bytes. </dd></dl> | ||
160 | |||
161 | </div> | ||
162 | </div> | ||
163 | <a class="anchor" id="a9c64fca7f1d665d7e458cd7d766c35a2"></a><!-- doxytag: member="irr::io::IReadFile::getSize" ref="a9c64fca7f1d665d7e458cd7d766c35a2" args="() const =0" --> | ||
164 | <div class="memitem"> | ||
165 | <div class="memproto"> | ||
166 | <table class="memname"> | ||
167 | <tr> | ||
168 | <td class="memname">virtual long irr::io::IReadFile::getSize </td> | ||
169 | <td>(</td> | ||
170 | <td class="paramname"></td><td>)</td> | ||
171 | <td> const<code> [pure virtual]</code></td> | ||
172 | </tr> | ||
173 | </table> | ||
174 | </div> | ||
175 | <div class="memdoc"> | ||
176 | |||
177 | <p>Get size of file. </p> | ||
178 | <dl class="return"><dt><b>Returns:</b></dt><dd>Size of the file in bytes. </dd></dl> | ||
179 | |||
180 | </div> | ||
181 | </div> | ||
182 | <a class="anchor" id="ab51878d36bc9dd3964b664055fbeb13f"></a><!-- doxytag: member="irr::io::IReadFile::read" ref="ab51878d36bc9dd3964b664055fbeb13f" args="(void *buffer, u32 sizeToRead)=0" --> | ||
183 | <div class="memitem"> | ||
184 | <div class="memproto"> | ||
185 | <table class="memname"> | ||
186 | <tr> | ||
187 | <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::io::IReadFile::read </td> | ||
188 | <td>(</td> | ||
189 | <td class="paramtype">void * </td> | ||
190 | <td class="paramname"><em>buffer</em>, </td> | ||
191 | </tr> | ||
192 | <tr> | ||
193 | <td class="paramkey"></td> | ||
194 | <td></td> | ||
195 | <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> | ||
196 | <td class="paramname"><em>sizeToRead</em> </td> | ||
197 | </tr> | ||
198 | <tr> | ||
199 | <td></td> | ||
200 | <td>)</td> | ||
201 | <td></td><td><code> [pure virtual]</code></td> | ||
202 | </tr> | ||
203 | </table> | ||
204 | </div> | ||
205 | <div class="memdoc"> | ||
206 | |||
207 | <p>Reads an amount of bytes from the file. </p> | ||
208 | <dl><dt><b>Parameters:</b></dt><dd> | ||
209 | <table class="params"> | ||
210 | <tr><td class="paramname">buffer</td><td>Pointer to buffer where read bytes are written to. </td></tr> | ||
211 | <tr><td class="paramname">sizeToRead</td><td>Amount of bytes to read from the file. </td></tr> | ||
212 | </table> | ||
213 | </dd> | ||
214 | </dl> | ||
215 | <dl class="return"><dt><b>Returns:</b></dt><dd>How many bytes were read. </dd></dl> | ||
216 | |||
217 | </div> | ||
218 | </div> | ||
219 | <a class="anchor" id="ac1cd81f18832e8703838d7abd495bf34"></a><!-- doxytag: member="irr::io::IReadFile::seek" ref="ac1cd81f18832e8703838d7abd495bf34" args="(long finalPos, bool relativeMovement=false)=0" --> | ||
220 | <div class="memitem"> | ||
221 | <div class="memproto"> | ||
222 | <table class="memname"> | ||
223 | <tr> | ||
224 | <td class="memname">virtual bool irr::io::IReadFile::seek </td> | ||
225 | <td>(</td> | ||
226 | <td class="paramtype">long </td> | ||
227 | <td class="paramname"><em>finalPos</em>, </td> | ||
228 | </tr> | ||
229 | <tr> | ||
230 | <td class="paramkey"></td> | ||
231 | <td></td> | ||
232 | <td class="paramtype">bool </td> | ||
233 | <td class="paramname"><em>relativeMovement</em> = <code>false</code> </td> | ||
234 | </tr> | ||
235 | <tr> | ||
236 | <td></td> | ||
237 | <td>)</td> | ||
238 | <td></td><td><code> [pure virtual]</code></td> | ||
239 | </tr> | ||
240 | </table> | ||
241 | </div> | ||
242 | <div class="memdoc"> | ||
243 | |||
244 | <p>Changes position in file. </p> | ||
245 | <dl><dt><b>Parameters:</b></dt><dd> | ||
246 | <table class="params"> | ||
247 | <tr><td class="paramname">finalPos</td><td>Destination position in the file. </td></tr> | ||
248 | <tr><td class="paramname">relativeMovement</td><td>If set to true, the position in the file is changed relative to current position. Otherwise the position is changed from beginning of file. </td></tr> | ||
249 | </table> | ||
250 | </dd> | ||
251 | </dl> | ||
252 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if successful, otherwise false. </dd></dl> | ||
253 | |||
254 | </div> | ||
255 | </div> | ||
256 | <hr/>The documentation for this class was generated from the following file:<ul> | ||
257 | <li><a class="el" href="_i_read_file_8h_source.html">IReadFile.h</a></li> | ||
258 | </ul> | ||
259 | </div> | ||
260 | </div> | ||
261 | <div id="nav-path" class="navpath"> | ||
262 | <ul> | ||
263 | <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> | ||
264 | <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li> | ||
265 | <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> </li> | ||
266 | <!-- window showing the filter options --> | ||
267 | <div id="MSearchSelectWindow" | ||
268 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
269 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
270 | onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
271 | <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div> | ||
272 | |||
273 | <!-- iframe showing the search results (closed by default) --> | ||
274 | <div id="MSearchResultsWindow"> | ||
275 | <iframe src="javascript:void(0)" frameborder="0" | ||
276 | name="MSearchResults" id="MSearchResults"> | ||
277 | </iframe> | ||
278 | </div> | ||
279 | |||
280 | |||
281 | <li class="footer"> | ||
282 | <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht | ||
283 | Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Tue Nov 6 2012 11:06:05 for Irrlicht 3D Engine by | ||
284 | <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> | ||
285 | </ul> | ||
286 | </div> | ||
287 | |||
288 | |||
289 | </body> | ||
290 | </html> | ||