aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html
diff options
context:
space:
mode:
authorDavid Walter Seikel2016-03-28 22:28:34 +1000
committerDavid Walter Seikel2016-03-28 22:28:34 +1000
commit7028cbe09c688437910a25623098762bf0fa592d (patch)
tree10b5af58277d9880380c2251f109325542c4e6eb /src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html
parentMove lemon to the src/others directory. (diff)
downloadSledjHamr-7028cbe09c688437910a25623098762bf0fa592d.zip
SledjHamr-7028cbe09c688437910a25623098762bf0fa592d.tar.gz
SledjHamr-7028cbe09c688437910a25623098762bf0fa592d.tar.bz2
SledjHamr-7028cbe09c688437910a25623098762bf0fa592d.tar.xz
Move Irrlicht to src/others.
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html308
1 files changed, 308 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html
new file mode 100644
index 0000000..12e92f1
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_video_mode_list.html
@@ -0,0 +1,308 @@
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::IVideoModeList 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">
69var 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_video_mode_list.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::IVideoModeList Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::video::IVideoModeList" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>A list of all available video modes.
95 <a href="classirr_1_1video_1_1_i_video_mode_list.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_video_mode_list_8h_source.html">IVideoModeList.h</a>&gt;</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::IVideoModeList:</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_video_mode_list.png" usemap="#irr::video::IVideoModeList_map" alt=""/>
105 <map id="irr::video::IVideoModeList_map" name="irr::video::IVideoModeList_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,155,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1video_1_1_i_video_mode_list-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html#a15869ac6919f6f29d2a25fcf13b6dd45">getDesktopDepth</a> () const =0
115<dl class="el"><dd class="mdescRight">Get the pixel depth of a video mode in bits. <a href="#a15869ac6919f6f29d2a25fcf13b6dd45"></a><br/></dl><li>virtual const <br class="typebreak"/>
116<a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; &amp; <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html#ade99f99922307c1d539bdd35834361fa">getDesktopResolution</a> () const =0
117<dl class="el"><dd class="mdescRight">Get current desktop screen resolution. <a href="#ade99f99922307c1d539bdd35834361fa"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html#a84326f1c6faa1cbbb6f90bdac66714dd">getVideoModeCount</a> () const =0
118<dl class="el"><dd class="mdescRight">Gets amount of video modes in the list. <a href="#a84326f1c6faa1cbbb6f90bdac66714dd"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html#ae3f4b101eacbebe78d6a2e1a3f2e713d">getVideoModeDepth</a> (<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> modeNumber) const =0
119<dl class="el"><dd class="mdescRight">Get the pixel depth of a video mode in bits. <a href="#ae3f4b101eacbebe78d6a2e1a3f2e713d"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html#af8409c756780c3566c94596cf7f94fc3">getVideoModeResolution</a> (<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> modeNumber) const =0
120<dl class="el"><dd class="mdescRight">Get the screen size of a video mode in pixels. <a href="#af8409c756780c3566c94596cf7f94fc3"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html#aa06b5905ac9c04fb38a17bf798fccc9b">getVideoModeResolution</a> (const <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; &amp;minSize, const <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; &amp;maxSize) const =0
121<dl class="el"><dd class="mdescRight">Get a supported screen size with certain constraints. <a href="#aa06b5905ac9c04fb38a17bf798fccc9b"></a><br/></dl></ul>
122<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
123<div class="textblock"><p>A list of all available video modes. </p>
124<p>You can get a list via <a class="el" href="classirr_1_1_irrlicht_device.html#a8872867a5ad728a4673679e9e8f469e7" title="Gets a list with all video modes available.">IrrlichtDevice::getVideoModeList()</a>. If you are confused now, because you think you have to create an Irrlicht Device with a video mode before being able to get the video mode list, let me tell you that there is no need to start up an Irrlicht Device with EDT_DIRECT3D8, EDT_OPENGL or EDT_SOFTWARE: For this (and for lots of other reasons) the null device, EDT_NULL exists. </p>
125
126<p>Definition at line <a class="el" href="_i_video_mode_list_8h_source.html#l00023">23</a> of file <a class="el" href="_i_video_mode_list_8h_source.html">IVideoModeList.h</a>.</p>
127</div><hr/><h2>Member Function Documentation</h2>
128<a class="anchor" id="a15869ac6919f6f29d2a25fcf13b6dd45"></a><!-- doxytag: member="irr::video::IVideoModeList::getDesktopDepth" ref="a15869ac6919f6f29d2a25fcf13b6dd45" args="() const =0" -->
129<div class="memitem">
130<div class="memproto">
131 <table class="memname">
132 <tr>
133 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::video::IVideoModeList::getDesktopDepth </td>
134 <td>(</td>
135 <td class="paramname"></td><td>)</td>
136 <td> const<code> [pure virtual]</code></td>
137 </tr>
138 </table>
139</div>
140<div class="memdoc">
141
142<p>Get the pixel depth of a video mode in bits. </p>
143<dl class="return"><dt><b>Returns:</b></dt><dd>Size of each pixel of the current desktop video mode in bits. </dd></dl>
144
145</div>
146</div>
147<a class="anchor" id="ade99f99922307c1d539bdd35834361fa"></a><!-- doxytag: member="irr::video::IVideoModeList::getDesktopResolution" ref="ade99f99922307c1d539bdd35834361fa" args="() const =0" -->
148<div class="memitem">
149<div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname">virtual const <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt;<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&gt;&amp; irr::video::IVideoModeList::getDesktopResolution </td>
153 <td>(</td>
154 <td class="paramname"></td><td>)</td>
155 <td> const<code> [pure virtual]</code></td>
156 </tr>
157 </table>
158</div>
159<div class="memdoc">
160
161<p>Get current desktop screen resolution. </p>
162<dl class="return"><dt><b>Returns:</b></dt><dd>Size of screen in pixels of the current desktop video mode. </dd></dl>
163
164</div>
165</div>
166<a class="anchor" id="a84326f1c6faa1cbbb6f90bdac66714dd"></a><!-- doxytag: member="irr::video::IVideoModeList::getVideoModeCount" ref="a84326f1c6faa1cbbb6f90bdac66714dd" args="() const =0" -->
167<div class="memitem">
168<div class="memproto">
169 <table class="memname">
170 <tr>
171 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::video::IVideoModeList::getVideoModeCount </td>
172 <td>(</td>
173 <td class="paramname"></td><td>)</td>
174 <td> const<code> [pure virtual]</code></td>
175 </tr>
176 </table>
177</div>
178<div class="memdoc">
179
180<p>Gets amount of video modes in the list. </p>
181<dl class="return"><dt><b>Returns:</b></dt><dd>Returns amount of video modes. </dd></dl>
182
183</div>
184</div>
185<a class="anchor" id="ae3f4b101eacbebe78d6a2e1a3f2e713d"></a><!-- doxytag: member="irr::video::IVideoModeList::getVideoModeDepth" ref="ae3f4b101eacbebe78d6a2e1a3f2e713d" args="(s32 modeNumber) const =0" -->
186<div class="memitem">
187<div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::video::IVideoModeList::getVideoModeDepth </td>
191 <td>(</td>
192 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
193 <td class="paramname"><em>modeNumber</em></td><td>)</td>
194 <td> const<code> [pure virtual]</code></td>
195 </tr>
196 </table>
197</div>
198<div class="memdoc">
199
200<p>Get the pixel depth of a video mode in bits. </p>
201<dl><dt><b>Parameters:</b></dt><dd>
202 <table class="params">
203 <tr><td class="paramname">modeNumber,:</td><td>zero based index of the video mode. </td></tr>
204 </table>
205 </dd>
206</dl>
207<dl class="return"><dt><b>Returns:</b></dt><dd>Size of each pixel of the specified video mode in bits. </dd></dl>
208
209</div>
210</div>
211<a class="anchor" id="af8409c756780c3566c94596cf7f94fc3"></a><!-- doxytag: member="irr::video::IVideoModeList::getVideoModeResolution" ref="af8409c756780c3566c94596cf7f94fc3" args="(s32 modeNumber) const =0" -->
212<div class="memitem">
213<div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">virtual <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt;<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&gt; irr::video::IVideoModeList::getVideoModeResolution </td>
217 <td>(</td>
218 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
219 <td class="paramname"><em>modeNumber</em></td><td>)</td>
220 <td> const<code> [pure virtual]</code></td>
221 </tr>
222 </table>
223</div>
224<div class="memdoc">
225
226<p>Get the screen size of a video mode in pixels. </p>
227<dl><dt><b>Parameters:</b></dt><dd>
228 <table class="params">
229 <tr><td class="paramname">modeNumber,:</td><td>zero based index of the video mode. </td></tr>
230 </table>
231 </dd>
232</dl>
233<dl class="return"><dt><b>Returns:</b></dt><dd>Size of screen in pixels of the specified video mode. </dd></dl>
234
235</div>
236</div>
237<a class="anchor" id="aa06b5905ac9c04fb38a17bf798fccc9b"></a><!-- doxytag: member="irr::video::IVideoModeList::getVideoModeResolution" ref="aa06b5905ac9c04fb38a17bf798fccc9b" args="(const core::dimension2d&lt; u32 &gt; &amp;minSize, const core::dimension2d&lt; u32 &gt; &amp;maxSize) const =0" -->
238<div class="memitem">
239<div class="memproto">
240 <table class="memname">
241 <tr>
242 <td class="memname">virtual <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt;<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&gt; irr::video::IVideoModeList::getVideoModeResolution </td>
243 <td>(</td>
244 <td class="paramtype">const <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; &amp;&#160;</td>
245 <td class="paramname"><em>minSize</em>, </td>
246 </tr>
247 <tr>
248 <td class="paramkey"></td>
249 <td></td>
250 <td class="paramtype">const <a class="el" href="classirr_1_1core_1_1dimension2d.html">core::dimension2d</a>&lt; <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> &gt; &amp;&#160;</td>
251 <td class="paramname"><em>maxSize</em>&#160;</td>
252 </tr>
253 <tr>
254 <td></td>
255 <td>)</td>
256 <td></td><td> const<code> [pure virtual]</code></td>
257 </tr>
258 </table>
259</div>
260<div class="memdoc">
261
262<p>Get a supported screen size with certain constraints. </p>
263<dl><dt><b>Parameters:</b></dt><dd>
264 <table class="params">
265 <tr><td class="paramname">minSize,:</td><td>Minimum dimensions required. </td></tr>
266 <tr><td class="paramname">maxSize,:</td><td>Maximum dimensions allowed. </td></tr>
267 </table>
268 </dd>
269</dl>
270<dl class="return"><dt><b>Returns:</b></dt><dd>Size of screen in pixels which matches the requirements. as good as possible. </dd></dl>
271
272</div>
273</div>
274<hr/>The documentation for this class was generated from the following file:<ul>
275<li><a class="el" href="_i_video_mode_list_8h_source.html">IVideoModeList.h</a></li>
276</ul>
277</div>
278</div>
279 <div id="nav-path" class="navpath">
280 <ul>
281 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
282 <li class="navelem"><a class="el" href="namespaceirr_1_1video.html">video</a> </li>
283 <li class="navelem"><a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html">IVideoModeList</a> </li>
284<!-- window showing the filter options -->
285<div id="MSearchSelectWindow"
286 onmouseover="return searchBox.OnSearchSelectShow()"
287 onmouseout="return searchBox.OnSearchSelectHide()"
288 onkeydown="return searchBox.OnSearchSelectKey(event)">
289<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
290
291<!-- iframe showing the search results (closed by default) -->
292<div id="MSearchResultsWindow">
293<iframe src="javascript:void(0)" frameborder="0"
294 name="MSearchResults" id="MSearchResults">
295</iframe>
296</div>
297
298
299 <li class="footer">
300<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
301Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:48 for Irrlicht 3D Engine by
302<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
303 </ul>
304 </div>
305
306
307</body>
308</html>
generated by cgit v1.1 at 2024-05-29 11:18:18 +0000