diff options
Diffstat (limited to 'libraries/irrlicht-1.8/doc/html/classirr_1_1video_1_1_i_image_writer.html')
-rw-r--r-- | libraries/irrlicht-1.8/doc/html/classirr_1_1video_1_1_i_image_writer.html | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/libraries/irrlicht-1.8/doc/html/classirr_1_1video_1_1_i_image_writer.html b/libraries/irrlicht-1.8/doc/html/classirr_1_1video_1_1_i_image_writer.html new file mode 100644 index 0000000..871e2d1 --- /dev/null +++ b/libraries/irrlicht-1.8/doc/html/classirr_1_1video_1_1_i_image_writer.html | |||
@@ -0,0 +1,226 @@ | |||
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::video::IImageWriter 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_1video_1_1_i_image_writer.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::video::IImageWriter Class Reference</div> </div> | ||
91 | </div> | ||
92 | <div class="contents"> | ||
93 | <!-- doxytag: class="irr::video::IImageWriter" --><!-- doxytag: inherits="irr::IReferenceCounted" --> | ||
94 | <p>Interface for writing software image data. | ||
95 | <a href="classirr_1_1video_1_1_i_image_writer.html#details">More...</a></p> | ||
96 | |||
97 | <p><code>#include <<a class="el" href="_i_image_writer_8h_source.html">IImageWriter.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::video::IImageWriter:</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_1video_1_1_i_image_writer.png" usemap="#irr::video::IImageWriter_map" alt=""/> | ||
105 | <map id="irr::video::IImageWriter_map" name="irr::video::IImageWriter_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_1video_1_1_i_image_writer-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 bool <a class="el" href="classirr_1_1video_1_1_i_image_writer.html#a776f8a7a050572f2144848a86fe6de6b">isAWriteableFileExtension</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &filename) const =0 | ||
115 | <dl class="el"><dd class="mdescRight">Check if this writer can write a file with the given extension. <a href="#a776f8a7a050572f2144848a86fe6de6b"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1video_1_1_i_image_writer.html#a0a7f09d1f1613adfe2bfaadc60913f7e">writeImage</a> (<a class="el" href="classirr_1_1io_1_1_i_write_file.html">io::IWriteFile</a> *file, <a class="el" href="classirr_1_1video_1_1_i_image.html">IImage</a> *image, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> param=0) const =0 | ||
116 | <dl class="el"><dd class="mdescRight">Write image to file. <a href="#a0a7f09d1f1613adfe2bfaadc60913f7e"></a><br/></dl></ul> | ||
117 | <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> | ||
118 | <div class="textblock"><p>Interface for writing software image data. </p> | ||
119 | |||
120 | <p>Definition at line <a class="el" href="_i_image_writer_8h_source.html#l00025">25</a> of file <a class="el" href="_i_image_writer_8h_source.html">IImageWriter.h</a>.</p> | ||
121 | </div><hr/><h2>Member Function Documentation</h2> | ||
122 | <a class="anchor" id="a776f8a7a050572f2144848a86fe6de6b"></a><!-- doxytag: member="irr::video::IImageWriter::isAWriteableFileExtension" ref="a776f8a7a050572f2144848a86fe6de6b" args="(const io::path &filename) const =0" --> | ||
123 | <div class="memitem"> | ||
124 | <div class="memproto"> | ||
125 | <table class="memname"> | ||
126 | <tr> | ||
127 | <td class="memname">virtual bool irr::video::IImageWriter::isAWriteableFileExtension </td> | ||
128 | <td>(</td> | ||
129 | <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> & </td> | ||
130 | <td class="paramname"><em>filename</em></td><td>)</td> | ||
131 | <td> const<code> [pure virtual]</code></td> | ||
132 | </tr> | ||
133 | </table> | ||
134 | </div> | ||
135 | <div class="memdoc"> | ||
136 | |||
137 | <p>Check if this writer can write a file with the given extension. </p> | ||
138 | <dl><dt><b>Parameters:</b></dt><dd> | ||
139 | <table class="params"> | ||
140 | <tr><td class="paramname">filename</td><td>Name of the file to check. </td></tr> | ||
141 | </table> | ||
142 | </dd> | ||
143 | </dl> | ||
144 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if file extension specifies a writable type. </dd></dl> | ||
145 | |||
146 | </div> | ||
147 | </div> | ||
148 | <a class="anchor" id="a0a7f09d1f1613adfe2bfaadc60913f7e"></a><!-- doxytag: member="irr::video::IImageWriter::writeImage" ref="a0a7f09d1f1613adfe2bfaadc60913f7e" args="(io::IWriteFile *file, IImage *image, u32 param=0) const =0" --> | ||
149 | <div class="memitem"> | ||
150 | <div class="memproto"> | ||
151 | <table class="memname"> | ||
152 | <tr> | ||
153 | <td class="memname">virtual bool irr::video::IImageWriter::writeImage </td> | ||
154 | <td>(</td> | ||
155 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_write_file.html">io::IWriteFile</a> * </td> | ||
156 | <td class="paramname"><em>file</em>, </td> | ||
157 | </tr> | ||
158 | <tr> | ||
159 | <td class="paramkey"></td> | ||
160 | <td></td> | ||
161 | <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_image.html">IImage</a> * </td> | ||
162 | <td class="paramname"><em>image</em>, </td> | ||
163 | </tr> | ||
164 | <tr> | ||
165 | <td class="paramkey"></td> | ||
166 | <td></td> | ||
167 | <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td> | ||
168 | <td class="paramname"><em>param</em> = <code>0</code> </td> | ||
169 | </tr> | ||
170 | <tr> | ||
171 | <td></td> | ||
172 | <td>)</td> | ||
173 | <td></td><td> const<code> [pure virtual]</code></td> | ||
174 | </tr> | ||
175 | </table> | ||
176 | </div> | ||
177 | <div class="memdoc"> | ||
178 | |||
179 | <p>Write image to file. </p> | ||
180 | <dl><dt><b>Parameters:</b></dt><dd> | ||
181 | <table class="params"> | ||
182 | <tr><td class="paramname">file</td><td>File handle to write to. </td></tr> | ||
183 | <tr><td class="paramname">image</td><td>Image to write into file. </td></tr> | ||
184 | <tr><td class="paramname">param</td><td>Writer specific parameter, influencing e.g. quality. </td></tr> | ||
185 | </table> | ||
186 | </dd> | ||
187 | </dl> | ||
188 | <dl class="return"><dt><b>Returns:</b></dt><dd>True if image was successfully written. </dd></dl> | ||
189 | |||
190 | </div> | ||
191 | </div> | ||
192 | <hr/>The documentation for this class was generated from the following file:<ul> | ||
193 | <li><a class="el" href="_i_image_writer_8h_source.html">IImageWriter.h</a></li> | ||
194 | </ul> | ||
195 | </div> | ||
196 | </div> | ||
197 | <div id="nav-path" class="navpath"> | ||
198 | <ul> | ||
199 | <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> | ||
200 | <li class="navelem"><a class="el" href="namespaceirr_1_1video.html">video</a> </li> | ||
201 | <li class="navelem"><a class="el" href="classirr_1_1video_1_1_i_image_writer.html">IImageWriter</a> </li> | ||
202 | <!-- window showing the filter options --> | ||
203 | <div id="MSearchSelectWindow" | ||
204 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
205 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
206 | onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
207 | <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> | ||
208 | |||
209 | <!-- iframe showing the search results (closed by default) --> | ||
210 | <div id="MSearchResultsWindow"> | ||
211 | <iframe src="javascript:void(0)" frameborder="0" | ||
212 | name="MSearchResults" id="MSearchResults"> | ||
213 | </iframe> | ||
214 | </div> | ||
215 | |||
216 | |||
217 | <li class="footer"> | ||
218 | <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht | ||
219 | Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Tue Nov 6 2012 11:06:07 for Irrlicht 3D Engine by | ||
220 | <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> | ||
221 | </ul> | ||
222 | </div> | ||
223 | |||
224 | |||
225 | </body> | ||
226 | </html> | ||