aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1_irrlicht_device.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1_irrlicht_device.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1_irrlicht_device.html1043
1 files changed, 1043 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1_irrlicht_device.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1_irrlicht_device.html
new file mode 100644
index 0000000..aaa4ee0
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1_irrlicht_device.html
@@ -0,0 +1,1043 @@
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::IrrlichtDevice 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_1_irrlicht_device.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> &#124;
89<a href="#pub-static-methods">Static Public Member Functions</a> </div>
90 <div class="headertitle">
91<div class="title">irr::IrrlichtDevice Class Reference</div> </div>
92</div>
93<div class="contents">
94<!-- doxytag: class="irr::IrrlichtDevice" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
95<p>The Irrlicht device. You can create it with <a class="el" href="namespaceirr.html#abaf4d8719cc26b0d30813abf85e47c76" title="Creates an Irrlicht device. The Irrlicht device is the root object for using the engine.">createDevice()</a> or <a class="el" href="namespaceirr.html#ac83a30d674204dcb94d70f849e9b4a62" title="Creates an Irrlicht device with the option to specify advanced parameters.">createDeviceEx()</a>.
96 <a href="classirr_1_1_irrlicht_device.html#details">More...</a></p>
97
98<p><code>#include &lt;<a class="el" href="_irrlicht_device_8h_source.html">IrrlichtDevice.h</a>&gt;</code></p>
99<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
100 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::IrrlichtDevice:</div>
101<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
102</div>
103<div id="dynsection-0-content" class="dyncontent" style="display:none;">
104 <div class="center">
105 <img src="classirr_1_1_irrlicht_device.png" usemap="#irr::IrrlichtDevice_map" alt=""/>
106 <map id="irr::IrrlichtDevice_map" name="irr::IrrlichtDevice_map">
107<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"/>
108</map>
109 </div></div>
110
111<p><a href="classirr_1_1_irrlicht_device-members.html">List of all members.</a></p>
112<h2><a name="pub-methods"></a>
113Public Member Functions</h2>
114<ul>
115<li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#af06f8d2c4fdffd1f879e46685bcbc6e3">activateJoysticks</a> (<a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="structirr_1_1_s_joystick_info.html">SJoystickInfo</a> &gt; &amp;joystickInfo)=0
116<dl class="el"><dd class="mdescRight">Activate any joysticks, and generate events for them. <a href="#af06f8d2c4fdffd1f879e46685bcbc6e3"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#aa10c6151a267d8a1500d5dc7b44425dd">clearSystemMessages</a> ()=0
117<dl class="el"><dd class="mdescRight">Remove messages pending in the system message loop. <a href="#aa10c6151a267d8a1500d5dc7b44425dd"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a08c97937e0f60f98d443b397a7c60e18">closeDevice</a> ()=0
118<dl class="el"><dd class="mdescRight">Notifies the device that it should close itself. <a href="#a08c97937e0f60f98d443b397a7c60e18"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1_i_randomizer.html">IRandomizer</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a267b069ea2c5f5b008fd7afa5b931ee9">createDefaultRandomizer</a> () const =0
119<dl class="el"><dd class="mdescRight">Creates a new default randomizer. <a href="#a267b069ea2c5f5b008fd7afa5b931ee9"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1video.html#a1d5e487888c32b1674a8f75116d829ed">video::ECOLOR_FORMAT</a> <a class="el" href="classirr_1_1_irrlicht_device.html#a9dccd3d7af7cfbabee46214a89bd6650">getColorFormat</a> () const =0
120<dl class="el"><dd class="mdescRight">Get the current color format of the window. <a href="#a9dccd3d7af7cfbabee46214a89bd6650"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html">gui::ICursorControl</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a500a3b7bf69487ff7e2075dd0b0db529">getCursorControl</a> ()=0
121<dl class="el"><dd class="mdescRight">Provides access to the cursor control. <a href="#a500a3b7bf69487ff7e2075dd0b0db529"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1_i_event_receiver.html">IEventReceiver</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a26227e20e46915942d067532c61df42b">getEventReceiver</a> ()=0
122<dl class="el"><dd class="mdescRight">Provides access to the current event receiver. <a href="#a26227e20e46915942d067532c61df42b"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_file_system.html">io::IFileSystem</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a3d8d2dee2f57aa7e6c0d14592de3e6ed">getFileSystem</a> ()=0
123<dl class="el"><dd class="mdescRight">Provides access to the virtual file system. <a href="#a3d8d2dee2f57aa7e6c0d14592de3e6ed"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#a30c4e1716271600a88e0ca07ca030f9b">getGammaRamp</a> (<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;red, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;green, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;blue, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;brightness, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;contrast)=0
124<dl class="el"><dd class="mdescRight">Get the current Gamma Value for the Display. <a href="#a30c4e1716271600a88e0ca07ca030f9b"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">gui::IGUIEnvironment</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#af7491b8c5ef4f71360f30fbad90ae35c">getGUIEnvironment</a> ()=0
125<dl class="el"><dd class="mdescRight">Provides access to the 2d user interface environment. <a href="#af7491b8c5ef4f71360f30fbad90ae35c"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1_i_logger.html">ILogger</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#adec0b0b6b71b5066dd2c7039f1f4d85b">getLogger</a> ()=0
126<dl class="el"><dd class="mdescRight">Provides access to the message logger. <a href="#adec0b0b6b71b5066dd2c7039f1f4d85b"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1_i_o_s_operator.html">IOSOperator</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a3833250e8b0d7a94cd34b1e1809033ac">getOSOperator</a> ()=0
127<dl class="el"><dd class="mdescRight">Provides access to the operation system operator object. <a href="#a3833250e8b0d7a94cd34b1e1809033ac"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1_i_randomizer.html">IRandomizer</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#aaba0cb18cac48e381d841ad763c7ea8b">getRandomizer</a> () const =0
128<dl class="el"><dd class="mdescRight">Provides access to the engine's currently set randomizer. <a href="#aaba0cb18cac48e381d841ad763c7ea8b"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html">scene::ISceneManager</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a891b503ff4d5041296d88f23f97d7b3d">getSceneManager</a> ()=0
129<dl class="el"><dd class="mdescRight">Provides access to the scene manager. <a href="#a891b503ff4d5041296d88f23f97d7b3d"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1_i_timer.html">ITimer</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a96c30fb7f644e1d1dabff563bde26460">getTimer</a> ()=0
130<dl class="el"><dd class="mdescRight">Provides access to the engine's timer. <a href="#a96c30fb7f644e1d1dabff563bde26460"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac25d94cf2e1037c7ca18ee79b3bd4505">E_DEVICE_TYPE</a> <a class="el" href="classirr_1_1_irrlicht_device.html#a2a2ec439b1f153169003c4d3e986a7d7">getType</a> () const =0
131<dl class="el"><dd class="mdescRight">Get the type of the device. <a href="#a2a2ec439b1f153169003c4d3e986a7d7"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a4eb5bc1b15f552ce2c37d792231392f7">getVersion</a> () const =0
132<dl class="el"><dd class="mdescRight">Get the version of the engine. <a href="#a4eb5bc1b15f552ce2c37d792231392f7"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_i_video_driver.html">video::IVideoDriver</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#ada90707ba5c645d47e000e4e0f87c4c4">getVideoDriver</a> ()=0
133<dl class="el"><dd class="mdescRight">Provides access to the video driver for drawing 3d and 2d geometry. <a href="#ada90707ba5c645d47e000e4e0f87c4c4"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html">video::IVideoModeList</a> * <a class="el" href="classirr_1_1_irrlicht_device.html#a8872867a5ad728a4673679e9e8f469e7">getVideoModeList</a> ()=0
134<dl class="el"><dd class="mdescRight">Gets a list with all video modes available. <a href="#a8872867a5ad728a4673679e9e8f469e7"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#a409df5e9b9b90635bd3c2db31978a5c1">isFullscreen</a> () const =0
135<dl class="el"><dd class="mdescRight">Checks if the Irrlicht window is running in fullscreen mode. <a href="#a409df5e9b9b90635bd3c2db31978a5c1"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#abd3c88336b739da2694883d5ffd25a70">isWindowActive</a> () const =0
136<dl class="el"><dd class="mdescRight">Returns if the window is active. <a href="#abd3c88336b739da2694883d5ffd25a70"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#a960069dc52b4f1303d18945dcbad7f3a">isWindowFocused</a> () const =0
137<dl class="el"><dd class="mdescRight">Checks if the Irrlicht window has focus. <a href="#a960069dc52b4f1303d18945dcbad7f3a"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#a69e96b9c49c65391e406377a92e795b1">isWindowMinimized</a> () const =0
138<dl class="el"><dd class="mdescRight">Checks if the Irrlicht window is minimized. <a href="#a69e96b9c49c65391e406377a92e795b1"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a24cb8ac97c16114ff7df1f0ec604a219">maximizeWindow</a> ()=0
139<dl class="el"><dd class="mdescRight">Maximizes the window if possible. <a href="#a24cb8ac97c16114ff7df1f0ec604a219"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a23e31ff31f564d5e715edc901e519311">minimizeWindow</a> ()=0
140<dl class="el"><dd class="mdescRight">Minimizes the window if possible. <a href="#a23e31ff31f564d5e715edc901e519311"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#abf859e39f017b0403c6ed331e48e01df">postEventFromUser</a> (const <a class="el" href="structirr_1_1_s_event.html">SEvent</a> &amp;event)=0
141<dl class="el"><dd class="mdescRight">Sends a user created event to the engine. <a href="#abf859e39f017b0403c6ed331e48e01df"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a4a92974b424cc612198505e31fe125d3">restoreWindow</a> ()=0
142<dl class="el"><dd class="mdescRight">Restore the window to normal size if possible. <a href="#a4a92974b424cc612198505e31fe125d3"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#a0489f8151dc43f6f41503ffb5a160b35">run</a> ()=0
143<dl class="el"><dd class="mdescRight">Runs the device. <a href="#a0489f8151dc43f6f41503ffb5a160b35"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#abf71a5ed6bb6b287e769f699010cedf0">setEventReceiver</a> (<a class="el" href="classirr_1_1_i_event_receiver.html">IEventReceiver</a> *receiver)=0
144<dl class="el"><dd class="mdescRight">Sets a new user event receiver which will receive events from the engine. <a href="#abf71a5ed6bb6b287e769f699010cedf0"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1_irrlicht_device.html#aaa6cec87ca0a18ec369ea12f7fbd490c">setGammaRamp</a> (<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> red, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> green, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> blue, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> relativebrightness, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> relativecontrast)=0
145<dl class="el"><dd class="mdescRight">Set the current Gamma Value for the Display. <a href="#aaa6cec87ca0a18ec369ea12f7fbd490c"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a22ab84f23050dbef122f16a33aa9b91d">setInputReceivingSceneManager</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html">scene::ISceneManager</a> *sceneManager)=0
146<dl class="el"><dd class="mdescRight">Sets the input receiving scene manager. <a href="#a22ab84f23050dbef122f16a33aa9b91d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#af996a8a8031dacd823e3c65ee3ed2c33">setRandomizer</a> (<a class="el" href="classirr_1_1_i_randomizer.html">IRandomizer</a> *r)=0
147<dl class="el"><dd class="mdescRight">Sets a new randomizer. <a href="#af996a8a8031dacd823e3c65ee3ed2c33"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a4911502bd085d2d87474ff12959bc341">setResizable</a> (bool resize=false)=0
148<dl class="el"><dd class="mdescRight">Sets if the window should be resizable in windowed mode. <a href="#a4911502bd085d2d87474ff12959bc341"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a3d7c98d520bf18ce1973c6f1439a7c0f">setWindowCaption</a> (const wchar_t *text)=0
149<dl class="el"><dd class="mdescRight">Sets the caption of the window. <a href="#a3d7c98d520bf18ce1973c6f1439a7c0f"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a89a3ecebc0e7c5ae08617b78a6e8a9f7">sleep</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> timeMs, bool pauseTimer=false)=0
150<dl class="el"><dd class="mdescRight">Pause execution and let other processes to run for a specified amount of time. <a href="#a89a3ecebc0e7c5ae08617b78a6e8a9f7"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1_irrlicht_device.html#a731727774fad9fc4c6c1c85277ca36dc">yield</a> ()=0
151<dl class="el"><dd class="mdescRight">Cause the device to temporarily pause execution and let other processes run. <a href="#a731727774fad9fc4c6c1c85277ca36dc"></a><br/></dl></ul>
152<h2><a name="pub-static-methods"></a>
153Static Public Member Functions</h2>
154<ul>
155<li>static bool <a class="el" href="classirr_1_1_irrlicht_device.html#a5a74995aec731b26c6a9cb5bea6842fe">isDriverSupported</a> (<a class="el" href="namespaceirr_1_1video.html#ae35a6de6d436c76107ad157fe42356d0">video::E_DRIVER_TYPE</a> driver)
156<dl class="el"><dd class="mdescRight">Check if a driver type is supported by the engine. <a href="#a5a74995aec731b26c6a9cb5bea6842fe"></a><br/></dl></ul>
157<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
158<div class="textblock"><p>The Irrlicht device. You can create it with <a class="el" href="namespaceirr.html#abaf4d8719cc26b0d30813abf85e47c76" title="Creates an Irrlicht device. The Irrlicht device is the root object for using the engine.">createDevice()</a> or <a class="el" href="namespaceirr.html#ac83a30d674204dcb94d70f849e9b4a62" title="Creates an Irrlicht device with the option to specify advanced parameters.">createDeviceEx()</a>. </p>
159<p>This is the most important class of the Irrlicht Engine. You can access everything in the engine if you have a pointer to an instance of this class. There should be only one instance of this class at any time. </p>
160
161<p>Definition at line <a class="el" href="_irrlicht_device_8h_source.html#l00043">43</a> of file <a class="el" href="_irrlicht_device_8h_source.html">IrrlichtDevice.h</a>.</p>
162</div><hr/><h2>Member Function Documentation</h2>
163<a class="anchor" id="af06f8d2c4fdffd1f879e46685bcbc6e3"></a><!-- doxytag: member="irr::IrrlichtDevice::activateJoysticks" ref="af06f8d2c4fdffd1f879e46685bcbc6e3" args="(core::array&lt; SJoystickInfo &gt; &amp;joystickInfo)=0" -->
164<div class="memitem">
165<div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">virtual bool irr::IrrlichtDevice::activateJoysticks </td>
169 <td>(</td>
170 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="structirr_1_1_s_joystick_info.html">SJoystickInfo</a> &gt; &amp;&#160;</td>
171 <td class="paramname"><em>joystickInfo</em></td><td>)</td>
172 <td><code> [pure virtual]</code></td>
173 </tr>
174 </table>
175</div>
176<div class="memdoc">
177
178<p>Activate any joysticks, and generate events for them. </p>
179<p>Irrlicht contains support for joysticks, but does not generate joystick events by default, as this would consume joystick info that 3rd party libraries might rely on. Call this method to activate joystick support in Irrlicht and to receive irr::SJoystickEvent events. </p>
180<dl><dt><b>Parameters:</b></dt><dd>
181 <table class="params">
182 <tr><td class="paramname">joystickInfo</td><td>On return, this will contain an array of each joystick that was found and activated. </td></tr>
183 </table>
184 </dd>
185</dl>
186<dl class="return"><dt><b>Returns:</b></dt><dd>true if joysticks are supported on this device and _IRR_COMPILE_WITH_JOYSTICK_EVENTS_ is defined, false if joysticks are not supported or support is compiled out. </dd></dl>
187
188</div>
189</div>
190<a class="anchor" id="aa10c6151a267d8a1500d5dc7b44425dd"></a><!-- doxytag: member="irr::IrrlichtDevice::clearSystemMessages" ref="aa10c6151a267d8a1500d5dc7b44425dd" args="()=0" -->
191<div class="memitem">
192<div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname">virtual void irr::IrrlichtDevice::clearSystemMessages </td>
196 <td>(</td>
197 <td class="paramname"></td><td>)</td>
198 <td><code> [pure virtual]</code></td>
199 </tr>
200 </table>
201</div>
202<div class="memdoc">
203
204<p>Remove messages pending in the system message loop. </p>
205<p>This function is usually used after messages have been buffered for a longer time, for example when loading a large scene. Clearing the message loop prevents that mouse- or buttonclicks which users have pressed in the meantime will now trigger unexpected actions in the gui. <br/>
206 So far the following messages are cleared:<br/>
207 Win32: All keyboard and mouse messages<br/>
208 Linux: All keyboard and mouse messages<br/>
209 All other devices are not yet supported here.<br/>
210 The function is still somewhat experimental, as the kind of messages we clear is based on just a few use-cases. If you think further messages should be cleared, or some messages should not be cleared here, then please tell us. </p>
211
212</div>
213</div>
214<a class="anchor" id="a08c97937e0f60f98d443b397a7c60e18"></a><!-- doxytag: member="irr::IrrlichtDevice::closeDevice" ref="a08c97937e0f60f98d443b397a7c60e18" args="()=0" -->
215<div class="memitem">
216<div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">virtual void irr::IrrlichtDevice::closeDevice </td>
220 <td>(</td>
221 <td class="paramname"></td><td>)</td>
222 <td><code> [pure virtual]</code></td>
223 </tr>
224 </table>
225</div>
226<div class="memdoc">
227
228<p>Notifies the device that it should close itself. </p>
229<p><a class="el" href="classirr_1_1_irrlicht_device.html#a0489f8151dc43f6f41503ffb5a160b35" title="Runs the device.">IrrlichtDevice::run()</a> will always return false after <a class="el" href="classirr_1_1_irrlicht_device.html#a08c97937e0f60f98d443b397a7c60e18" title="Notifies the device that it should close itself.">closeDevice()</a> was called. </p>
230
231</div>
232</div>
233<a class="anchor" id="a267b069ea2c5f5b008fd7afa5b931ee9"></a><!-- doxytag: member="irr::IrrlichtDevice::createDefaultRandomizer" ref="a267b069ea2c5f5b008fd7afa5b931ee9" args="() const =0" -->
234<div class="memitem">
235<div class="memproto">
236 <table class="memname">
237 <tr>
238 <td class="memname">virtual <a class="el" href="classirr_1_1_i_randomizer.html">IRandomizer</a>* irr::IrrlichtDevice::createDefaultRandomizer </td>
239 <td>(</td>
240 <td class="paramname"></td><td>)</td>
241 <td> const<code> [pure virtual]</code></td>
242 </tr>
243 </table>
244</div>
245<div class="memdoc">
246
247<p>Creates a new default randomizer. </p>
248<p>The default randomizer provides the random sequence known from previous Irrlicht versions and is the initial randomizer set on device creation. </p>
249<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the default <a class="el" href="classirr_1_1_i_randomizer.html" title="Interface for generating random numbers.">IRandomizer</a> object. </dd></dl>
250
251</div>
252</div>
253<a class="anchor" id="a9dccd3d7af7cfbabee46214a89bd6650"></a><!-- doxytag: member="irr::IrrlichtDevice::getColorFormat" ref="a9dccd3d7af7cfbabee46214a89bd6650" args="() const =0" -->
254<div class="memitem">
255<div class="memproto">
256 <table class="memname">
257 <tr>
258 <td class="memname">virtual <a class="el" href="namespaceirr_1_1video.html#a1d5e487888c32b1674a8f75116d829ed">video::ECOLOR_FORMAT</a> irr::IrrlichtDevice::getColorFormat </td>
259 <td>(</td>
260 <td class="paramname"></td><td>)</td>
261 <td> const<code> [pure virtual]</code></td>
262 </tr>
263 </table>
264</div>
265<div class="memdoc">
266
267<p>Get the current color format of the window. </p>
268<dl class="return"><dt><b>Returns:</b></dt><dd>Color format of the window. </dd></dl>
269
270</div>
271</div>
272<a class="anchor" id="a500a3b7bf69487ff7e2075dd0b0db529"></a><!-- doxytag: member="irr::IrrlichtDevice::getCursorControl" ref="a500a3b7bf69487ff7e2075dd0b0db529" args="()=0" -->
273<div class="memitem">
274<div class="memproto">
275 <table class="memname">
276 <tr>
277 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html">gui::ICursorControl</a>* irr::IrrlichtDevice::getCursorControl </td>
278 <td>(</td>
279 <td class="paramname"></td><td>)</td>
280 <td><code> [pure virtual]</code></td>
281 </tr>
282 </table>
283</div>
284<div class="memdoc">
285
286<p>Provides access to the cursor control. </p>
287<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the mouse cursor control interface. </dd></dl>
288
289</div>
290</div>
291<a class="anchor" id="a26227e20e46915942d067532c61df42b"></a><!-- doxytag: member="irr::IrrlichtDevice::getEventReceiver" ref="a26227e20e46915942d067532c61df42b" args="()=0" -->
292<div class="memitem">
293<div class="memproto">
294 <table class="memname">
295 <tr>
296 <td class="memname">virtual <a class="el" href="classirr_1_1_i_event_receiver.html">IEventReceiver</a>* irr::IrrlichtDevice::getEventReceiver </td>
297 <td>(</td>
298 <td class="paramname"></td><td>)</td>
299 <td><code> [pure virtual]</code></td>
300 </tr>
301 </table>
302</div>
303<div class="memdoc">
304
305<p>Provides access to the current event receiver. </p>
306<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the current event receiver. Returns 0 if there is none. </dd></dl>
307
308</div>
309</div>
310<a class="anchor" id="a3d8d2dee2f57aa7e6c0d14592de3e6ed"></a><!-- doxytag: member="irr::IrrlichtDevice::getFileSystem" ref="a3d8d2dee2f57aa7e6c0d14592de3e6ed" args="()=0" -->
311<div class="memitem">
312<div class="memproto">
313 <table class="memname">
314 <tr>
315 <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_file_system.html">io::IFileSystem</a>* irr::IrrlichtDevice::getFileSystem </td>
316 <td>(</td>
317 <td class="paramname"></td><td>)</td>
318 <td><code> [pure virtual]</code></td>
319 </tr>
320 </table>
321</div>
322<div class="memdoc">
323
324<p>Provides access to the virtual file system. </p>
325<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the file system. </dd></dl>
326
327</div>
328</div>
329<a class="anchor" id="a30c4e1716271600a88e0ca07ca030f9b"></a><!-- doxytag: member="irr::IrrlichtDevice::getGammaRamp" ref="a30c4e1716271600a88e0ca07ca030f9b" args="(f32 &amp;red, f32 &amp;green, f32 &amp;blue, f32 &amp;brightness, f32 &amp;contrast)=0" -->
330<div class="memitem">
331<div class="memproto">
332 <table class="memname">
333 <tr>
334 <td class="memname">virtual bool irr::IrrlichtDevice::getGammaRamp </td>
335 <td>(</td>
336 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;&#160;</td>
337 <td class="paramname"><em>red</em>, </td>
338 </tr>
339 <tr>
340 <td class="paramkey"></td>
341 <td></td>
342 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;&#160;</td>
343 <td class="paramname"><em>green</em>, </td>
344 </tr>
345 <tr>
346 <td class="paramkey"></td>
347 <td></td>
348 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;&#160;</td>
349 <td class="paramname"><em>blue</em>, </td>
350 </tr>
351 <tr>
352 <td class="paramkey"></td>
353 <td></td>
354 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;&#160;</td>
355 <td class="paramname"><em>brightness</em>, </td>
356 </tr>
357 <tr>
358 <td class="paramkey"></td>
359 <td></td>
360 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &amp;&#160;</td>
361 <td class="paramname"><em>contrast</em>&#160;</td>
362 </tr>
363 <tr>
364 <td></td>
365 <td>)</td>
366 <td></td><td><code> [pure virtual]</code></td>
367 </tr>
368 </table>
369</div>
370<div class="memdoc">
371
372<p>Get the current Gamma Value for the Display. </p>
373
374</div>
375</div>
376<a class="anchor" id="af7491b8c5ef4f71360f30fbad90ae35c"></a><!-- doxytag: member="irr::IrrlichtDevice::getGUIEnvironment" ref="af7491b8c5ef4f71360f30fbad90ae35c" args="()=0" -->
377<div class="memitem">
378<div class="memproto">
379 <table class="memname">
380 <tr>
381 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">gui::IGUIEnvironment</a>* irr::IrrlichtDevice::getGUIEnvironment </td>
382 <td>(</td>
383 <td class="paramname"></td><td>)</td>
384 <td><code> [pure virtual]</code></td>
385 </tr>
386 </table>
387</div>
388<div class="memdoc">
389
390<p>Provides access to the 2d user interface environment. </p>
391<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the gui environment. </dd></dl>
392
393</div>
394</div>
395<a class="anchor" id="adec0b0b6b71b5066dd2c7039f1f4d85b"></a><!-- doxytag: member="irr::IrrlichtDevice::getLogger" ref="adec0b0b6b71b5066dd2c7039f1f4d85b" args="()=0" -->
396<div class="memitem">
397<div class="memproto">
398 <table class="memname">
399 <tr>
400 <td class="memname">virtual <a class="el" href="classirr_1_1_i_logger.html">ILogger</a>* irr::IrrlichtDevice::getLogger </td>
401 <td>(</td>
402 <td class="paramname"></td><td>)</td>
403 <td><code> [pure virtual]</code></td>
404 </tr>
405 </table>
406</div>
407<div class="memdoc">
408
409<p>Provides access to the message logger. </p>
410<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the logger. </dd></dl>
411
412</div>
413</div>
414<a class="anchor" id="a3833250e8b0d7a94cd34b1e1809033ac"></a><!-- doxytag: member="irr::IrrlichtDevice::getOSOperator" ref="a3833250e8b0d7a94cd34b1e1809033ac" args="()=0" -->
415<div class="memitem">
416<div class="memproto">
417 <table class="memname">
418 <tr>
419 <td class="memname">virtual <a class="el" href="classirr_1_1_i_o_s_operator.html">IOSOperator</a>* irr::IrrlichtDevice::getOSOperator </td>
420 <td>(</td>
421 <td class="paramname"></td><td>)</td>
422 <td><code> [pure virtual]</code></td>
423 </tr>
424 </table>
425</div>
426<div class="memdoc">
427
428<p>Provides access to the operation system operator object. </p>
429<p>The OS operator provides methods for getting system specific informations and doing system specific operations, such as exchanging data with the clipboard or reading the operation system version. </p>
430<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the OS operator. </dd></dl>
431
432</div>
433</div>
434<a class="anchor" id="aaba0cb18cac48e381d841ad763c7ea8b"></a><!-- doxytag: member="irr::IrrlichtDevice::getRandomizer" ref="aaba0cb18cac48e381d841ad763c7ea8b" args="() const =0" -->
435<div class="memitem">
436<div class="memproto">
437 <table class="memname">
438 <tr>
439 <td class="memname">virtual <a class="el" href="classirr_1_1_i_randomizer.html">IRandomizer</a>* irr::IrrlichtDevice::getRandomizer </td>
440 <td>(</td>
441 <td class="paramname"></td><td>)</td>
442 <td> const<code> [pure virtual]</code></td>
443 </tr>
444 </table>
445</div>
446<div class="memdoc">
447
448<p>Provides access to the engine's currently set randomizer. </p>
449<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classirr_1_1_i_randomizer.html" title="Interface for generating random numbers.">IRandomizer</a> object. </dd></dl>
450
451</div>
452</div>
453<a class="anchor" id="a891b503ff4d5041296d88f23f97d7b3d"></a><!-- doxytag: member="irr::IrrlichtDevice::getSceneManager" ref="a891b503ff4d5041296d88f23f97d7b3d" args="()=0" -->
454<div class="memitem">
455<div class="memproto">
456 <table class="memname">
457 <tr>
458 <td class="memname">virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html">scene::ISceneManager</a>* irr::IrrlichtDevice::getSceneManager </td>
459 <td>(</td>
460 <td class="paramname"></td><td>)</td>
461 <td><code> [pure virtual]</code></td>
462 </tr>
463 </table>
464</div>
465<div class="memdoc">
466
467<p>Provides access to the scene manager. </p>
468<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the scene manager. </dd></dl>
469
470</div>
471</div>
472<a class="anchor" id="a96c30fb7f644e1d1dabff563bde26460"></a><!-- doxytag: member="irr::IrrlichtDevice::getTimer" ref="a96c30fb7f644e1d1dabff563bde26460" args="()=0" -->
473<div class="memitem">
474<div class="memproto">
475 <table class="memname">
476 <tr>
477 <td class="memname">virtual <a class="el" href="classirr_1_1_i_timer.html">ITimer</a>* irr::IrrlichtDevice::getTimer </td>
478 <td>(</td>
479 <td class="paramname"></td><td>)</td>
480 <td><code> [pure virtual]</code></td>
481 </tr>
482 </table>
483</div>
484<div class="memdoc">
485
486<p>Provides access to the engine's timer. </p>
487<p>The system time can be retrieved by it as well as the virtual time, which also can be manipulated. </p>
488<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classirr_1_1_i_timer.html" title="Interface for getting and manipulating the virtual time.">ITimer</a> object. </dd></dl>
489
490</div>
491</div>
492<a class="anchor" id="a2a2ec439b1f153169003c4d3e986a7d7"></a><!-- doxytag: member="irr::IrrlichtDevice::getType" ref="a2a2ec439b1f153169003c4d3e986a7d7" args="() const =0" -->
493<div class="memitem">
494<div class="memproto">
495 <table class="memname">
496 <tr>
497 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac25d94cf2e1037c7ca18ee79b3bd4505">E_DEVICE_TYPE</a> irr::IrrlichtDevice::getType </td>
498 <td>(</td>
499 <td class="paramname"></td><td>)</td>
500 <td> const<code> [pure virtual]</code></td>
501 </tr>
502 </table>
503</div>
504<div class="memdoc">
505
506<p>Get the type of the device. </p>
507<p>This allows the user to check which windowing system is currently being used. </p>
508
509</div>
510</div>
511<a class="anchor" id="a4eb5bc1b15f552ce2c37d792231392f7"></a><!-- doxytag: member="irr::IrrlichtDevice::getVersion" ref="a4eb5bc1b15f552ce2c37d792231392f7" args="() const =0" -->
512<div class="memitem">
513<div class="memproto">
514 <table class="memname">
515 <tr>
516 <td class="memname">virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a>* irr::IrrlichtDevice::getVersion </td>
517 <td>(</td>
518 <td class="paramname"></td><td>)</td>
519 <td> const<code> [pure virtual]</code></td>
520 </tr>
521 </table>
522</div>
523<div class="memdoc">
524
525<p>Get the version of the engine. </p>
526<p>The returned string will look like this: "1.2.3" or this: "1.2". </p>
527<dl class="return"><dt><b>Returns:</b></dt><dd>String which contains the version. </dd></dl>
528
529</div>
530</div>
531<a class="anchor" id="ada90707ba5c645d47e000e4e0f87c4c4"></a><!-- doxytag: member="irr::IrrlichtDevice::getVideoDriver" ref="ada90707ba5c645d47e000e4e0f87c4c4" args="()=0" -->
532<div class="memitem">
533<div class="memproto">
534 <table class="memname">
535 <tr>
536 <td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_i_video_driver.html">video::IVideoDriver</a>* irr::IrrlichtDevice::getVideoDriver </td>
537 <td>(</td>
538 <td class="paramname"></td><td>)</td>
539 <td><code> [pure virtual]</code></td>
540 </tr>
541 </table>
542</div>
543<div class="memdoc">
544
545<p>Provides access to the video driver for drawing 3d and 2d geometry. </p>
546<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer the video driver. </dd></dl>
547
548</div>
549</div>
550<a class="anchor" id="a8872867a5ad728a4673679e9e8f469e7"></a><!-- doxytag: member="irr::IrrlichtDevice::getVideoModeList" ref="a8872867a5ad728a4673679e9e8f469e7" args="()=0" -->
551<div class="memitem">
552<div class="memproto">
553 <table class="memname">
554 <tr>
555 <td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_i_video_mode_list.html">video::IVideoModeList</a>* irr::IrrlichtDevice::getVideoModeList </td>
556 <td>(</td>
557 <td class="paramname"></td><td>)</td>
558 <td><code> [pure virtual]</code></td>
559 </tr>
560 </table>
561</div>
562<div class="memdoc">
563
564<p>Gets a list with all video modes available. </p>
565<p>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 driver, EDT_NULL exists. </p>
566<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a list with all video modes supported by the gfx adapter. </dd></dl>
567
568</div>
569</div>
570<a class="anchor" id="a5a74995aec731b26c6a9cb5bea6842fe"></a><!-- doxytag: member="irr::IrrlichtDevice::isDriverSupported" ref="a5a74995aec731b26c6a9cb5bea6842fe" args="(video::E_DRIVER_TYPE driver)" -->
571<div class="memitem">
572<div class="memproto">
573 <table class="memname">
574 <tr>
575 <td class="memname">static bool irr::IrrlichtDevice::isDriverSupported </td>
576 <td>(</td>
577 <td class="paramtype"><a class="el" href="namespaceirr_1_1video.html#ae35a6de6d436c76107ad157fe42356d0">video::E_DRIVER_TYPE</a>&#160;</td>
578 <td class="paramname"><em>driver</em></td><td>)</td>
579 <td><code> [inline, static]</code></td>
580 </tr>
581 </table>
582</div>
583<div class="memdoc">
584
585<p>Check if a driver type is supported by the engine. </p>
586<p>Even if true is returned the driver may not be available for a configuration requested when creating the device. </p>
587
588<p>Definition at line <a class="el" href="_irrlicht_device_8h_source.html#l00277">277</a> of file <a class="el" href="_irrlicht_device_8h_source.html">IrrlichtDevice.h</a>.</p>
589
590<p>References <a class="el" href="_e_driver_types_8h_source.html#l00038">irr::video::EDT_BURNINGSVIDEO</a>, <a class="el" href="_e_driver_types_8h_source.html#l00043">irr::video::EDT_DIRECT3D8</a>, <a class="el" href="_e_driver_types_8h_source.html#l00048">irr::video::EDT_DIRECT3D9</a>, <a class="el" href="_e_driver_types_8h_source.html#l00019">irr::video::EDT_NULL</a>, <a class="el" href="_e_driver_types_8h_source.html#l00053">irr::video::EDT_OPENGL</a>, and <a class="el" href="_e_driver_types_8h_source.html#l00026">irr::video::EDT_SOFTWARE</a>.</p>
591
592</div>
593</div>
594<a class="anchor" id="a409df5e9b9b90635bd3c2db31978a5c1"></a><!-- doxytag: member="irr::IrrlichtDevice::isFullscreen" ref="a409df5e9b9b90635bd3c2db31978a5c1" args="() const =0" -->
595<div class="memitem">
596<div class="memproto">
597 <table class="memname">
598 <tr>
599 <td class="memname">virtual bool irr::IrrlichtDevice::isFullscreen </td>
600 <td>(</td>
601 <td class="paramname"></td><td>)</td>
602 <td> const<code> [pure virtual]</code></td>
603 </tr>
604 </table>
605</div>
606<div class="memdoc">
607
608<p>Checks if the Irrlicht window is running in fullscreen mode. </p>
609<dl class="return"><dt><b>Returns:</b></dt><dd>True if window is fullscreen. </dd></dl>
610
611</div>
612</div>
613<a class="anchor" id="abd3c88336b739da2694883d5ffd25a70"></a><!-- doxytag: member="irr::IrrlichtDevice::isWindowActive" ref="abd3c88336b739da2694883d5ffd25a70" args="() const =0" -->
614<div class="memitem">
615<div class="memproto">
616 <table class="memname">
617 <tr>
618 <td class="memname">virtual bool irr::IrrlichtDevice::isWindowActive </td>
619 <td>(</td>
620 <td class="paramname"></td><td>)</td>
621 <td> const<code> [pure virtual]</code></td>
622 </tr>
623 </table>
624</div>
625<div class="memdoc">
626
627<p>Returns if the window is active. </p>
628<p>If the window is inactive, nothing needs to be drawn. So if you don't want to draw anything when the window is inactive, create your drawing loop this way: </p>
629<div class="fragment"><pre class="fragment"> <span class="keywordflow">while</span>(device-&gt;run())
630 {
631 <span class="keywordflow">if</span> (device-&gt;isWindowActive())
632 {
633 <span class="comment">// draw everything here</span>
634 }
635 <span class="keywordflow">else</span>
636 device-&gt;yield();
637 }
638</pre></div> <dl class="return"><dt><b>Returns:</b></dt><dd>True if window is active. </dd></dl>
639
640</div>
641</div>
642<a class="anchor" id="a960069dc52b4f1303d18945dcbad7f3a"></a><!-- doxytag: member="irr::IrrlichtDevice::isWindowFocused" ref="a960069dc52b4f1303d18945dcbad7f3a" args="() const =0" -->
643<div class="memitem">
644<div class="memproto">
645 <table class="memname">
646 <tr>
647 <td class="memname">virtual bool irr::IrrlichtDevice::isWindowFocused </td>
648 <td>(</td>
649 <td class="paramname"></td><td>)</td>
650 <td> const<code> [pure virtual]</code></td>
651 </tr>
652 </table>
653</div>
654<div class="memdoc">
655
656<p>Checks if the Irrlicht window has focus. </p>
657<dl class="return"><dt><b>Returns:</b></dt><dd>True if window has focus. </dd></dl>
658
659</div>
660</div>
661<a class="anchor" id="a69e96b9c49c65391e406377a92e795b1"></a><!-- doxytag: member="irr::IrrlichtDevice::isWindowMinimized" ref="a69e96b9c49c65391e406377a92e795b1" args="() const =0" -->
662<div class="memitem">
663<div class="memproto">
664 <table class="memname">
665 <tr>
666 <td class="memname">virtual bool irr::IrrlichtDevice::isWindowMinimized </td>
667 <td>(</td>
668 <td class="paramname"></td><td>)</td>
669 <td> const<code> [pure virtual]</code></td>
670 </tr>
671 </table>
672</div>
673<div class="memdoc">
674
675<p>Checks if the Irrlicht window is minimized. </p>
676<dl class="return"><dt><b>Returns:</b></dt><dd>True if window is minimized. </dd></dl>
677
678</div>
679</div>
680<a class="anchor" id="a24cb8ac97c16114ff7df1f0ec604a219"></a><!-- doxytag: member="irr::IrrlichtDevice::maximizeWindow" ref="a24cb8ac97c16114ff7df1f0ec604a219" args="()=0" -->
681<div class="memitem">
682<div class="memproto">
683 <table class="memname">
684 <tr>
685 <td class="memname">virtual void irr::IrrlichtDevice::maximizeWindow </td>
686 <td>(</td>
687 <td class="paramname"></td><td>)</td>
688 <td><code> [pure virtual]</code></td>
689 </tr>
690 </table>
691</div>
692<div class="memdoc">
693
694<p>Maximizes the window if possible. </p>
695
696</div>
697</div>
698<a class="anchor" id="a23e31ff31f564d5e715edc901e519311"></a><!-- doxytag: member="irr::IrrlichtDevice::minimizeWindow" ref="a23e31ff31f564d5e715edc901e519311" args="()=0" -->
699<div class="memitem">
700<div class="memproto">
701 <table class="memname">
702 <tr>
703 <td class="memname">virtual void irr::IrrlichtDevice::minimizeWindow </td>
704 <td>(</td>
705 <td class="paramname"></td><td>)</td>
706 <td><code> [pure virtual]</code></td>
707 </tr>
708 </table>
709</div>
710<div class="memdoc">
711
712<p>Minimizes the window if possible. </p>
713
714</div>
715</div>
716<a class="anchor" id="abf859e39f017b0403c6ed331e48e01df"></a><!-- doxytag: member="irr::IrrlichtDevice::postEventFromUser" ref="abf859e39f017b0403c6ed331e48e01df" args="(const SEvent &amp;event)=0" -->
717<div class="memitem">
718<div class="memproto">
719 <table class="memname">
720 <tr>
721 <td class="memname">virtual bool irr::IrrlichtDevice::postEventFromUser </td>
722 <td>(</td>
723 <td class="paramtype">const <a class="el" href="structirr_1_1_s_event.html">SEvent</a> &amp;&#160;</td>
724 <td class="paramname"><em>event</em></td><td>)</td>
725 <td><code> [pure virtual]</code></td>
726 </tr>
727 </table>
728</div>
729<div class="memdoc">
730
731<p>Sends a user created event to the engine. </p>
732<p>Is is usually not necessary to use this. However, if you are using an own input library for example for doing joystick input, you can use this to post key or mouse input events to the engine. Internally, this method only delegates the events further to the scene manager and the GUI environment. </p>
733
734</div>
735</div>
736<a class="anchor" id="a4a92974b424cc612198505e31fe125d3"></a><!-- doxytag: member="irr::IrrlichtDevice::restoreWindow" ref="a4a92974b424cc612198505e31fe125d3" args="()=0" -->
737<div class="memitem">
738<div class="memproto">
739 <table class="memname">
740 <tr>
741 <td class="memname">virtual void irr::IrrlichtDevice::restoreWindow </td>
742 <td>(</td>
743 <td class="paramname"></td><td>)</td>
744 <td><code> [pure virtual]</code></td>
745 </tr>
746 </table>
747</div>
748<div class="memdoc">
749
750<p>Restore the window to normal size if possible. </p>
751
752</div>
753</div>
754<a class="anchor" id="a0489f8151dc43f6f41503ffb5a160b35"></a><!-- doxytag: member="irr::IrrlichtDevice::run" ref="a0489f8151dc43f6f41503ffb5a160b35" args="()=0" -->
755<div class="memitem">
756<div class="memproto">
757 <table class="memname">
758 <tr>
759 <td class="memname">virtual bool irr::IrrlichtDevice::run </td>
760 <td>(</td>
761 <td class="paramname"></td><td>)</td>
762 <td><code> [pure virtual]</code></td>
763 </tr>
764 </table>
765</div>
766<div class="memdoc">
767
768<p>Runs the device. </p>
769<p>Also increments the virtual timer by calling <a class="el" href="classirr_1_1_i_timer.html#a50ee793711cace4410e1f9c9e1ce20c6" title="Advances the virtual time.">ITimer::tick()</a>;. You can prevent this by calling <a class="el" href="classirr_1_1_i_timer.html#a649e7294fafc6e6de00f9a4dc6894c16" title="Stops the virtual timer.">ITimer::stop()</a>; before and <a class="el" href="classirr_1_1_i_timer.html#a9467dc5a72de3869712715d0473c9697" title="Starts the virtual timer.">ITimer::start()</a> after calling <a class="el" href="classirr_1_1_irrlicht_device.html#a0489f8151dc43f6f41503ffb5a160b35" title="Runs the device.">IrrlichtDevice::run()</a>. Returns false if device wants to be deleted. Use it in this way: </p>
770<div class="fragment"><pre class="fragment"> <span class="keywordflow">while</span>(device-&gt;run())
771 {
772 <span class="comment">// draw everything here</span>
773 }
774</pre></div><p> If you want the device to do nothing if the window is inactive (recommended), use the slightly enhanced code shown at <a class="el" href="classirr_1_1_irrlicht_device.html#abd3c88336b739da2694883d5ffd25a70" title="Returns if the window is active.">isWindowActive()</a>.</p>
775<p>Note if you are running Irrlicht inside an external, custom created window: Calling Device-&gt;<a class="el" href="classirr_1_1_irrlicht_device.html#a0489f8151dc43f6f41503ffb5a160b35" title="Runs the device.">run()</a> will cause Irrlicht to dispatch windows messages internally. If you are running Irrlicht in your own custom window, you can also simply use your own message loop using GetMessage, DispatchMessage and whatever and simply don't use this method. But note that Irrlicht will not be able to fetch user input then. See <a class="el" href="structirr_1_1_s_irrlicht_creation_parameters.html#af287810d910a23f8f7db98cef87b6eae" title="Window Id.">irr::SIrrlichtCreationParameters::WindowId</a> for more informations and example code. </p>
776
777</div>
778</div>
779<a class="anchor" id="abf71a5ed6bb6b287e769f699010cedf0"></a><!-- doxytag: member="irr::IrrlichtDevice::setEventReceiver" ref="abf71a5ed6bb6b287e769f699010cedf0" args="(IEventReceiver *receiver)=0" -->
780<div class="memitem">
781<div class="memproto">
782 <table class="memname">
783 <tr>
784 <td class="memname">virtual void irr::IrrlichtDevice::setEventReceiver </td>
785 <td>(</td>
786 <td class="paramtype"><a class="el" href="classirr_1_1_i_event_receiver.html">IEventReceiver</a> *&#160;</td>
787 <td class="paramname"><em>receiver</em></td><td>)</td>
788 <td><code> [pure virtual]</code></td>
789 </tr>
790 </table>
791</div>
792<div class="memdoc">
793
794<p>Sets a new user event receiver which will receive events from the engine. </p>
795<p>Return true in <a class="el" href="classirr_1_1_i_event_receiver.html#a571f744ceffc3b4fe8a81f529163eb97" title="Called if an event happened.">IEventReceiver::OnEvent</a> to prevent the event from continuing along the chain of event receivers. The path that an event takes through the system depends on its type. See <a class="el" href="namespaceirr.html#ac9eed96e06e85ce3c86fcbbbe9e48a0c" title="Enumeration for all event types there are.">irr::EEVENT_TYPE</a> for details. </p>
796<dl><dt><b>Parameters:</b></dt><dd>
797 <table class="params">
798 <tr><td class="paramname">receiver</td><td>New receiver to be used. </td></tr>
799 </table>
800 </dd>
801</dl>
802
803</div>
804</div>
805<a class="anchor" id="aaa6cec87ca0a18ec369ea12f7fbd490c"></a><!-- doxytag: member="irr::IrrlichtDevice::setGammaRamp" ref="aaa6cec87ca0a18ec369ea12f7fbd490c" args="(f32 red, f32 green, f32 blue, f32 relativebrightness, f32 relativecontrast)=0" -->
806<div class="memitem">
807<div class="memproto">
808 <table class="memname">
809 <tr>
810 <td class="memname">virtual bool irr::IrrlichtDevice::setGammaRamp </td>
811 <td>(</td>
812 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
813 <td class="paramname"><em>red</em>, </td>
814 </tr>
815 <tr>
816 <td class="paramkey"></td>
817 <td></td>
818 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
819 <td class="paramname"><em>green</em>, </td>
820 </tr>
821 <tr>
822 <td class="paramkey"></td>
823 <td></td>
824 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
825 <td class="paramname"><em>blue</em>, </td>
826 </tr>
827 <tr>
828 <td class="paramkey"></td>
829 <td></td>
830 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
831 <td class="paramname"><em>relativebrightness</em>, </td>
832 </tr>
833 <tr>
834 <td class="paramkey"></td>
835 <td></td>
836 <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
837 <td class="paramname"><em>relativecontrast</em>&#160;</td>
838 </tr>
839 <tr>
840 <td></td>
841 <td>)</td>
842 <td></td><td><code> [pure virtual]</code></td>
843 </tr>
844 </table>
845</div>
846<div class="memdoc">
847
848<p>Set the current Gamma Value for the Display. </p>
849
850</div>
851</div>
852<a class="anchor" id="a22ab84f23050dbef122f16a33aa9b91d"></a><!-- doxytag: member="irr::IrrlichtDevice::setInputReceivingSceneManager" ref="a22ab84f23050dbef122f16a33aa9b91d" args="(scene::ISceneManager *sceneManager)=0" -->
853<div class="memitem">
854<div class="memproto">
855 <table class="memname">
856 <tr>
857 <td class="memname">virtual void irr::IrrlichtDevice::setInputReceivingSceneManager </td>
858 <td>(</td>
859 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html">scene::ISceneManager</a> *&#160;</td>
860 <td class="paramname"><em>sceneManager</em></td><td>)</td>
861 <td><code> [pure virtual]</code></td>
862 </tr>
863 </table>
864</div>
865<div class="memdoc">
866
867<p>Sets the input receiving scene manager. </p>
868<p>If set to null, the main scene manager (returned by GetSceneManager()) will receive the input </p>
869<dl><dt><b>Parameters:</b></dt><dd>
870 <table class="params">
871 <tr><td class="paramname">sceneManager</td><td>New scene manager to be used. </td></tr>
872 </table>
873 </dd>
874</dl>
875
876</div>
877</div>
878<a class="anchor" id="af996a8a8031dacd823e3c65ee3ed2c33"></a><!-- doxytag: member="irr::IrrlichtDevice::setRandomizer" ref="af996a8a8031dacd823e3c65ee3ed2c33" args="(IRandomizer *r)=0" -->
879<div class="memitem">
880<div class="memproto">
881 <table class="memname">
882 <tr>
883 <td class="memname">virtual void irr::IrrlichtDevice::setRandomizer </td>
884 <td>(</td>
885 <td class="paramtype"><a class="el" href="classirr_1_1_i_randomizer.html">IRandomizer</a> *&#160;</td>
886 <td class="paramname"><em>r</em></td><td>)</td>
887 <td><code> [pure virtual]</code></td>
888 </tr>
889 </table>
890</div>
891<div class="memdoc">
892
893<p>Sets a new randomizer. </p>
894<dl><dt><b>Parameters:</b></dt><dd>
895 <table class="params">
896 <tr><td class="paramname">r</td><td>Pointer to the new <a class="el" href="classirr_1_1_i_randomizer.html" title="Interface for generating random numbers.">IRandomizer</a> object. This object is <a class="el" href="classirr_1_1_i_reference_counted.html#a2b7a035532e5f409ca9482dab79185f4" title="Grabs the object. Increments the reference counter by one.">grab()</a>'ed by the engine and will be released upon the next setRandomizer call or upon device destruction. </td></tr>
897 </table>
898 </dd>
899</dl>
900
901</div>
902</div>
903<a class="anchor" id="a4911502bd085d2d87474ff12959bc341"></a><!-- doxytag: member="irr::IrrlichtDevice::setResizable" ref="a4911502bd085d2d87474ff12959bc341" args="(bool resize=false)=0" -->
904<div class="memitem">
905<div class="memproto">
906 <table class="memname">
907 <tr>
908 <td class="memname">virtual void irr::IrrlichtDevice::setResizable </td>
909 <td>(</td>
910 <td class="paramtype">bool&#160;</td>
911 <td class="paramname"><em>resize</em> = <code>false</code></td><td>)</td>
912 <td><code> [pure virtual]</code></td>
913 </tr>
914 </table>
915</div>
916<div class="memdoc">
917
918<p>Sets if the window should be resizable in windowed mode. </p>
919<p>The default is false. This method only works in windowed mode. </p>
920<dl><dt><b>Parameters:</b></dt><dd>
921 <table class="params">
922 <tr><td class="paramname">resize</td><td>Flag whether the window should be resizable. </td></tr>
923 </table>
924 </dd>
925</dl>
926
927</div>
928</div>
929<a class="anchor" id="a3d7c98d520bf18ce1973c6f1439a7c0f"></a><!-- doxytag: member="irr::IrrlichtDevice::setWindowCaption" ref="a3d7c98d520bf18ce1973c6f1439a7c0f" args="(const wchar_t *text)=0" -->
930<div class="memitem">
931<div class="memproto">
932 <table class="memname">
933 <tr>
934 <td class="memname">virtual void irr::IrrlichtDevice::setWindowCaption </td>
935 <td>(</td>
936 <td class="paramtype">const wchar_t *&#160;</td>
937 <td class="paramname"><em>text</em></td><td>)</td>
938 <td><code> [pure virtual]</code></td>
939 </tr>
940 </table>
941</div>
942<div class="memdoc">
943
944<p>Sets the caption of the window. </p>
945<dl><dt><b>Parameters:</b></dt><dd>
946 <table class="params">
947 <tr><td class="paramname">text,:</td><td>New text of the window caption. </td></tr>
948 </table>
949 </dd>
950</dl>
951
952</div>
953</div>
954<a class="anchor" id="a89a3ecebc0e7c5ae08617b78a6e8a9f7"></a><!-- doxytag: member="irr::IrrlichtDevice::sleep" ref="a89a3ecebc0e7c5ae08617b78a6e8a9f7" args="(u32 timeMs, bool pauseTimer=false)=0" -->
955<div class="memitem">
956<div class="memproto">
957 <table class="memname">
958 <tr>
959 <td class="memname">virtual void irr::IrrlichtDevice::sleep </td>
960 <td>(</td>
961 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
962 <td class="paramname"><em>timeMs</em>, </td>
963 </tr>
964 <tr>
965 <td class="paramkey"></td>
966 <td></td>
967 <td class="paramtype">bool&#160;</td>
968 <td class="paramname"><em>pauseTimer</em> = <code>false</code>&#160;</td>
969 </tr>
970 <tr>
971 <td></td>
972 <td>)</td>
973 <td></td><td><code> [pure virtual]</code></td>
974 </tr>
975 </table>
976</div>
977<div class="memdoc">
978
979<p>Pause execution and let other processes to run for a specified amount of time. </p>
980<p>It may not wait the full given time, as sleep may be interrupted </p>
981<dl><dt><b>Parameters:</b></dt><dd>
982 <table class="params">
983 <tr><td class="paramname">timeMs,:</td><td>Time to sleep for in milisecs. </td></tr>
984 <tr><td class="paramname">pauseTimer,:</td><td>If true, pauses the device timer while sleeping </td></tr>
985 </table>
986 </dd>
987</dl>
988
989</div>
990</div>
991<a class="anchor" id="a731727774fad9fc4c6c1c85277ca36dc"></a><!-- doxytag: member="irr::IrrlichtDevice::yield" ref="a731727774fad9fc4c6c1c85277ca36dc" args="()=0" -->
992<div class="memitem">
993<div class="memproto">
994 <table class="memname">
995 <tr>
996 <td class="memname">virtual void irr::IrrlichtDevice::yield </td>
997 <td>(</td>
998 <td class="paramname"></td><td>)</td>
999 <td><code> [pure virtual]</code></td>
1000 </tr>
1001 </table>
1002</div>
1003<div class="memdoc">
1004
1005<p>Cause the device to temporarily pause execution and let other processes run. </p>
1006<p>This should bring down processor usage without major performance loss for Irrlicht </p>
1007
1008</div>
1009</div>
1010<hr/>The documentation for this class was generated from the following file:<ul>
1011<li><a class="el" href="_irrlicht_device_8h_source.html">IrrlichtDevice.h</a></li>
1012</ul>
1013</div>
1014</div>
1015 <div id="nav-path" class="navpath">
1016 <ul>
1017 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
1018 <li class="navelem"><a class="el" href="classirr_1_1_irrlicht_device.html">IrrlichtDevice</a> </li>
1019<!-- window showing the filter options -->
1020<div id="MSearchSelectWindow"
1021 onmouseover="return searchBox.OnSearchSelectShow()"
1022 onmouseout="return searchBox.OnSearchSelectHide()"
1023 onkeydown="return searchBox.OnSearchSelectKey(event)">
1024<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>
1025
1026<!-- iframe showing the search results (closed by default) -->
1027<div id="MSearchResultsWindow">
1028<iframe src="javascript:void(0)" frameborder="0"
1029 name="MSearchResults" id="MSearchResults">
1030</iframe>
1031</div>
1032
1033
1034 <li class="footer">
1035<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
1036Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
1037<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
1038 </ul>
1039 </div>
1040
1041
1042</body>
1043</html>
generated by cgit v1.1 at 2024-06-27 09:34:02 +0000