diff options
Diffstat (limited to 'doc/html/classirr_1_1io_1_1_i_write_file.html')
| -rw-r--r-- | doc/html/classirr_1_1io_1_1_i_write_file.html | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/doc/html/classirr_1_1io_1_1_i_write_file.html b/doc/html/classirr_1_1io_1_1_i_write_file.html new file mode 100644 index 0000000..f0e332b --- /dev/null +++ b/doc/html/classirr_1_1io_1_1_i_write_file.html @@ -0,0 +1,270 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>Irrlicht 3D Engine: irr::io::IWriteFile Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Irrlicht 3D Engine + + </div> + + </td> + + + + + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> +</td> + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="dynsections.js"></script> +</div> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> + initNavTree('classirr_1_1io_1_1_i_write_file.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">irr::io::IWriteFile Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="irr::io::IWriteFile" --><!-- doxytag: inherits="irr::IReferenceCounted" --> +<p>Interface providing write access to a file. + <a href="classirr_1_1io_1_1_i_write_file.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_i_write_file_8h_source.html">IWriteFile.h</a>></code></p> +<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::io::IWriteFile:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> + <div class="center"> + <img src="classirr_1_1io_1_1_i_write_file.png" usemap="#irr::io::IWriteFile_map" alt=""/> + <map id="irr::io::IWriteFile_map" name="irr::io::IWriteFile_map"> +<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"/> +</map> + </div></div> + +<p><a href="classirr_1_1io_1_1_i_write_file-members.html">List of all members.</a></p> +<h2><a name="pub-methods"></a> +Public Member Functions</h2> +<ul> +<li>virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & <a class="el" href="classirr_1_1io_1_1_i_write_file.html#ad129ab8feac03f06f2edf685df6a0236">getFileName</a> () const =0 +<dl class="el"><dd class="mdescRight">Get name of file. <a href="#ad129ab8feac03f06f2edf685df6a0236"></a><br/></dl><li>virtual long <a class="el" href="classirr_1_1io_1_1_i_write_file.html#a062eaf082b6f4d05cf0e44b85aa7a6ab">getPos</a> () const =0 +<dl class="el"><dd class="mdescRight">Get the current position in the file. <a href="#a062eaf082b6f4d05cf0e44b85aa7a6ab"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_write_file.html#ad68289024b2a2079fce20ca9b95c9519">seek</a> (long finalPos, bool relativeMovement=false)=0 +<dl class="el"><dd class="mdescRight">Changes position in file. <a href="#ad68289024b2a2079fce20ca9b95c9519"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1io_1_1_i_write_file.html#a32ce2fb186c4a21fcf3c85adb13c7c77">write</a> (const void *buffer, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> sizeToWrite)=0 +<dl class="el"><dd class="mdescRight">Writes an amount of bytes to the file. <a href="#a32ce2fb186c4a21fcf3c85adb13c7c77"></a><br/></dl></ul> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Interface providing write access to a file. </p> + +<p>Definition at line <a class="el" href="_i_write_file_8h_source.html#l00017">17</a> of file <a class="el" href="_i_write_file_8h_source.html">IWriteFile.h</a>.</p> +</div><hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ad129ab8feac03f06f2edf685df6a0236"></a><!-- doxytag: member="irr::io::IWriteFile::getFileName" ref="ad129ab8feac03f06f2edf685df6a0236" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a>& irr::io::IWriteFile::getFileName </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Get name of file. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>File name as zero terminated character string. </dd></dl> + +</div> +</div> +<a class="anchor" id="a062eaf082b6f4d05cf0e44b85aa7a6ab"></a><!-- doxytag: member="irr::io::IWriteFile::getPos" ref="a062eaf082b6f4d05cf0e44b85aa7a6ab" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual long irr::io::IWriteFile::getPos </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Get the current position in the file. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Current position in the file in bytes. </dd></dl> + +</div> +</div> +<a class="anchor" id="ad68289024b2a2079fce20ca9b95c9519"></a><!-- doxytag: member="irr::io::IWriteFile::seek" ref="ad68289024b2a2079fce20ca9b95c9519" args="(long finalPos, bool relativeMovement=false)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool irr::io::IWriteFile::seek </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>finalPos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>relativeMovement</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Changes position in file. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">finalPos</td><td>Destination position in the file. </td></tr> + <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 begin of file. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>True if successful, otherwise false. </dd></dl> + +</div> +</div> +<a class="anchor" id="a32ce2fb186c4a21fcf3c85adb13c7c77"></a><!-- doxytag: member="irr::io::IWriteFile::write" ref="a32ce2fb186c4a21fcf3c85adb13c7c77" args="(const void *buffer, u32 sizeToWrite)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::io::IWriteFile::write </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> + <td class="paramname"><em>sizeToWrite</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Writes an amount of bytes to the file. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">buffer</td><td>Pointer to buffer of bytes to write. </td></tr> + <tr><td class="paramname">sizeToWrite</td><td>Amount of bytes to write to the file. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>How much bytes were written. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="_i_write_file_8h_source.html">IWriteFile.h</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> + <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li> + <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a> </li> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<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> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + + <li class="footer"> +<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht +Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Fri Mar 12 2021 17:22:04 for Irrlicht 3D Engine by +<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> + </ul> + </div> + + +</body> +</html> |