diff options
author | David Walter Seikel | 2013-01-13 17:24:39 +1000 |
---|---|---|
committer | David Walter Seikel | 2013-01-13 17:24:39 +1000 |
commit | 393b5cd1dc438872af89d334ef6e5fcc59f27d47 (patch) | |
tree | 6a14521219942a08a1b95cb2f5a923a9edd60f63 /libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_file_system.html | |
parent | Add a note about rasters suggested start up code. (diff) | |
download | SledjHamr-393b5cd1dc438872af89d334ef6e5fcc59f27d47.zip SledjHamr-393b5cd1dc438872af89d334ef6e5fcc59f27d47.tar.gz SledjHamr-393b5cd1dc438872af89d334ef6e5fcc59f27d47.tar.bz2 SledjHamr-393b5cd1dc438872af89d334ef6e5fcc59f27d47.tar.xz |
Added Irrlicht 1.8, but without all the Windows binaries.
Diffstat (limited to '')
-rw-r--r-- | libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_file_system.html | 1381 |
1 files changed, 1381 insertions, 0 deletions
diff --git a/libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_file_system.html b/libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_file_system.html new file mode 100644 index 0000000..519c534 --- /dev/null +++ b/libraries/irrlicht-1.8/doc/html/classirr_1_1io_1_1_i_file_system.html | |||
@@ -0,0 +1,1381 @@ | |||
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::IFileSystem 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_file_system.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::IFileSystem Class Reference</div> </div> | ||
91 | </div> | ||
92 | <div class="contents"> | ||
93 | <!-- doxytag: class="irr::io::IFileSystem" --><!-- doxytag: inherits="irr::IReferenceCounted" --> | ||
94 | <p>The FileSystem manages files and archives and provides access to them. | ||
95 | <a href="classirr_1_1io_1_1_i_file_system.html#details">More...</a></p> | ||
96 | |||
97 | <p><code>#include <<a class="el" href="_i_file_system_8h_source.html">IFileSystem.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::IFileSystem:</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_file_system.png" usemap="#irr::io::IFileSystem_map" alt=""/> | ||
105 | <map id="irr::io::IFileSystem_map" name="irr::io::IFileSystem_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_file_system-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 void <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ad56456302b4697c49b461a909d9269b9">addArchiveLoader</a> (<a class="el" href="classirr_1_1io_1_1_i_archive_loader.html">IArchiveLoader</a> *loader)=0 | ||
115 | <dl class="el"><dd class="mdescRight">Adds an external archive loader to the engine. <a href="#ad56456302b4697c49b461a909d9269b9"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#afe6641c7f88a8fea0205c113b8379730">addFileArchive</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename, bool ignoreCase=true, bool ignorePaths=true, <a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> archiveType=EFAT_UNKNOWN, const <a class="el" href="namespaceirr_1_1core.html#ade1071a878633f2f6d8a75c5d11fec19">core::stringc</a> &password="", <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> **retArchive=0)=0 | ||
116 | <dl class="el"><dd class="mdescRight">Adds an archive to the file system. <a href="#afe6641c7f88a8fea0205c113b8379730"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#abe4d01069e7fbf0fa871197a68ad87b9">addFileArchive</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> *file, bool ignoreCase=true, bool ignorePaths=true, <a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> archiveType=EFAT_UNKNOWN, const <a class="el" href="namespaceirr_1_1core.html#ade1071a878633f2f6d8a75c5d11fec19">core::stringc</a> &password="", <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> **retArchive=0)=0 | ||
117 | <dl class="el"><dd class="mdescRight">Adds an archive to the file system. <a href="#abe4d01069e7fbf0fa871197a68ad87b9"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#aedecc2c6f4c567de8bbe54fd711f7143">addFileArchive</a> (<a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> *archive)=0 | ||
118 | <dl class="el"><dd class="mdescRight">Adds an archive to the file system. <a href="#aedecc2c6f4c567de8bbe54fd711f7143"></a><br/></dl><li>virtual _IRR_DEPRECATED_ bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a7b5235a1473ff67d97f1487211762723">addFolderFileArchive</a> (const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *filename, bool ignoreCase=true, bool ignorePaths=true) | ||
119 | <dl class="el"><dd class="mdescRight">Adds an unzipped archive (or basedirectory with subdirectories..) to the file system. <a href="#a7b5235a1473ff67d97f1487211762723"></a><br/></dl><li>virtual _IRR_DEPRECATED_ bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a5ade21d59a80b16965d57d1977ad6cc4">addPakFileArchive</a> (const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *filename, bool ignoreCase=true, bool ignorePaths=true) | ||
120 | <dl class="el"><dd class="mdescRight">Adds a pak archive to the file system. <a href="#a5ade21d59a80b16965d57d1977ad6cc4"></a><br/></dl><li>virtual _IRR_DEPRECATED_ bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#aef11ff9b5c171d7b3a99d8a79b71f2b3">addZipFileArchive</a> (const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *filename, bool ignoreCase=true, bool ignorePaths=true) | ||
121 | <dl class="el"><dd class="mdescRight">Adds a zip archive to the file system. <a href="#aef11ff9b5c171d7b3a99d8a79b71f2b3"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a8859a2bed44815eeccc4fbcef189b073">changeWorkingDirectoryTo</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &newDirectory)=0 | ||
122 | <dl class="el"><dd class="mdescRight">Changes the current working directory. <a href="#a8859a2bed44815eeccc4fbcef189b073"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a3678bb77e12cc6ee2b3947f4c79f6c90">createAndOpenFile</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename)=0 | ||
123 | <dl class="el"><dd class="mdescRight">Opens a file for read access. <a href="#a3678bb77e12cc6ee2b3947f4c79f6c90"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#af0ed28b697936ee8aa60a5a0877ac90a">createAndWriteFile</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename, bool append=false)=0 | ||
124 | <dl class="el"><dd class="mdescRight">Opens a file for write access. <a href="#af0ed28b697936ee8aa60a5a0877ac90a"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_attributes.html">IAttributes</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a50f91cd88b926751367dac153c1cefd2">createEmptyAttributes</a> (<a class="el" href="classirr_1_1video_1_1_i_video_driver.html">video::IVideoDriver</a> *driver=0)=0 | ||
125 | <dl class="el"><dd class="mdescRight">Creates a new empty collection of attributes, usable for serialization and more. <a href="#a50f91cd88b926751367dac153c1cefd2"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a4f8a69f557f2b7022f6cd7346c3e85d2">createEmptyFileList</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &<a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a>, bool ignoreCase, bool ignorePaths)=0 | ||
126 | <dl class="el"><dd class="mdescRight">Creates an empty filelist. <a href="#a4f8a69f557f2b7022f6cd7346c3e85d2"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ad5820e7664377c12015ea7a6c801f7f8">createFileList</a> ()=0 | ||
127 | <dl class="el"><dd class="mdescRight">Creates a list of files and directories in the current working directory and returns it. <a href="#ad5820e7664377c12015ea7a6c801f7f8"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a8b110f1ed6f52098753b7a558c020dbc">createLimitReadFile</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &fileName, <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> *alreadyOpenedFile, long pos, long areaSize)=0 | ||
128 | <dl class="el"><dd class="mdescRight">Creates an <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> interface for accessing files inside files. <a href="#a8b110f1ed6f52098753b7a558c020dbc"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ac60a4b7912a7f2364426dc1aaf9bccae">createMemoryReadFile</a> (void *memory, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> len, const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &fileName, bool deleteMemoryWhenDropped=false)=0 | ||
129 | <dl class="el"><dd class="mdescRight">Creates an <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> interface for accessing memory like a file. <a href="#ac60a4b7912a7f2364426dc1aaf9bccae"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a568dd1e737fe3d3222b2e4ca2b6ebad3">createMemoryWriteFile</a> (void *memory, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> len, const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &fileName, bool deleteMemoryWhenDropped=false)=0 | ||
130 | <dl class="el"><dd class="mdescRight">Creates an <a class="el" href="classirr_1_1io_1_1_i_write_file.html" title="Interface providing write access to a file.">IWriteFile</a> interface for accessing memory like a file. <a href="#a568dd1e737fe3d3222b2e4ca2b6ebad3"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#a9dc6291fb7e4c73155a3e3c8339f9bff">IXMLReader</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a167c9fa159d16ee5c56c074636b0865e">createXMLReader</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename)=0 | ||
131 | <dl class="el"><dd class="mdescRight">Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*). <a href="#a167c9fa159d16ee5c56c074636b0865e"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#a9dc6291fb7e4c73155a3e3c8339f9bff">IXMLReader</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a38f4c90db3fd1b21473ce0cd2437bb59">createXMLReader</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> *file)=0 | ||
132 | <dl class="el"><dd class="mdescRight">Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*). <a href="#a38f4c90db3fd1b21473ce0cd2437bb59"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#a2dedc8156931082e6b147b562195e310">IXMLReaderUTF8</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#affd8f622ac7c3dcd507f20f9cd23b21f">createXMLReaderUTF8</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename)=0 | ||
133 | <dl class="el"><dd class="mdescRight">Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*). <a href="#affd8f622ac7c3dcd507f20f9cd23b21f"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#a2dedc8156931082e6b147b562195e310">IXMLReaderUTF8</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#acda42a761d3b2fb4d39ad1d9e2ada973">createXMLReaderUTF8</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> *file)=0 | ||
134 | <dl class="el"><dd class="mdescRight">Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*). <a href="#acda42a761d3b2fb4d39ad1d9e2ada973"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html">IXMLWriter</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a0737712d1c90001e5765ef46912c616d">createXMLWriter</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename)=0 | ||
135 | <dl class="el"><dd class="mdescRight">Creates a XML Writer from a file. <a href="#a0737712d1c90001e5765ef46912c616d"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html">IXMLWriter</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ac2bcaf8c338e80ff579061b7056c06da">createXMLWriter</a> (<a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a> *file)=0 | ||
136 | <dl class="el"><dd class="mdescRight">Creates a XML Writer from a file. <a href="#ac2bcaf8c338e80ff579061b7056c06da"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a1c5e98bc16e38b1d15b44e24b1b3bd32">existFile</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename) const =0 | ||
137 | <dl class="el"><dd class="mdescRight">Determines if a file exists and could be opened. <a href="#a1c5e98bc16e38b1d15b44e24b1b3bd32"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & <a class="el" href="classirr_1_1io_1_1_i_file_system.html#aa76bbc9cc5ec7a8dbe96713f1ba20de6">flattenFilename</a> (<a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &directory, const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &root="/") const =0 | ||
138 | <dl class="el"><dd class="mdescRight">flatten a path and file name for example: "/you/me/../." becomes "/you" <a href="#aa76bbc9cc5ec7a8dbe96713f1ba20de6"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a77191d7917349a0200f5de3ef29acd18">getAbsolutePath</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename) const =0 | ||
139 | <dl class="el"><dd class="mdescRight">Converts a relative path to an absolute (unique) path, resolving symbolic links if required. <a href="#a77191d7917349a0200f5de3ef29acd18"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html">IArchiveLoader</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a175208d74556d1a0e4fe7400bbc65d7b">getArchiveLoader</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0 | ||
140 | <dl class="el"><dd class="mdescRight">Retrieve the given archive loader. <a href="#a175208d74556d1a0e4fe7400bbc65d7b"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ae1e958f65eb8b61b40f3c71a593f852d">getArchiveLoaderCount</a> () const =0 | ||
141 | <dl class="el"><dd class="mdescRight">Gets the number of archive loaders currently added. <a href="#ae1e958f65eb8b61b40f3c71a593f852d"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> * <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a1ac4bfb7bfd7d2961af8e5c128190fae">getFileArchive</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index)=0 | ||
142 | <dl class="el"><dd class="mdescRight">Get the archive at a given index. <a href="#a1ac4bfb7bfd7d2961af8e5c128190fae"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a85862865f72b1e187402365e4236dce0">getFileArchiveCount</a> () const =0 | ||
143 | <dl class="el"><dd class="mdescRight">Get the number of archives currently attached to the file system. <a href="#a85862865f72b1e187402365e4236dce0"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a4235989e4ec21c78f1fd1ca861980c6c">getFileBasename</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename, bool keepExtension=true) const =0 | ||
144 | <dl class="el"><dd class="mdescRight">Get the base part of a filename, i.e. the name without the directory part. <a href="#a4235989e4ec21c78f1fd1ca861980c6c"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ad8b7b93f32f58c1ba9a8e7cacd5de80b">getFileDir</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename) const =0 | ||
145 | <dl class="el"><dd class="mdescRight">Get the directory a file is located in. <a href="#ad8b7b93f32f58c1ba9a8e7cacd5de80b"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a9cb85c468a6cda253ff99c88010028c7">getRelativeFilename</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename, const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &directory) const =0 | ||
146 | <dl class="el"><dd class="mdescRight">Get the relative filename, relative to the given directory. <a href="#a9cb85c468a6cda253ff99c88010028c7"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & <a class="el" href="classirr_1_1io_1_1_i_file_system.html#acbf7342afa6e2fc9583db3e521e66e61">getWorkingDirectory</a> ()=0 | ||
147 | <dl class="el"><dd class="mdescRight">Get the current working directory. <a href="#acbf7342afa6e2fc9583db3e521e66e61"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ae8530fb9793373cf4dbee956090e99f6">moveFileArchive</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> sourceIndex, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> relative)=0 | ||
148 | <dl class="el"><dd class="mdescRight">Changes the search order of attached archives. <a href="#ae8530fb9793373cf4dbee956090e99f6"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#aa509623756c9bcbc3a9bcf455ea2a3ba">removeFileArchive</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index)=0 | ||
149 | <dl class="el"><dd class="mdescRight">Removes an archive from the file system. <a href="#aa509623756c9bcbc3a9bcf455ea2a3ba"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a03b405c8f5346c225c590cde585eb73c">removeFileArchive</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &filename)=0 | ||
150 | <dl class="el"><dd class="mdescRight">Removes an archive from the file system. <a href="#a03b405c8f5346c225c590cde585eb73c"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ab7579f5ccca7bc7c1e079f5cb38173ed">removeFileArchive</a> (const <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> *archive)=0 | ||
151 | <dl class="el"><dd class="mdescRight">Removes an archive from the file system. <a href="#ab7579f5ccca7bc7c1e079f5cb38173ed"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#a22364f1caf06442a70f6198025af3fe9">EFileSystemType</a> <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a767614d727f0b1ec0bc5fdaaf906169b">setFileListSystem</a> (<a class="el" href="namespaceirr_1_1io.html#a22364f1caf06442a70f6198025af3fe9">EFileSystemType</a> listType)=0 | ||
152 | <dl class="el"><dd class="mdescRight">Set the active type of file system. <a href="#a767614d727f0b1ec0bc5fdaaf906169b"></a><br/></dl></ul> | ||
153 | <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> | ||
154 | <div class="textblock"><p>The FileSystem manages files and archives and provides access to them. </p> | ||
155 | <p>It manages where files are, so that modules which use the the IO do not need to know where every file is located. A file could be in a .zip-Archive or as file on disk, using the <a class="el" href="classirr_1_1io_1_1_i_file_system.html" title="The FileSystem manages files and archives and provides access to them.">IFileSystem</a> makes no difference to this. </p> | ||
156 | |||
157 | <p>Definition at line <a class="el" href="_i_file_system_8h_source.html#l00032">32</a> of file <a class="el" href="_i_file_system_8h_source.html">IFileSystem.h</a>.</p> | ||
158 | </div><hr/><h2>Member Function Documentation</h2> | ||
159 | <a class="anchor" id="ad56456302b4697c49b461a909d9269b9"></a><!-- doxytag: member="irr::io::IFileSystem::addArchiveLoader" ref="ad56456302b4697c49b461a909d9269b9" args="(IArchiveLoader *loader)=0" --> | ||
160 | <div class="memitem"> | ||
161 | <div class="memproto"> | ||
162 | <table class="memname"> | ||
163 | <tr> | ||
164 | <td class="memname">virtual void irr::io::IFileSystem::addArchiveLoader </td> | ||
165 | <td>(</td> | ||
166 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_archive_loader.html">IArchiveLoader</a> * </td> | ||
167 | <td class="paramname"><em>loader</em></td><td>)</td> | ||
168 | <td><code> [pure virtual]</code></td> | ||
169 | </tr> | ||
170 | </table> | ||
171 | </div> | ||
172 | <div class="memdoc"> | ||
173 | |||
174 | <p>Adds an external archive loader to the engine. </p> | ||
175 | <p>Use this function to add support for new archive types to the engine, for example proprietary or encrypted file storage. </p> | ||
176 | |||
177 | </div> | ||
178 | </div> | ||
179 | <a class="anchor" id="afe6641c7f88a8fea0205c113b8379730"></a><!-- doxytag: member="irr::io::IFileSystem::addFileArchive" ref="afe6641c7f88a8fea0205c113b8379730" args="(const path &filename, bool ignoreCase=true, bool ignorePaths=true, E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN, const core::stringc &password="", IFileArchive **retArchive=0)=0" --> | ||
180 | <div class="memitem"> | ||
181 | <div class="memproto"> | ||
182 | <table class="memname"> | ||
183 | <tr> | ||
184 | <td class="memname">virtual bool irr::io::IFileSystem::addFileArchive </td> | ||
185 | <td>(</td> | ||
186 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
187 | <td class="paramname"><em>filename</em>, </td> | ||
188 | </tr> | ||
189 | <tr> | ||
190 | <td class="paramkey"></td> | ||
191 | <td></td> | ||
192 | <td class="paramtype">bool </td> | ||
193 | <td class="paramname"><em>ignoreCase</em> = <code>true</code>, </td> | ||
194 | </tr> | ||
195 | <tr> | ||
196 | <td class="paramkey"></td> | ||
197 | <td></td> | ||
198 | <td class="paramtype">bool </td> | ||
199 | <td class="paramname"><em>ignorePaths</em> = <code>true</code>, </td> | ||
200 | </tr> | ||
201 | <tr> | ||
202 | <td class="paramkey"></td> | ||
203 | <td></td> | ||
204 | <td class="paramtype"><a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> </td> | ||
205 | <td class="paramname"><em>archiveType</em> = <code>EFAT_UNKNOWN</code>, </td> | ||
206 | </tr> | ||
207 | <tr> | ||
208 | <td class="paramkey"></td> | ||
209 | <td></td> | ||
210 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1core.html#ade1071a878633f2f6d8a75c5d11fec19">core::stringc</a> & </td> | ||
211 | <td class="paramname"><em>password</em> = <code>""</code>, </td> | ||
212 | </tr> | ||
213 | <tr> | ||
214 | <td class="paramkey"></td> | ||
215 | <td></td> | ||
216 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> ** </td> | ||
217 | <td class="paramname"><em>retArchive</em> = <code>0</code> </td> | ||
218 | </tr> | ||
219 | <tr> | ||
220 | <td></td> | ||
221 | <td>)</td> | ||
222 | <td></td><td><code> [pure virtual]</code></td> | ||
223 | </tr> | ||
224 | </table> | ||
225 | </div> | ||
226 | <div class="memdoc"> | ||
227 | |||
228 | <p>Adds an archive to the file system. </p> | ||
229 | <p>After calling this, the Irrlicht Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files. By default Irrlicht supports ZIP, PAK, TAR, PNK, and directories as archives. You can provide your own archive types by implementing <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html" title="Class which is able to create an archive from a file.">IArchiveLoader</a> and passing an instance to addArchiveLoader. Irrlicht supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2. </p> | ||
230 | <dl><dt><b>Parameters:</b></dt><dd> | ||
231 | <table class="params"> | ||
232 | <tr><td class="paramname">filename,:</td><td>Filename of the archive to add to the file system. </td></tr> | ||
233 | <tr><td class="paramname">ignoreCase,:</td><td>If set to true, files in the archive can be accessed without writing all letters in the right case. </td></tr> | ||
234 | <tr><td class="paramname">ignorePaths,:</td><td>If set to true, files in the added archive can be accessed without its complete path. </td></tr> | ||
235 | <tr><td class="paramname">archiveType,:</td><td>If no specific E_FILE_ARCHIVE_TYPE is selected then the type of archive will depend on the extension of the file name. If you use a different extension then you can use this parameter to force a specific type of archive. </td></tr> | ||
236 | <tr><td class="paramname">password</td><td>An optional password, which is used in case of encrypted archives. </td></tr> | ||
237 | <tr><td class="paramname">retArchive</td><td>A pointer that will be set to the archive that is added. </td></tr> | ||
238 | </table> | ||
239 | </dd> | ||
240 | </dl> | ||
241 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the archive was added successfully, false if not. </dd></dl> | ||
242 | |||
243 | <p>Referenced by <a class="el" href="_i_file_system_8h_source.html#l00244">addFolderFileArchive()</a>, <a class="el" href="_i_file_system_8h_source.html#l00262">addPakFileArchive()</a>, and <a class="el" href="_i_file_system_8h_source.html#l00228">addZipFileArchive()</a>.</p> | ||
244 | |||
245 | </div> | ||
246 | </div> | ||
247 | <a class="anchor" id="abe4d01069e7fbf0fa871197a68ad87b9"></a><!-- doxytag: member="irr::io::IFileSystem::addFileArchive" ref="abe4d01069e7fbf0fa871197a68ad87b9" args="(IReadFile *file, bool ignoreCase=true, bool ignorePaths=true, E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN, const core::stringc &password="", IFileArchive **retArchive=0)=0" --> | ||
248 | <div class="memitem"> | ||
249 | <div class="memproto"> | ||
250 | <table class="memname"> | ||
251 | <tr> | ||
252 | <td class="memname">virtual bool irr::io::IFileSystem::addFileArchive </td> | ||
253 | <td>(</td> | ||
254 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * </td> | ||
255 | <td class="paramname"><em>file</em>, </td> | ||
256 | </tr> | ||
257 | <tr> | ||
258 | <td class="paramkey"></td> | ||
259 | <td></td> | ||
260 | <td class="paramtype">bool </td> | ||
261 | <td class="paramname"><em>ignoreCase</em> = <code>true</code>, </td> | ||
262 | </tr> | ||
263 | <tr> | ||
264 | <td class="paramkey"></td> | ||
265 | <td></td> | ||
266 | <td class="paramtype">bool </td> | ||
267 | <td class="paramname"><em>ignorePaths</em> = <code>true</code>, </td> | ||
268 | </tr> | ||
269 | <tr> | ||
270 | <td class="paramkey"></td> | ||
271 | <td></td> | ||
272 | <td class="paramtype"><a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> </td> | ||
273 | <td class="paramname"><em>archiveType</em> = <code>EFAT_UNKNOWN</code>, </td> | ||
274 | </tr> | ||
275 | <tr> | ||
276 | <td class="paramkey"></td> | ||
277 | <td></td> | ||
278 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1core.html#ade1071a878633f2f6d8a75c5d11fec19">core::stringc</a> & </td> | ||
279 | <td class="paramname"><em>password</em> = <code>""</code>, </td> | ||
280 | </tr> | ||
281 | <tr> | ||
282 | <td class="paramkey"></td> | ||
283 | <td></td> | ||
284 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> ** </td> | ||
285 | <td class="paramname"><em>retArchive</em> = <code>0</code> </td> | ||
286 | </tr> | ||
287 | <tr> | ||
288 | <td></td> | ||
289 | <td>)</td> | ||
290 | <td></td><td><code> [pure virtual]</code></td> | ||
291 | </tr> | ||
292 | </table> | ||
293 | </div> | ||
294 | <div class="memdoc"> | ||
295 | |||
296 | <p>Adds an archive to the file system. </p> | ||
297 | <p>After calling this, the Irrlicht Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files. By default Irrlicht supports ZIP, PAK, TAR, PNK, and directories as archives. You can provide your own archive types by implementing <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html" title="Class which is able to create an archive from a file.">IArchiveLoader</a> and passing an instance to addArchiveLoader. Irrlicht supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2. If you want to add a directory as an archive, prefix its name with a slash in order to let Irrlicht recognize it as a folder mount (mypath/). Using this technique one can build up a search order, because archives are read first, and can be used more easily with relative filenames. </p> | ||
298 | <dl><dt><b>Parameters:</b></dt><dd> | ||
299 | <table class="params"> | ||
300 | <tr><td class="paramname">file,:</td><td>Archive to add to the file system. </td></tr> | ||
301 | <tr><td class="paramname">ignoreCase,:</td><td>If set to true, files in the archive can be accessed without writing all letters in the right case. </td></tr> | ||
302 | <tr><td class="paramname">ignorePaths,:</td><td>If set to true, files in the added archive can be accessed without its complete path. </td></tr> | ||
303 | <tr><td class="paramname">archiveType,:</td><td>If no specific E_FILE_ARCHIVE_TYPE is selected then the type of archive will depend on the extension of the file name. If you use a different extension then you can use this parameter to force a specific type of archive. </td></tr> | ||
304 | <tr><td class="paramname">password</td><td>An optional password, which is used in case of encrypted archives. </td></tr> | ||
305 | <tr><td class="paramname">retArchive</td><td>A pointer that will be set to the archive that is added. </td></tr> | ||
306 | </table> | ||
307 | </dd> | ||
308 | </dl> | ||
309 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the archive was added successfully, false if not. </dd></dl> | ||
310 | |||
311 | </div> | ||
312 | </div> | ||
313 | <a class="anchor" id="aedecc2c6f4c567de8bbe54fd711f7143"></a><!-- doxytag: member="irr::io::IFileSystem::addFileArchive" ref="aedecc2c6f4c567de8bbe54fd711f7143" args="(IFileArchive *archive)=0" --> | ||
314 | <div class="memitem"> | ||
315 | <div class="memproto"> | ||
316 | <table class="memname"> | ||
317 | <tr> | ||
318 | <td class="memname">virtual bool irr::io::IFileSystem::addFileArchive </td> | ||
319 | <td>(</td> | ||
320 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> * </td> | ||
321 | <td class="paramname"><em>archive</em></td><td>)</td> | ||
322 | <td><code> [pure virtual]</code></td> | ||
323 | </tr> | ||
324 | </table> | ||
325 | </div> | ||
326 | <div class="memdoc"> | ||
327 | |||
328 | <p>Adds an archive to the file system. </p> | ||
329 | <dl><dt><b>Parameters:</b></dt><dd> | ||
330 | <table class="params"> | ||
331 | <tr><td class="paramname">archive,:</td><td>The archive to add to the file system. </td></tr> | ||
332 | </table> | ||
333 | </dd> | ||
334 | </dl> | ||
335 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the archive was added successfully, false if not. </dd></dl> | ||
336 | |||
337 | </div> | ||
338 | </div> | ||
339 | <a class="anchor" id="a7b5235a1473ff67d97f1487211762723"></a><!-- doxytag: member="irr::io::IFileSystem::addFolderFileArchive" ref="a7b5235a1473ff67d97f1487211762723" args="(const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)" --> | ||
340 | <div class="memitem"> | ||
341 | <div class="memproto"> | ||
342 | <table class="memname"> | ||
343 | <tr> | ||
344 | <td class="memname">virtual _IRR_DEPRECATED_ bool irr::io::IFileSystem::addFolderFileArchive </td> | ||
345 | <td>(</td> | ||
346 | <td class="paramtype">const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * </td> | ||
347 | <td class="paramname"><em>filename</em>, </td> | ||
348 | </tr> | ||
349 | <tr> | ||
350 | <td class="paramkey"></td> | ||
351 | <td></td> | ||
352 | <td class="paramtype">bool </td> | ||
353 | <td class="paramname"><em>ignoreCase</em> = <code>true</code>, </td> | ||
354 | </tr> | ||
355 | <tr> | ||
356 | <td class="paramkey"></td> | ||
357 | <td></td> | ||
358 | <td class="paramtype">bool </td> | ||
359 | <td class="paramname"><em>ignorePaths</em> = <code>true</code> </td> | ||
360 | </tr> | ||
361 | <tr> | ||
362 | <td></td> | ||
363 | <td>)</td> | ||
364 | <td></td><td><code> [inline, virtual]</code></td> | ||
365 | </tr> | ||
366 | </table> | ||
367 | </div> | ||
368 | <div class="memdoc"> | ||
369 | |||
370 | <p>Adds an unzipped archive (or basedirectory with subdirectories..) to the file system. </p> | ||
371 | <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>This function is provided for compatibility with older versions of Irrlicht and may be removed in Irrlicht 1.9, you should use addFileArchive instead. Useful for handling data which will be in a zip file </dd></dl> | ||
372 | <dl><dt><b>Parameters:</b></dt><dd> | ||
373 | <table class="params"> | ||
374 | <tr><td class="paramname">filename,:</td><td>Filename of the unzipped zip archive base directory to add to the file system. </td></tr> | ||
375 | <tr><td class="paramname">ignoreCase,:</td><td>If set to true, files in the archive can be accessed without writing all letters in the right case. </td></tr> | ||
376 | <tr><td class="paramname">ignorePaths,:</td><td>If set to true, files in the added archive can be accessed without its complete path. </td></tr> | ||
377 | </table> | ||
378 | </dd> | ||
379 | </dl> | ||
380 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the archive was added successful, false if not. </dd></dl> | ||
381 | |||
382 | <p>Definition at line <a class="el" href="_i_file_system_8h_source.html#l00244">244</a> of file <a class="el" href="_i_file_system_8h_source.html">IFileSystem.h</a>.</p> | ||
383 | |||
384 | <p>References <a class="el" href="classirr_1_1io_1_1_i_file_system.html#afe6641c7f88a8fea0205c113b8379730">addFileArchive()</a>, and <a class="el" href="_i_file_archive_8h_source.html#l00034">irr::io::EFAT_FOLDER</a>.</p> | ||
385 | |||
386 | </div> | ||
387 | </div> | ||
388 | <a class="anchor" id="a5ade21d59a80b16965d57d1977ad6cc4"></a><!-- doxytag: member="irr::io::IFileSystem::addPakFileArchive" ref="a5ade21d59a80b16965d57d1977ad6cc4" args="(const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)" --> | ||
389 | <div class="memitem"> | ||
390 | <div class="memproto"> | ||
391 | <table class="memname"> | ||
392 | <tr> | ||
393 | <td class="memname">virtual _IRR_DEPRECATED_ bool irr::io::IFileSystem::addPakFileArchive </td> | ||
394 | <td>(</td> | ||
395 | <td class="paramtype">const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * </td> | ||
396 | <td class="paramname"><em>filename</em>, </td> | ||
397 | </tr> | ||
398 | <tr> | ||
399 | <td class="paramkey"></td> | ||
400 | <td></td> | ||
401 | <td class="paramtype">bool </td> | ||
402 | <td class="paramname"><em>ignoreCase</em> = <code>true</code>, </td> | ||
403 | </tr> | ||
404 | <tr> | ||
405 | <td class="paramkey"></td> | ||
406 | <td></td> | ||
407 | <td class="paramtype">bool </td> | ||
408 | <td class="paramname"><em>ignorePaths</em> = <code>true</code> </td> | ||
409 | </tr> | ||
410 | <tr> | ||
411 | <td></td> | ||
412 | <td>)</td> | ||
413 | <td></td><td><code> [inline, virtual]</code></td> | ||
414 | </tr> | ||
415 | </table> | ||
416 | </div> | ||
417 | <div class="memdoc"> | ||
418 | |||
419 | <p>Adds a pak archive to the file system. </p> | ||
420 | <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>This function is provided for compatibility with older versions of Irrlicht and may be removed in Irrlicht 1.9, you should use addFileArchive instead. After calling this, the Irrlicht Engine will search and open files directly from this archive too. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake2/KingPin/Hexen2 .pak files </dd></dl> | ||
421 | <dl><dt><b>Parameters:</b></dt><dd> | ||
422 | <table class="params"> | ||
423 | <tr><td class="paramname">filename,:</td><td>Filename of the pak archive to add to the file system. </td></tr> | ||
424 | <tr><td class="paramname">ignoreCase,:</td><td>If set to true, files in the archive can be accessed without writing all letters in the right case. </td></tr> | ||
425 | <tr><td class="paramname">ignorePaths,:</td><td>If set to true, files in the added archive can be accessed without its complete path.(should not use with Quake2 paks </td></tr> | ||
426 | </table> | ||
427 | </dd> | ||
428 | </dl> | ||
429 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the archive was added successful, false if not. </dd></dl> | ||
430 | |||
431 | <p>Definition at line <a class="el" href="_i_file_system_8h_source.html#l00262">262</a> of file <a class="el" href="_i_file_system_8h_source.html">IFileSystem.h</a>.</p> | ||
432 | |||
433 | <p>References <a class="el" href="classirr_1_1io_1_1_i_file_system.html#afe6641c7f88a8fea0205c113b8379730">addFileArchive()</a>, and <a class="el" href="_i_file_archive_8h_source.html#l00037">irr::io::EFAT_PAK</a>.</p> | ||
434 | |||
435 | </div> | ||
436 | </div> | ||
437 | <a class="anchor" id="aef11ff9b5c171d7b3a99d8a79b71f2b3"></a><!-- doxytag: member="irr::io::IFileSystem::addZipFileArchive" ref="aef11ff9b5c171d7b3a99d8a79b71f2b3" args="(const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)" --> | ||
438 | <div class="memitem"> | ||
439 | <div class="memproto"> | ||
440 | <table class="memname"> | ||
441 | <tr> | ||
442 | <td class="memname">virtual _IRR_DEPRECATED_ bool irr::io::IFileSystem::addZipFileArchive </td> | ||
443 | <td>(</td> | ||
444 | <td class="paramtype">const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * </td> | ||
445 | <td class="paramname"><em>filename</em>, </td> | ||
446 | </tr> | ||
447 | <tr> | ||
448 | <td class="paramkey"></td> | ||
449 | <td></td> | ||
450 | <td class="paramtype">bool </td> | ||
451 | <td class="paramname"><em>ignoreCase</em> = <code>true</code>, </td> | ||
452 | </tr> | ||
453 | <tr> | ||
454 | <td class="paramkey"></td> | ||
455 | <td></td> | ||
456 | <td class="paramtype">bool </td> | ||
457 | <td class="paramname"><em>ignorePaths</em> = <code>true</code> </td> | ||
458 | </tr> | ||
459 | <tr> | ||
460 | <td></td> | ||
461 | <td>)</td> | ||
462 | <td></td><td><code> [inline, virtual]</code></td> | ||
463 | </tr> | ||
464 | </table> | ||
465 | </div> | ||
466 | <div class="memdoc"> | ||
467 | |||
468 | <p>Adds a zip archive to the file system. </p> | ||
469 | <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>This function is provided for compatibility with older versions of Irrlicht and may be removed in Irrlicht 1.9, you should use addFileArchive instead. After calling this, the Irrlicht Engine will search and open files directly from this archive too. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are no different than .zip files. </dd></dl> | ||
470 | <dl><dt><b>Parameters:</b></dt><dd> | ||
471 | <table class="params"> | ||
472 | <tr><td class="paramname">filename,:</td><td>Filename of the zip archive to add to the file system. </td></tr> | ||
473 | <tr><td class="paramname">ignoreCase,:</td><td>If set to true, files in the archive can be accessed without writing all letters in the right case. </td></tr> | ||
474 | <tr><td class="paramname">ignorePaths,:</td><td>If set to true, files in the added archive can be accessed without its complete path. </td></tr> | ||
475 | </table> | ||
476 | </dd> | ||
477 | </dl> | ||
478 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if the archive was added successfully, false if not. </dd></dl> | ||
479 | |||
480 | <p>Definition at line <a class="el" href="_i_file_system_8h_source.html#l00228">228</a> of file <a class="el" href="_i_file_system_8h_source.html">IFileSystem.h</a>.</p> | ||
481 | |||
482 | <p>References <a class="el" href="classirr_1_1io_1_1_i_file_system.html#afe6641c7f88a8fea0205c113b8379730">addFileArchive()</a>, and <a class="el" href="_i_file_archive_8h_source.html#l00028">irr::io::EFAT_ZIP</a>.</p> | ||
483 | |||
484 | </div> | ||
485 | </div> | ||
486 | <a class="anchor" id="a8859a2bed44815eeccc4fbcef189b073"></a><!-- doxytag: member="irr::io::IFileSystem::changeWorkingDirectoryTo" ref="a8859a2bed44815eeccc4fbcef189b073" args="(const path &newDirectory)=0" --> | ||
487 | <div class="memitem"> | ||
488 | <div class="memproto"> | ||
489 | <table class="memname"> | ||
490 | <tr> | ||
491 | <td class="memname">virtual bool irr::io::IFileSystem::changeWorkingDirectoryTo </td> | ||
492 | <td>(</td> | ||
493 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
494 | <td class="paramname"><em>newDirectory</em></td><td>)</td> | ||
495 | <td><code> [pure virtual]</code></td> | ||
496 | </tr> | ||
497 | </table> | ||
498 | </div> | ||
499 | <div class="memdoc"> | ||
500 | |||
501 | <p>Changes the current working directory. </p> | ||
502 | <dl><dt><b>Parameters:</b></dt><dd> | ||
503 | <table class="params"> | ||
504 | <tr><td class="paramname">newDirectory,:</td><td>A string specifying the new working directory. The string is operating system dependent. Under Windows it has the form "<drive>:\<directory>\<sudirectory>\<..>". An example would be: "C:\Windows\" </td></tr> | ||
505 | </table> | ||
506 | </dd> | ||
507 | </dl> | ||
508 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if successful, otherwise false. </dd></dl> | ||
509 | |||
510 | </div> | ||
511 | </div> | ||
512 | <a class="anchor" id="a3678bb77e12cc6ee2b3947f4c79f6c90"></a><!-- doxytag: member="irr::io::IFileSystem::createAndOpenFile" ref="a3678bb77e12cc6ee2b3947f4c79f6c90" args="(const path &filename)=0" --> | ||
513 | <div class="memitem"> | ||
514 | <div class="memproto"> | ||
515 | <table class="memname"> | ||
516 | <tr> | ||
517 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileSystem::createAndOpenFile </td> | ||
518 | <td>(</td> | ||
519 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
520 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
521 | <td><code> [pure virtual]</code></td> | ||
522 | </tr> | ||
523 | </table> | ||
524 | </div> | ||
525 | <div class="memdoc"> | ||
526 | |||
527 | <p>Opens a file for read access. </p> | ||
528 | <dl><dt><b>Parameters:</b></dt><dd> | ||
529 | <table class="params"> | ||
530 | <tr><td class="paramname">filename,:</td><td>Name of file to open. </td></tr> | ||
531 | </table> | ||
532 | </dd> | ||
533 | </dl> | ||
534 | <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
535 | |||
536 | </div> | ||
537 | </div> | ||
538 | <a class="anchor" id="af0ed28b697936ee8aa60a5a0877ac90a"></a><!-- doxytag: member="irr::io::IFileSystem::createAndWriteFile" ref="af0ed28b697936ee8aa60a5a0877ac90a" args="(const path &filename, bool append=false)=0" --> | ||
539 | <div class="memitem"> | ||
540 | <div class="memproto"> | ||
541 | <table class="memname"> | ||
542 | <tr> | ||
543 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a>* irr::io::IFileSystem::createAndWriteFile </td> | ||
544 | <td>(</td> | ||
545 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
546 | <td class="paramname"><em>filename</em>, </td> | ||
547 | </tr> | ||
548 | <tr> | ||
549 | <td class="paramkey"></td> | ||
550 | <td></td> | ||
551 | <td class="paramtype">bool </td> | ||
552 | <td class="paramname"><em>append</em> = <code>false</code> </td> | ||
553 | </tr> | ||
554 | <tr> | ||
555 | <td></td> | ||
556 | <td>)</td> | ||
557 | <td></td><td><code> [pure virtual]</code></td> | ||
558 | </tr> | ||
559 | </table> | ||
560 | </div> | ||
561 | <div class="memdoc"> | ||
562 | |||
563 | <p>Opens a file for write access. </p> | ||
564 | <dl><dt><b>Parameters:</b></dt><dd> | ||
565 | <table class="params"> | ||
566 | <tr><td class="paramname">filename,:</td><td>Name of file to open. </td></tr> | ||
567 | <tr><td class="paramname">append,:</td><td>If the file already exist, all write operations are appended to the file. </td></tr> | ||
568 | </table> | ||
569 | </dd> | ||
570 | </dl> | ||
571 | <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the created file interface. 0 is returned, if the file could not created or opened for writing. The returned pointer should be dropped when no longer needed. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
572 | |||
573 | </div> | ||
574 | </div> | ||
575 | <a class="anchor" id="a50f91cd88b926751367dac153c1cefd2"></a><!-- doxytag: member="irr::io::IFileSystem::createEmptyAttributes" ref="a50f91cd88b926751367dac153c1cefd2" args="(video::IVideoDriver *driver=0)=0" --> | ||
576 | <div class="memitem"> | ||
577 | <div class="memproto"> | ||
578 | <table class="memname"> | ||
579 | <tr> | ||
580 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_attributes.html">IAttributes</a>* irr::io::IFileSystem::createEmptyAttributes </td> | ||
581 | <td>(</td> | ||
582 | <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_video_driver.html">video::IVideoDriver</a> * </td> | ||
583 | <td class="paramname"><em>driver</em> = <code>0</code></td><td>)</td> | ||
584 | <td><code> [pure virtual]</code></td> | ||
585 | </tr> | ||
586 | </table> | ||
587 | </div> | ||
588 | <div class="memdoc"> | ||
589 | |||
590 | <p>Creates a new empty collection of attributes, usable for serialization and more. </p> | ||
591 | <dl><dt><b>Parameters:</b></dt><dd> | ||
592 | <table class="params"> | ||
593 | <tr><td class="paramname">driver,:</td><td>Video driver to be used to load textures when specified as attribute values. Can be null to prevent automatic texture loading by attributes. </td></tr> | ||
594 | </table> | ||
595 | </dd> | ||
596 | </dl> | ||
597 | <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the created object. If you no longer need the object, you should call <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IAttributes::drop()</a>. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
598 | |||
599 | </div> | ||
600 | </div> | ||
601 | <a class="anchor" id="a4f8a69f557f2b7022f6cd7346c3e85d2"></a><!-- doxytag: member="irr::io::IFileSystem::createEmptyFileList" ref="a4f8a69f557f2b7022f6cd7346c3e85d2" args="(const io::path &path, bool ignoreCase, bool ignorePaths)=0" --> | ||
602 | <div class="memitem"> | ||
603 | <div class="memproto"> | ||
604 | <table class="memname"> | ||
605 | <tr> | ||
606 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a>* irr::io::IFileSystem::createEmptyFileList </td> | ||
607 | <td>(</td> | ||
608 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> & </td> | ||
609 | <td class="paramname"><em>path</em>, </td> | ||
610 | </tr> | ||
611 | <tr> | ||
612 | <td class="paramkey"></td> | ||
613 | <td></td> | ||
614 | <td class="paramtype">bool </td> | ||
615 | <td class="paramname"><em>ignoreCase</em>, </td> | ||
616 | </tr> | ||
617 | <tr> | ||
618 | <td class="paramkey"></td> | ||
619 | <td></td> | ||
620 | <td class="paramtype">bool </td> | ||
621 | <td class="paramname"><em>ignorePaths</em> </td> | ||
622 | </tr> | ||
623 | <tr> | ||
624 | <td></td> | ||
625 | <td>)</td> | ||
626 | <td></td><td><code> [pure virtual]</code></td> | ||
627 | </tr> | ||
628 | </table> | ||
629 | </div> | ||
630 | <div class="memdoc"> | ||
631 | |||
632 | <p>Creates an empty filelist. </p> | ||
633 | <dl class="return"><dt><b>Returns:</b></dt><dd>a Pointer to the created <a class="el" href="classirr_1_1io_1_1_i_file_list.html" title="Provides a list of files and folders.">IFileList</a> is returned. After the list has been used it has to be deleted using its <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IFileList::drop()</a> method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
634 | |||
635 | </div> | ||
636 | </div> | ||
637 | <a class="anchor" id="ad5820e7664377c12015ea7a6c801f7f8"></a><!-- doxytag: member="irr::io::IFileSystem::createFileList" ref="ad5820e7664377c12015ea7a6c801f7f8" args="()=0" --> | ||
638 | <div class="memitem"> | ||
639 | <div class="memproto"> | ||
640 | <table class="memname"> | ||
641 | <tr> | ||
642 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a>* irr::io::IFileSystem::createFileList </td> | ||
643 | <td>(</td> | ||
644 | <td class="paramname"></td><td>)</td> | ||
645 | <td><code> [pure virtual]</code></td> | ||
646 | </tr> | ||
647 | </table> | ||
648 | </div> | ||
649 | <div class="memdoc"> | ||
650 | |||
651 | <p>Creates a list of files and directories in the current working directory and returns it. </p> | ||
652 | <dl class="return"><dt><b>Returns:</b></dt><dd>a Pointer to the created <a class="el" href="classirr_1_1io_1_1_i_file_list.html" title="Provides a list of files and folders.">IFileList</a> is returned. After the list has been used it has to be deleted using its <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IFileList::drop()</a> method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
653 | |||
654 | </div> | ||
655 | </div> | ||
656 | <a class="anchor" id="a8b110f1ed6f52098753b7a558c020dbc"></a><!-- doxytag: member="irr::io::IFileSystem::createLimitReadFile" ref="a8b110f1ed6f52098753b7a558c020dbc" args="(const path &fileName, IReadFile *alreadyOpenedFile, long pos, long areaSize)=0" --> | ||
657 | <div class="memitem"> | ||
658 | <div class="memproto"> | ||
659 | <table class="memname"> | ||
660 | <tr> | ||
661 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileSystem::createLimitReadFile </td> | ||
662 | <td>(</td> | ||
663 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
664 | <td class="paramname"><em>fileName</em>, </td> | ||
665 | </tr> | ||
666 | <tr> | ||
667 | <td class="paramkey"></td> | ||
668 | <td></td> | ||
669 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * </td> | ||
670 | <td class="paramname"><em>alreadyOpenedFile</em>, </td> | ||
671 | </tr> | ||
672 | <tr> | ||
673 | <td class="paramkey"></td> | ||
674 | <td></td> | ||
675 | <td class="paramtype">long </td> | ||
676 | <td class="paramname"><em>pos</em>, </td> | ||
677 | </tr> | ||
678 | <tr> | ||
679 | <td class="paramkey"></td> | ||
680 | <td></td> | ||
681 | <td class="paramtype">long </td> | ||
682 | <td class="paramname"><em>areaSize</em> </td> | ||
683 | </tr> | ||
684 | <tr> | ||
685 | <td></td> | ||
686 | <td>)</td> | ||
687 | <td></td><td><code> [pure virtual]</code></td> | ||
688 | </tr> | ||
689 | </table> | ||
690 | </div> | ||
691 | <div class="memdoc"> | ||
692 | |||
693 | <p>Creates an <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> interface for accessing files inside files. </p> | ||
694 | <p>This is useful e.g. for archives. </p> | ||
695 | <dl><dt><b>Parameters:</b></dt><dd> | ||
696 | <table class="params"> | ||
697 | <tr><td class="paramname">fileName,:</td><td>The name given to this file </td></tr> | ||
698 | <tr><td class="paramname">alreadyOpenedFile,:</td><td>Pointer to the enclosing file </td></tr> | ||
699 | <tr><td class="paramname">pos,:</td><td>Start of the file inside alreadyOpenedFile </td></tr> | ||
700 | <tr><td class="paramname">areaSize,:</td><td>The length of the file </td></tr> | ||
701 | </table> | ||
702 | </dd> | ||
703 | </dl> | ||
704 | <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the created file interface. The returned pointer should be dropped when no longer needed. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
705 | |||
706 | </div> | ||
707 | </div> | ||
708 | <a class="anchor" id="ac60a4b7912a7f2364426dc1aaf9bccae"></a><!-- doxytag: member="irr::io::IFileSystem::createMemoryReadFile" ref="ac60a4b7912a7f2364426dc1aaf9bccae" args="(void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped=false)=0" --> | ||
709 | <div class="memitem"> | ||
710 | <div class="memproto"> | ||
711 | <table class="memname"> | ||
712 | <tr> | ||
713 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileSystem::createMemoryReadFile </td> | ||
714 | <td>(</td> | ||
715 | <td class="paramtype">void * </td> | ||
716 | <td class="paramname"><em>memory</em>, </td> | ||
717 | </tr> | ||
718 | <tr> | ||
719 | <td class="paramkey"></td> | ||
720 | <td></td> | ||
721 | <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> | ||
722 | <td class="paramname"><em>len</em>, </td> | ||
723 | </tr> | ||
724 | <tr> | ||
725 | <td class="paramkey"></td> | ||
726 | <td></td> | ||
727 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
728 | <td class="paramname"><em>fileName</em>, </td> | ||
729 | </tr> | ||
730 | <tr> | ||
731 | <td class="paramkey"></td> | ||
732 | <td></td> | ||
733 | <td class="paramtype">bool </td> | ||
734 | <td class="paramname"><em>deleteMemoryWhenDropped</em> = <code>false</code> </td> | ||
735 | </tr> | ||
736 | <tr> | ||
737 | <td></td> | ||
738 | <td>)</td> | ||
739 | <td></td><td><code> [pure virtual]</code></td> | ||
740 | </tr> | ||
741 | </table> | ||
742 | </div> | ||
743 | <div class="memdoc"> | ||
744 | |||
745 | <p>Creates an <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> interface for accessing memory like a file. </p> | ||
746 | <p>This allows you to use a pointer to memory where an <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> is requested. </p> | ||
747 | <dl><dt><b>Parameters:</b></dt><dd> | ||
748 | <table class="params"> | ||
749 | <tr><td class="paramname">memory,:</td><td>A pointer to the start of the file in memory </td></tr> | ||
750 | <tr><td class="paramname">len,:</td><td>The length of the memory in bytes </td></tr> | ||
751 | <tr><td class="paramname">fileName,:</td><td>The name given to this file </td></tr> | ||
752 | <tr><td class="paramname">deleteMemoryWhenDropped,:</td><td>True if the memory should be deleted along with the <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> when it is dropped. </td></tr> | ||
753 | </table> | ||
754 | </dd> | ||
755 | </dl> | ||
756 | <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
757 | |||
758 | </div> | ||
759 | </div> | ||
760 | <a class="anchor" id="a568dd1e737fe3d3222b2e4ca2b6ebad3"></a><!-- doxytag: member="irr::io::IFileSystem::createMemoryWriteFile" ref="a568dd1e737fe3d3222b2e4ca2b6ebad3" args="(void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped=false)=0" --> | ||
761 | <div class="memitem"> | ||
762 | <div class="memproto"> | ||
763 | <table class="memname"> | ||
764 | <tr> | ||
765 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a>* irr::io::IFileSystem::createMemoryWriteFile </td> | ||
766 | <td>(</td> | ||
767 | <td class="paramtype">void * </td> | ||
768 | <td class="paramname"><em>memory</em>, </td> | ||
769 | </tr> | ||
770 | <tr> | ||
771 | <td class="paramkey"></td> | ||
772 | <td></td> | ||
773 | <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> | ||
774 | <td class="paramname"><em>len</em>, </td> | ||
775 | </tr> | ||
776 | <tr> | ||
777 | <td class="paramkey"></td> | ||
778 | <td></td> | ||
779 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
780 | <td class="paramname"><em>fileName</em>, </td> | ||
781 | </tr> | ||
782 | <tr> | ||
783 | <td class="paramkey"></td> | ||
784 | <td></td> | ||
785 | <td class="paramtype">bool </td> | ||
786 | <td class="paramname"><em>deleteMemoryWhenDropped</em> = <code>false</code> </td> | ||
787 | </tr> | ||
788 | <tr> | ||
789 | <td></td> | ||
790 | <td>)</td> | ||
791 | <td></td><td><code> [pure virtual]</code></td> | ||
792 | </tr> | ||
793 | </table> | ||
794 | </div> | ||
795 | <div class="memdoc"> | ||
796 | |||
797 | <p>Creates an <a class="el" href="classirr_1_1io_1_1_i_write_file.html" title="Interface providing write access to a file.">IWriteFile</a> interface for accessing memory like a file. </p> | ||
798 | <p>This allows you to use a pointer to memory where an <a class="el" href="classirr_1_1io_1_1_i_write_file.html" title="Interface providing write access to a file.">IWriteFile</a> is requested. You are responsible for allocating enough memory. </p> | ||
799 | <dl><dt><b>Parameters:</b></dt><dd> | ||
800 | <table class="params"> | ||
801 | <tr><td class="paramname">memory,:</td><td>A pointer to the start of the file in memory (allocated by you) </td></tr> | ||
802 | <tr><td class="paramname">len,:</td><td>The length of the memory in bytes </td></tr> | ||
803 | <tr><td class="paramname">fileName,:</td><td>The name given to this file </td></tr> | ||
804 | <tr><td class="paramname">deleteMemoryWhenDropped,:</td><td>True if the memory should be deleted along with the <a class="el" href="classirr_1_1io_1_1_i_write_file.html" title="Interface providing write access to a file.">IWriteFile</a> when it is dropped. </td></tr> | ||
805 | </table> | ||
806 | </dd> | ||
807 | </dl> | ||
808 | <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
809 | |||
810 | </div> | ||
811 | </div> | ||
812 | <a class="anchor" id="a167c9fa159d16ee5c56c074636b0865e"></a><!-- doxytag: member="irr::io::IFileSystem::createXMLReader" ref="a167c9fa159d16ee5c56c074636b0865e" args="(const path &filename)=0" --> | ||
813 | <div class="memitem"> | ||
814 | <div class="memproto"> | ||
815 | <table class="memname"> | ||
816 | <tr> | ||
817 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#a9dc6291fb7e4c73155a3e3c8339f9bff">IXMLReader</a>* irr::io::IFileSystem::createXMLReader </td> | ||
818 | <td>(</td> | ||
819 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
820 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
821 | <td><code> [pure virtual]</code></td> | ||
822 | </tr> | ||
823 | </table> | ||
824 | </div> | ||
825 | <div class="memdoc"> | ||
826 | |||
827 | <p>Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*). </p> | ||
828 | <p>Use <a class="el" href="classirr_1_1io_1_1_i_file_system.html#affd8f622ac7c3dcd507f20f9cd23b21f" title="Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*)...">createXMLReaderUTF8()</a> if you prefer char* instead of wchar_t*. See <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html" title="Interface providing easy read access to a XML file.">IIrrXMLReader</a> for more information on how to use the parser. </p> | ||
829 | <dl class="return"><dt><b>Returns:</b></dt><dd>0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReader::drop() method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
830 | |||
831 | </div> | ||
832 | </div> | ||
833 | <a class="anchor" id="a38f4c90db3fd1b21473ce0cd2437bb59"></a><!-- doxytag: member="irr::io::IFileSystem::createXMLReader" ref="a38f4c90db3fd1b21473ce0cd2437bb59" args="(IReadFile *file)=0" --> | ||
834 | <div class="memitem"> | ||
835 | <div class="memproto"> | ||
836 | <table class="memname"> | ||
837 | <tr> | ||
838 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#a9dc6291fb7e4c73155a3e3c8339f9bff">IXMLReader</a>* irr::io::IFileSystem::createXMLReader </td> | ||
839 | <td>(</td> | ||
840 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * </td> | ||
841 | <td class="paramname"><em>file</em></td><td>)</td> | ||
842 | <td><code> [pure virtual]</code></td> | ||
843 | </tr> | ||
844 | </table> | ||
845 | </div> | ||
846 | <div class="memdoc"> | ||
847 | |||
848 | <p>Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*). </p> | ||
849 | <p>Use <a class="el" href="classirr_1_1io_1_1_i_file_system.html#affd8f622ac7c3dcd507f20f9cd23b21f" title="Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*)...">createXMLReaderUTF8()</a> if you prefer char* instead of wchar_t*. See <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html" title="Interface providing easy read access to a XML file.">IIrrXMLReader</a> for more information on how to use the parser. </p> | ||
850 | <dl class="return"><dt><b>Returns:</b></dt><dd>0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReader::drop() method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
851 | |||
852 | </div> | ||
853 | </div> | ||
854 | <a class="anchor" id="affd8f622ac7c3dcd507f20f9cd23b21f"></a><!-- doxytag: member="irr::io::IFileSystem::createXMLReaderUTF8" ref="affd8f622ac7c3dcd507f20f9cd23b21f" args="(const path &filename)=0" --> | ||
855 | <div class="memitem"> | ||
856 | <div class="memproto"> | ||
857 | <table class="memname"> | ||
858 | <tr> | ||
859 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#a2dedc8156931082e6b147b562195e310">IXMLReaderUTF8</a>* irr::io::IFileSystem::createXMLReaderUTF8 </td> | ||
860 | <td>(</td> | ||
861 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
862 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
863 | <td><code> [pure virtual]</code></td> | ||
864 | </tr> | ||
865 | </table> | ||
866 | </div> | ||
867 | <div class="memdoc"> | ||
868 | |||
869 | <p>Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*). </p> | ||
870 | <p>Use <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a167c9fa159d16ee5c56c074636b0865e" title="Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*)...">createXMLReader()</a> if you prefer wchar_t* instead of char*. See <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html" title="Interface providing easy read access to a XML file.">IIrrXMLReader</a> for more information on how to use the parser. </p> | ||
871 | <dl class="return"><dt><b>Returns:</b></dt><dd>0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReaderUTF8::drop() method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
872 | |||
873 | </div> | ||
874 | </div> | ||
875 | <a class="anchor" id="acda42a761d3b2fb4d39ad1d9e2ada973"></a><!-- doxytag: member="irr::io::IFileSystem::createXMLReaderUTF8" ref="acda42a761d3b2fb4d39ad1d9e2ada973" args="(IReadFile *file)=0" --> | ||
876 | <div class="memitem"> | ||
877 | <div class="memproto"> | ||
878 | <table class="memname"> | ||
879 | <tr> | ||
880 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#a2dedc8156931082e6b147b562195e310">IXMLReaderUTF8</a>* irr::io::IFileSystem::createXMLReaderUTF8 </td> | ||
881 | <td>(</td> | ||
882 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * </td> | ||
883 | <td class="paramname"><em>file</em></td><td>)</td> | ||
884 | <td><code> [pure virtual]</code></td> | ||
885 | </tr> | ||
886 | </table> | ||
887 | </div> | ||
888 | <div class="memdoc"> | ||
889 | |||
890 | <p>Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*). </p> | ||
891 | <p>Use <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a167c9fa159d16ee5c56c074636b0865e" title="Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*)...">createXMLReader()</a> if you prefer wchar_t* instead of char*. See <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html" title="Interface providing easy read access to a XML file.">IIrrXMLReader</a> for more information on how to use the parser. </p> | ||
892 | <dl class="return"><dt><b>Returns:</b></dt><dd>0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReaderUTF8::drop() method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
893 | |||
894 | </div> | ||
895 | </div> | ||
896 | <a class="anchor" id="a0737712d1c90001e5765ef46912c616d"></a><!-- doxytag: member="irr::io::IFileSystem::createXMLWriter" ref="a0737712d1c90001e5765ef46912c616d" args="(const path &filename)=0" --> | ||
897 | <div class="memitem"> | ||
898 | <div class="memproto"> | ||
899 | <table class="memname"> | ||
900 | <tr> | ||
901 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html">IXMLWriter</a>* irr::io::IFileSystem::createXMLWriter </td> | ||
902 | <td>(</td> | ||
903 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
904 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
905 | <td><code> [pure virtual]</code></td> | ||
906 | </tr> | ||
907 | </table> | ||
908 | </div> | ||
909 | <div class="memdoc"> | ||
910 | |||
911 | <p>Creates a XML Writer from a file. </p> | ||
912 | <dl class="return"><dt><b>Returns:</b></dt><dd>0, if file could not be opened, otherwise a pointer to the created <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html" title="Interface providing methods for making it easier to write XML files.">IXMLWriter</a> is returned. After use, the reader has to be deleted using its <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IXMLWriter::drop()</a> method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
913 | |||
914 | </div> | ||
915 | </div> | ||
916 | <a class="anchor" id="ac2bcaf8c338e80ff579061b7056c06da"></a><!-- doxytag: member="irr::io::IFileSystem::createXMLWriter" ref="ac2bcaf8c338e80ff579061b7056c06da" args="(IWriteFile *file)=0" --> | ||
917 | <div class="memitem"> | ||
918 | <div class="memproto"> | ||
919 | <table class="memname"> | ||
920 | <tr> | ||
921 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html">IXMLWriter</a>* irr::io::IFileSystem::createXMLWriter </td> | ||
922 | <td>(</td> | ||
923 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_write_file.html">IWriteFile</a> * </td> | ||
924 | <td class="paramname"><em>file</em></td><td>)</td> | ||
925 | <td><code> [pure virtual]</code></td> | ||
926 | </tr> | ||
927 | </table> | ||
928 | </div> | ||
929 | <div class="memdoc"> | ||
930 | |||
931 | <p>Creates a XML Writer from a file. </p> | ||
932 | <dl class="return"><dt><b>Returns:</b></dt><dd>0, if file could not be opened, otherwise a pointer to the created <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html" title="Interface providing methods for making it easier to write XML files.">IXMLWriter</a> is returned. After use, the reader has to be deleted using its <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IXMLWriter::drop()</a> method. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl> | ||
933 | |||
934 | </div> | ||
935 | </div> | ||
936 | <a class="anchor" id="a1c5e98bc16e38b1d15b44e24b1b3bd32"></a><!-- doxytag: member="irr::io::IFileSystem::existFile" ref="a1c5e98bc16e38b1d15b44e24b1b3bd32" args="(const path &filename) const =0" --> | ||
937 | <div class="memitem"> | ||
938 | <div class="memproto"> | ||
939 | <table class="memname"> | ||
940 | <tr> | ||
941 | <td class="memname">virtual bool irr::io::IFileSystem::existFile </td> | ||
942 | <td>(</td> | ||
943 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
944 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
945 | <td> const<code> [pure virtual]</code></td> | ||
946 | </tr> | ||
947 | </table> | ||
948 | </div> | ||
949 | <div class="memdoc"> | ||
950 | |||
951 | <p>Determines if a file exists and could be opened. </p> | ||
952 | <dl><dt><b>Parameters:</b></dt><dd> | ||
953 | <table class="params"> | ||
954 | <tr><td class="paramname">filename</td><td>is the string identifying the file which should be tested for existence. </td></tr> | ||
955 | </table> | ||
956 | </dd> | ||
957 | </dl> | ||
958 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if file exists, and false if it does not exist or an error occured. </dd></dl> | ||
959 | |||
960 | <p>Referenced by <a class="el" href="_i_q3_shader_8h_source.html#l00769">irr::scene::quake3::getTextures()</a>.</p> | ||
961 | |||
962 | </div> | ||
963 | </div> | ||
964 | <a class="anchor" id="aa76bbc9cc5ec7a8dbe96713f1ba20de6"></a><!-- doxytag: member="irr::io::IFileSystem::flattenFilename" ref="aa76bbc9cc5ec7a8dbe96713f1ba20de6" args="(path &directory, const path &root="/") const =0" --> | ||
965 | <div class="memitem"> | ||
966 | <div class="memproto"> | ||
967 | <table class="memname"> | ||
968 | <tr> | ||
969 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a>& irr::io::IFileSystem::flattenFilename </td> | ||
970 | <td>(</td> | ||
971 | <td class="paramtype"><a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
972 | <td class="paramname"><em>directory</em>, </td> | ||
973 | </tr> | ||
974 | <tr> | ||
975 | <td class="paramkey"></td> | ||
976 | <td></td> | ||
977 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
978 | <td class="paramname"><em>root</em> = <code>"/"</code> </td> | ||
979 | </tr> | ||
980 | <tr> | ||
981 | <td></td> | ||
982 | <td>)</td> | ||
983 | <td></td><td> const<code> [pure virtual]</code></td> | ||
984 | </tr> | ||
985 | </table> | ||
986 | </div> | ||
987 | <div class="memdoc"> | ||
988 | |||
989 | <p>flatten a path and file name for example: "/you/me/../." becomes "/you" </p> | ||
990 | |||
991 | </div> | ||
992 | </div> | ||
993 | <a class="anchor" id="a77191d7917349a0200f5de3ef29acd18"></a><!-- doxytag: member="irr::io::IFileSystem::getAbsolutePath" ref="a77191d7917349a0200f5de3ef29acd18" args="(const path &filename) const =0" --> | ||
994 | <div class="memitem"> | ||
995 | <div class="memproto"> | ||
996 | <table class="memname"> | ||
997 | <tr> | ||
998 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> irr::io::IFileSystem::getAbsolutePath </td> | ||
999 | <td>(</td> | ||
1000 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
1001 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
1002 | <td> const<code> [pure virtual]</code></td> | ||
1003 | </tr> | ||
1004 | </table> | ||
1005 | </div> | ||
1006 | <div class="memdoc"> | ||
1007 | |||
1008 | <p>Converts a relative path to an absolute (unique) path, resolving symbolic links if required. </p> | ||
1009 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1010 | <table class="params"> | ||
1011 | <tr><td class="paramname">filename</td><td>Possibly relative file or directory name to query. </td></tr> | ||
1012 | </table> | ||
1013 | </dd> | ||
1014 | </dl> | ||
1015 | <dl class="return"><dt><b>Returns:</b></dt><dd>Absolute filename which points to the same file. </dd></dl> | ||
1016 | |||
1017 | </div> | ||
1018 | </div> | ||
1019 | <a class="anchor" id="a175208d74556d1a0e4fe7400bbc65d7b"></a><!-- doxytag: member="irr::io::IFileSystem::getArchiveLoader" ref="a175208d74556d1a0e4fe7400bbc65d7b" args="(u32 index) const =0" --> | ||
1020 | <div class="memitem"> | ||
1021 | <div class="memproto"> | ||
1022 | <table class="memname"> | ||
1023 | <tr> | ||
1024 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html">IArchiveLoader</a>* irr::io::IFileSystem::getArchiveLoader </td> | ||
1025 | <td>(</td> | ||
1026 | <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> | ||
1027 | <td class="paramname"><em>index</em></td><td>)</td> | ||
1028 | <td> const<code> [pure virtual]</code></td> | ||
1029 | </tr> | ||
1030 | </table> | ||
1031 | </div> | ||
1032 | <div class="memdoc"> | ||
1033 | |||
1034 | <p>Retrieve the given archive loader. </p> | ||
1035 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1036 | <table class="params"> | ||
1037 | <tr><td class="paramname">index</td><td>The index of the loader to retrieve. This parameter is an 0-based array index. </td></tr> | ||
1038 | </table> | ||
1039 | </dd> | ||
1040 | </dl> | ||
1041 | <dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the specified loader, 0 if the index is incorrect. </dd></dl> | ||
1042 | |||
1043 | </div> | ||
1044 | </div> | ||
1045 | <a class="anchor" id="ae1e958f65eb8b61b40f3c71a593f852d"></a><!-- doxytag: member="irr::io::IFileSystem::getArchiveLoaderCount" ref="ae1e958f65eb8b61b40f3c71a593f852d" args="() const =0" --> | ||
1046 | <div class="memitem"> | ||
1047 | <div class="memproto"> | ||
1048 | <table class="memname"> | ||
1049 | <tr> | ||
1050 | <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileSystem::getArchiveLoaderCount </td> | ||
1051 | <td>(</td> | ||
1052 | <td class="paramname"></td><td>)</td> | ||
1053 | <td> const<code> [pure virtual]</code></td> | ||
1054 | </tr> | ||
1055 | </table> | ||
1056 | </div> | ||
1057 | <div class="memdoc"> | ||
1058 | |||
1059 | <p>Gets the number of archive loaders currently added. </p> | ||
1060 | |||
1061 | </div> | ||
1062 | </div> | ||
1063 | <a class="anchor" id="a1ac4bfb7bfd7d2961af8e5c128190fae"></a><!-- doxytag: member="irr::io::IFileSystem::getFileArchive" ref="a1ac4bfb7bfd7d2961af8e5c128190fae" args="(u32 index)=0" --> | ||
1064 | <div class="memitem"> | ||
1065 | <div class="memproto"> | ||
1066 | <table class="memname"> | ||
1067 | <tr> | ||
1068 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a>* irr::io::IFileSystem::getFileArchive </td> | ||
1069 | <td>(</td> | ||
1070 | <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> | ||
1071 | <td class="paramname"><em>index</em></td><td>)</td> | ||
1072 | <td><code> [pure virtual]</code></td> | ||
1073 | </tr> | ||
1074 | </table> | ||
1075 | </div> | ||
1076 | <div class="memdoc"> | ||
1077 | |||
1078 | <p>Get the archive at a given index. </p> | ||
1079 | |||
1080 | </div> | ||
1081 | </div> | ||
1082 | <a class="anchor" id="a85862865f72b1e187402365e4236dce0"></a><!-- doxytag: member="irr::io::IFileSystem::getFileArchiveCount" ref="a85862865f72b1e187402365e4236dce0" args="() const =0" --> | ||
1083 | <div class="memitem"> | ||
1084 | <div class="memproto"> | ||
1085 | <table class="memname"> | ||
1086 | <tr> | ||
1087 | <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileSystem::getFileArchiveCount </td> | ||
1088 | <td>(</td> | ||
1089 | <td class="paramname"></td><td>)</td> | ||
1090 | <td> const<code> [pure virtual]</code></td> | ||
1091 | </tr> | ||
1092 | </table> | ||
1093 | </div> | ||
1094 | <div class="memdoc"> | ||
1095 | |||
1096 | <p>Get the number of archives currently attached to the file system. </p> | ||
1097 | |||
1098 | </div> | ||
1099 | </div> | ||
1100 | <a class="anchor" id="a4235989e4ec21c78f1fd1ca861980c6c"></a><!-- doxytag: member="irr::io::IFileSystem::getFileBasename" ref="a4235989e4ec21c78f1fd1ca861980c6c" args="(const path &filename, bool keepExtension=true) const =0" --> | ||
1101 | <div class="memitem"> | ||
1102 | <div class="memproto"> | ||
1103 | <table class="memname"> | ||
1104 | <tr> | ||
1105 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> irr::io::IFileSystem::getFileBasename </td> | ||
1106 | <td>(</td> | ||
1107 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
1108 | <td class="paramname"><em>filename</em>, </td> | ||
1109 | </tr> | ||
1110 | <tr> | ||
1111 | <td class="paramkey"></td> | ||
1112 | <td></td> | ||
1113 | <td class="paramtype">bool </td> | ||
1114 | <td class="paramname"><em>keepExtension</em> = <code>true</code> </td> | ||
1115 | </tr> | ||
1116 | <tr> | ||
1117 | <td></td> | ||
1118 | <td>)</td> | ||
1119 | <td></td><td> const<code> [pure virtual]</code></td> | ||
1120 | </tr> | ||
1121 | </table> | ||
1122 | </div> | ||
1123 | <div class="memdoc"> | ||
1124 | |||
1125 | <p>Get the base part of a filename, i.e. the name without the directory part. </p> | ||
1126 | <p>If no directory is prefixed, the full name is returned. </p> | ||
1127 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1128 | <table class="params"> | ||
1129 | <tr><td class="paramname">filename,:</td><td>The file to get the basename from </td></tr> | ||
1130 | <tr><td class="paramname">keepExtension</td><td>True if filename with extension is returned otherwise everything after the final '.' is removed as well. </td></tr> | ||
1131 | </table> | ||
1132 | </dd> | ||
1133 | </dl> | ||
1134 | |||
1135 | </div> | ||
1136 | </div> | ||
1137 | <a class="anchor" id="ad8b7b93f32f58c1ba9a8e7cacd5de80b"></a><!-- doxytag: member="irr::io::IFileSystem::getFileDir" ref="ad8b7b93f32f58c1ba9a8e7cacd5de80b" args="(const path &filename) const =0" --> | ||
1138 | <div class="memitem"> | ||
1139 | <div class="memproto"> | ||
1140 | <table class="memname"> | ||
1141 | <tr> | ||
1142 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> irr::io::IFileSystem::getFileDir </td> | ||
1143 | <td>(</td> | ||
1144 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
1145 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
1146 | <td> const<code> [pure virtual]</code></td> | ||
1147 | </tr> | ||
1148 | </table> | ||
1149 | </div> | ||
1150 | <div class="memdoc"> | ||
1151 | |||
1152 | <p>Get the directory a file is located in. </p> | ||
1153 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1154 | <table class="params"> | ||
1155 | <tr><td class="paramname">filename,:</td><td>The file to get the directory from. </td></tr> | ||
1156 | </table> | ||
1157 | </dd> | ||
1158 | </dl> | ||
1159 | <dl class="return"><dt><b>Returns:</b></dt><dd>String containing the directory of the file. </dd></dl> | ||
1160 | |||
1161 | </div> | ||
1162 | </div> | ||
1163 | <a class="anchor" id="a9cb85c468a6cda253ff99c88010028c7"></a><!-- doxytag: member="irr::io::IFileSystem::getRelativeFilename" ref="a9cb85c468a6cda253ff99c88010028c7" args="(const path &filename, const path &directory) const =0" --> | ||
1164 | <div class="memitem"> | ||
1165 | <div class="memproto"> | ||
1166 | <table class="memname"> | ||
1167 | <tr> | ||
1168 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> irr::io::IFileSystem::getRelativeFilename </td> | ||
1169 | <td>(</td> | ||
1170 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
1171 | <td class="paramname"><em>filename</em>, </td> | ||
1172 | </tr> | ||
1173 | <tr> | ||
1174 | <td class="paramkey"></td> | ||
1175 | <td></td> | ||
1176 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
1177 | <td class="paramname"><em>directory</em> </td> | ||
1178 | </tr> | ||
1179 | <tr> | ||
1180 | <td></td> | ||
1181 | <td>)</td> | ||
1182 | <td></td><td> const<code> [pure virtual]</code></td> | ||
1183 | </tr> | ||
1184 | </table> | ||
1185 | </div> | ||
1186 | <div class="memdoc"> | ||
1187 | |||
1188 | <p>Get the relative filename, relative to the given directory. </p> | ||
1189 | |||
1190 | </div> | ||
1191 | </div> | ||
1192 | <a class="anchor" id="acbf7342afa6e2fc9583db3e521e66e61"></a><!-- doxytag: member="irr::io::IFileSystem::getWorkingDirectory" ref="acbf7342afa6e2fc9583db3e521e66e61" args="()=0" --> | ||
1193 | <div class="memitem"> | ||
1194 | <div class="memproto"> | ||
1195 | <table class="memname"> | ||
1196 | <tr> | ||
1197 | <td class="memname">virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a>& irr::io::IFileSystem::getWorkingDirectory </td> | ||
1198 | <td>(</td> | ||
1199 | <td class="paramname"></td><td>)</td> | ||
1200 | <td><code> [pure virtual]</code></td> | ||
1201 | </tr> | ||
1202 | </table> | ||
1203 | </div> | ||
1204 | <div class="memdoc"> | ||
1205 | |||
1206 | <p>Get the current working directory. </p> | ||
1207 | <dl class="return"><dt><b>Returns:</b></dt><dd>Current working directory as a string. </dd></dl> | ||
1208 | |||
1209 | </div> | ||
1210 | </div> | ||
1211 | <a class="anchor" id="ae8530fb9793373cf4dbee956090e99f6"></a><!-- doxytag: member="irr::io::IFileSystem::moveFileArchive" ref="ae8530fb9793373cf4dbee956090e99f6" args="(u32 sourceIndex, s32 relative)=0" --> | ||
1212 | <div class="memitem"> | ||
1213 | <div class="memproto"> | ||
1214 | <table class="memname"> | ||
1215 | <tr> | ||
1216 | <td class="memname">virtual bool irr::io::IFileSystem::moveFileArchive </td> | ||
1217 | <td>(</td> | ||
1218 | <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> | ||
1219 | <td class="paramname"><em>sourceIndex</em>, </td> | ||
1220 | </tr> | ||
1221 | <tr> | ||
1222 | <td class="paramkey"></td> | ||
1223 | <td></td> | ||
1224 | <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> | ||
1225 | <td class="paramname"><em>relative</em> </td> | ||
1226 | </tr> | ||
1227 | <tr> | ||
1228 | <td></td> | ||
1229 | <td>)</td> | ||
1230 | <td></td><td><code> [pure virtual]</code></td> | ||
1231 | </tr> | ||
1232 | </table> | ||
1233 | </div> | ||
1234 | <div class="memdoc"> | ||
1235 | |||
1236 | <p>Changes the search order of attached archives. </p> | ||
1237 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1238 | <table class="params"> | ||
1239 | <tr><td class="paramname">sourceIndex,:</td><td>The index of the archive to change </td></tr> | ||
1240 | <tr><td class="paramname">relative,:</td><td>The relative change in position, archives with a lower index are searched first </td></tr> | ||
1241 | </table> | ||
1242 | </dd> | ||
1243 | </dl> | ||
1244 | |||
1245 | </div> | ||
1246 | </div> | ||
1247 | <a class="anchor" id="aa509623756c9bcbc3a9bcf455ea2a3ba"></a><!-- doxytag: member="irr::io::IFileSystem::removeFileArchive" ref="aa509623756c9bcbc3a9bcf455ea2a3ba" args="(u32 index)=0" --> | ||
1248 | <div class="memitem"> | ||
1249 | <div class="memproto"> | ||
1250 | <table class="memname"> | ||
1251 | <tr> | ||
1252 | <td class="memname">virtual bool irr::io::IFileSystem::removeFileArchive </td> | ||
1253 | <td>(</td> | ||
1254 | <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> | ||
1255 | <td class="paramname"><em>index</em></td><td>)</td> | ||
1256 | <td><code> [pure virtual]</code></td> | ||
1257 | </tr> | ||
1258 | </table> | ||
1259 | </div> | ||
1260 | <div class="memdoc"> | ||
1261 | |||
1262 | <p>Removes an archive from the file system. </p> | ||
1263 | <p>This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes. </p> | ||
1264 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1265 | <table class="params"> | ||
1266 | <tr><td class="paramname">index,:</td><td>The index of the archive to remove </td></tr> | ||
1267 | </table> | ||
1268 | </dd> | ||
1269 | </dl> | ||
1270 | <dl class="return"><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl> | ||
1271 | |||
1272 | </div> | ||
1273 | </div> | ||
1274 | <a class="anchor" id="a03b405c8f5346c225c590cde585eb73c"></a><!-- doxytag: member="irr::io::IFileSystem::removeFileArchive" ref="a03b405c8f5346c225c590cde585eb73c" args="(const path &filename)=0" --> | ||
1275 | <div class="memitem"> | ||
1276 | <div class="memproto"> | ||
1277 | <table class="memname"> | ||
1278 | <tr> | ||
1279 | <td class="memname">virtual bool irr::io::IFileSystem::removeFileArchive </td> | ||
1280 | <td>(</td> | ||
1281 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> & </td> | ||
1282 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
1283 | <td><code> [pure virtual]</code></td> | ||
1284 | </tr> | ||
1285 | </table> | ||
1286 | </div> | ||
1287 | <div class="memdoc"> | ||
1288 | |||
1289 | <p>Removes an archive from the file system. </p> | ||
1290 | <p>This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes. Note that a relative filename might be interpreted differently on each call, depending on the current working directory. In case you want to remove an archive that was added using a relative path name, you have to change to the same working directory again. This means, that the filename given on creation is not an identifier for the archive, but just a usual filename that is used for locating the archive to work with. </p> | ||
1291 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1292 | <table class="params"> | ||
1293 | <tr><td class="paramname">filename</td><td>The archive pointed to by the name will be removed </td></tr> | ||
1294 | </table> | ||
1295 | </dd> | ||
1296 | </dl> | ||
1297 | <dl class="return"><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl> | ||
1298 | |||
1299 | </div> | ||
1300 | </div> | ||
1301 | <a class="anchor" id="ab7579f5ccca7bc7c1e079f5cb38173ed"></a><!-- doxytag: member="irr::io::IFileSystem::removeFileArchive" ref="ab7579f5ccca7bc7c1e079f5cb38173ed" args="(const IFileArchive *archive)=0" --> | ||
1302 | <div class="memitem"> | ||
1303 | <div class="memproto"> | ||
1304 | <table class="memname"> | ||
1305 | <tr> | ||
1306 | <td class="memname">virtual bool irr::io::IFileSystem::removeFileArchive </td> | ||
1307 | <td>(</td> | ||
1308 | <td class="paramtype">const <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> * </td> | ||
1309 | <td class="paramname"><em>archive</em></td><td>)</td> | ||
1310 | <td><code> [pure virtual]</code></td> | ||
1311 | </tr> | ||
1312 | </table> | ||
1313 | </div> | ||
1314 | <div class="memdoc"> | ||
1315 | |||
1316 | <p>Removes an archive from the file system. </p> | ||
1317 | <p>This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes. </p> | ||
1318 | <dl><dt><b>Parameters:</b></dt><dd> | ||
1319 | <table class="params"> | ||
1320 | <tr><td class="paramname">archive</td><td>The archive to remove. </td></tr> | ||
1321 | </table> | ||
1322 | </dd> | ||
1323 | </dl> | ||
1324 | <dl class="return"><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl> | ||
1325 | |||
1326 | </div> | ||
1327 | </div> | ||
1328 | <a class="anchor" id="a767614d727f0b1ec0bc5fdaaf906169b"></a><!-- doxytag: member="irr::io::IFileSystem::setFileListSystem" ref="a767614d727f0b1ec0bc5fdaaf906169b" args="(EFileSystemType listType)=0" --> | ||
1329 | <div class="memitem"> | ||
1330 | <div class="memproto"> | ||
1331 | <table class="memname"> | ||
1332 | <tr> | ||
1333 | <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#a22364f1caf06442a70f6198025af3fe9">EFileSystemType</a> irr::io::IFileSystem::setFileListSystem </td> | ||
1334 | <td>(</td> | ||
1335 | <td class="paramtype"><a class="el" href="namespaceirr_1_1io.html#a22364f1caf06442a70f6198025af3fe9">EFileSystemType</a> </td> | ||
1336 | <td class="paramname"><em>listType</em></td><td>)</td> | ||
1337 | <td><code> [pure virtual]</code></td> | ||
1338 | </tr> | ||
1339 | </table> | ||
1340 | </div> | ||
1341 | <div class="memdoc"> | ||
1342 | |||
1343 | <p>Set the active type of file system. </p> | ||
1344 | |||
1345 | </div> | ||
1346 | </div> | ||
1347 | <hr/>The documentation for this class was generated from the following file:<ul> | ||
1348 | <li><a class="el" href="_i_file_system_8h_source.html">IFileSystem.h</a></li> | ||
1349 | </ul> | ||
1350 | </div> | ||
1351 | </div> | ||
1352 | <div id="nav-path" class="navpath"> | ||
1353 | <ul> | ||
1354 | <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> | ||
1355 | <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li> | ||
1356 | <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_file_system.html">IFileSystem</a> </li> | ||
1357 | <!-- window showing the filter options --> | ||
1358 | <div id="MSearchSelectWindow" | ||
1359 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
1360 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
1361 | onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
1362 | <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> | ||
1363 | |||
1364 | <!-- iframe showing the search results (closed by default) --> | ||
1365 | <div id="MSearchResultsWindow"> | ||
1366 | <iframe src="javascript:void(0)" frameborder="0" | ||
1367 | name="MSearchResults" id="MSearchResults"> | ||
1368 | </iframe> | ||
1369 | </div> | ||
1370 | |||
1371 | |||
1372 | <li class="footer"> | ||
1373 | <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht | ||
1374 | Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Tue Nov 6 2012 11:06:05 for Irrlicht 3D Engine by | ||
1375 | <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> | ||
1376 | </ul> | ||
1377 | </div> | ||
1378 | |||
1379 | |||
1380 | </body> | ||
1381 | </html> | ||