aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_material_renderer.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_material_renderer.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_material_renderer.html317
1 files changed, 317 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_material_renderer.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_material_renderer.html
new file mode 100644
index 0000000..d10f1af
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1video_1_1_i_material_renderer.html
@@ -0,0 +1,317 @@
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::IMaterialRenderer 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_material_renderer.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::IMaterialRenderer Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::video::IMaterialRenderer" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Interface for material rendering.
95 <a href="classirr_1_1video_1_1_i_material_renderer.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.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::IMaterialRenderer:</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_material_renderer.png" usemap="#irr::video::IMaterialRenderer_map" alt=""/>
105 <map id="irr::video::IMaterialRenderer_map" name="irr::video::IMaterialRenderer_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,170,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1video_1_1_i_material_renderer-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_material_renderer.html#a8ccaf22f84f26a718559d3c97f7cb550">getRenderCapability</a> () const
115<dl class="el"><dd class="mdescRight">Returns the render capability of the material. <a href="#a8ccaf22f84f26a718559d3c97f7cb550"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1video_1_1_i_material_renderer.html#a31ba4c2c50b85327d328cb9e7b1764bd">isTransparent</a> () const
116<dl class="el"><dd class="mdescRight">Returns if the material is transparent. <a href="#a31ba4c2c50b85327d328cb9e7b1764bd"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1video_1_1_i_material_renderer.html#a8cb6c5f93856de7586a318f14ed21a22">OnRender</a> (<a class="el" href="classirr_1_1video_1_1_i_material_renderer_services.html">IMaterialRendererServices</a> *service, <a class="el" href="namespaceirr_1_1video.html#a0e3b59e025e0d0db0ed2ee0ce904deac">E_VERTEX_TYPE</a> vtxtype)
117<dl class="el"><dd class="mdescRight">Called every time before a new bunch of geometry is being drawn using this material with for example drawIndexedTriangleList() call. <a href="#a8cb6c5f93856de7586a318f14ed21a22"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1video_1_1_i_material_renderer.html#aeaffc03c1b9feb40cd01469726b287e3">OnSetMaterial</a> (const <a class="el" href="classirr_1_1video_1_1_s_material.html">SMaterial</a> &amp;material, const <a class="el" href="classirr_1_1video_1_1_s_material.html">SMaterial</a> &amp;lastMaterial, bool resetAllRenderstates, <a class="el" href="classirr_1_1video_1_1_i_material_renderer_services.html">IMaterialRendererServices</a> *services)
118<dl class="el"><dd class="mdescRight">Called by the <a class="el" href="classirr_1_1video_1_1_i_video_driver.html" title="Interface to driver which is able to perform 2d and 3d graphics functions.">IVideoDriver</a> implementation the let the renderer set its needed render states. <a href="#aeaffc03c1b9feb40cd01469726b287e3"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1video_1_1_i_material_renderer.html#a694b1285671853cb151c03100fd01c73">OnUnsetMaterial</a> ()
119<dl class="el"><dd class="mdescRight">Called by the <a class="el" href="classirr_1_1video_1_1_i_video_driver.html" title="Interface to driver which is able to perform 2d and 3d graphics functions.">IVideoDriver</a> to unset this material. <a href="#a694b1285671853cb151c03100fd01c73"></a><br/></dl></ul>
120<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
121<div class="textblock"><p>Interface for material rendering. </p>
122<p>Can be used to extend the engine with new materials. Refer to <a class="el" href="classirr_1_1video_1_1_i_video_driver.html#a0dfc3a7168f3a73a6f4323b579f03ff6" title="Adds a new material renderer to the video device.">IVideoDriver::addMaterialRenderer()</a> for more informations on how to extend the engine with new materials. </p>
123
124<p>Definition at line <a class="el" href="_i_material_renderer_8h_source.html#l00024">24</a> of file <a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a>.</p>
125</div><hr/><h2>Member Function Documentation</h2>
126<a class="anchor" id="a8ccaf22f84f26a718559d3c97f7cb550"></a><!-- doxytag: member="irr::video::IMaterialRenderer::getRenderCapability" ref="a8ccaf22f84f26a718559d3c97f7cb550" args="() const " -->
127<div class="memitem">
128<div class="memproto">
129 <table class="memname">
130 <tr>
131 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::video::IMaterialRenderer::getRenderCapability </td>
132 <td>(</td>
133 <td class="paramname"></td><td>)</td>
134 <td> const<code> [inline, virtual]</code></td>
135 </tr>
136 </table>
137</div>
138<div class="memdoc">
139
140<p>Returns the render capability of the material. </p>
141<p>Because some more complex materials are implemented in multiple ways and need special hardware capabilities, it is possible to query how the current material renderer is performing on the current hardware with this function. </p>
142<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 if everything is running fine. Any other value is material renderer specific and means for example that the renderer switched back to a fall back material because it cannot use the latest shaders. More specific examples: Fixed function pipeline materials should return 0 in most cases, parallax mapped material will only return 0 when at least pixel shader 1.4 is available on that machine. </dd></dl>
143
144<p>Definition at line <a class="el" href="_i_material_renderer_8h_source.html#l00093">93</a> of file <a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a>.</p>
145
146</div>
147</div>
148<a class="anchor" id="a31ba4c2c50b85327d328cb9e7b1764bd"></a><!-- doxytag: member="irr::video::IMaterialRenderer::isTransparent" ref="a31ba4c2c50b85327d328cb9e7b1764bd" args="() const " -->
149<div class="memitem">
150<div class="memproto">
151 <table class="memname">
152 <tr>
153 <td class="memname">virtual bool irr::video::IMaterialRenderer::isTransparent </td>
154 <td>(</td>
155 <td class="paramname"></td><td>)</td>
156 <td> const<code> [inline, virtual]</code></td>
157 </tr>
158 </table>
159</div>
160<div class="memdoc">
161
162<p>Returns if the material is transparent. </p>
163<p>The scene managment needs to know this for being able to sort the materials by opaque and transparent. </p>
164
165<p>Definition at line <a class="el" href="_i_material_renderer_8h_source.html#l00081">81</a> of file <a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a>.</p>
166
167</div>
168</div>
169<a class="anchor" id="a8cb6c5f93856de7586a318f14ed21a22"></a><!-- doxytag: member="irr::video::IMaterialRenderer::OnRender" ref="a8cb6c5f93856de7586a318f14ed21a22" args="(IMaterialRendererServices *service, E_VERTEX_TYPE vtxtype)" -->
170<div class="memitem">
171<div class="memproto">
172 <table class="memname">
173 <tr>
174 <td class="memname">virtual bool irr::video::IMaterialRenderer::OnRender </td>
175 <td>(</td>
176 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_material_renderer_services.html">IMaterialRendererServices</a> *&#160;</td>
177 <td class="paramname"><em>service</em>, </td>
178 </tr>
179 <tr>
180 <td class="paramkey"></td>
181 <td></td>
182 <td class="paramtype"><a class="el" href="namespaceirr_1_1video.html#a0e3b59e025e0d0db0ed2ee0ce904deac">E_VERTEX_TYPE</a>&#160;</td>
183 <td class="paramname"><em>vtxtype</em>&#160;</td>
184 </tr>
185 <tr>
186 <td></td>
187 <td>)</td>
188 <td></td><td><code> [inline, virtual]</code></td>
189 </tr>
190 </table>
191</div>
192<div class="memdoc">
193
194<p>Called every time before a new bunch of geometry is being drawn using this material with for example drawIndexedTriangleList() call. </p>
195<p>OnSetMaterial should normally only be called if the renderer decides that the renderstates should be changed, it won't be called if for example two drawIndexedTriangleList() will be called with the same material set. This method will be called every time. This is useful for example for materials with shaders, which don't only set new renderstates but also shader constants. </p>
196<dl><dt><b>Parameters:</b></dt><dd>
197 <table class="params">
198 <tr><td class="paramname">service,:</td><td>Pointer to interface providing methos for setting constants and other things. </td></tr>
199 <tr><td class="paramname">vtxtype,:</td><td>Vertex type with which the next rendering will be done. This can be used by the material renderer to set some specific optimized shaders or if this is an incompatible vertex type for this renderer, to refuse rendering for example. </td></tr>
200 </table>
201 </dd>
202</dl>
203<dl class="return"><dt><b>Returns:</b></dt><dd>Returns true if everything is ok, and false if nothing should be rendered. The material renderer can choose to return false for example if he doesn't support the specified vertex type. This is actually done in D3D8 and D3D9 when using a normal mapped material with a vertex type other than EVT_TANGENTS. </dd></dl>
204
205<p>Definition at line <a class="el" href="_i_material_renderer_8h_source.html#l00071">71</a> of file <a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a>.</p>
206
207</div>
208</div>
209<a class="anchor" id="aeaffc03c1b9feb40cd01469726b287e3"></a><!-- doxytag: member="irr::video::IMaterialRenderer::OnSetMaterial" ref="aeaffc03c1b9feb40cd01469726b287e3" args="(const SMaterial &amp;material, const SMaterial &amp;lastMaterial, bool resetAllRenderstates, IMaterialRendererServices *services)" -->
210<div class="memitem">
211<div class="memproto">
212 <table class="memname">
213 <tr>
214 <td class="memname">virtual void irr::video::IMaterialRenderer::OnSetMaterial </td>
215 <td>(</td>
216 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_material.html">SMaterial</a> &amp;&#160;</td>
217 <td class="paramname"><em>material</em>, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype">const <a class="el" href="classirr_1_1video_1_1_s_material.html">SMaterial</a> &amp;&#160;</td>
223 <td class="paramname"><em>lastMaterial</em>, </td>
224 </tr>
225 <tr>
226 <td class="paramkey"></td>
227 <td></td>
228 <td class="paramtype">bool&#160;</td>
229 <td class="paramname"><em>resetAllRenderstates</em>, </td>
230 </tr>
231 <tr>
232 <td class="paramkey"></td>
233 <td></td>
234 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_i_material_renderer_services.html">IMaterialRendererServices</a> *&#160;</td>
235 <td class="paramname"><em>services</em>&#160;</td>
236 </tr>
237 <tr>
238 <td></td>
239 <td>)</td>
240 <td></td><td><code> [inline, virtual]</code></td>
241 </tr>
242 </table>
243</div>
244<div class="memdoc">
245
246<p>Called by the <a class="el" href="classirr_1_1video_1_1_i_video_driver.html" title="Interface to driver which is able to perform 2d and 3d graphics functions.">IVideoDriver</a> implementation the let the renderer set its needed render states. </p>
247<p>This is called during the <a class="el" href="classirr_1_1video_1_1_i_video_driver.html#a8c9e31b41b7e6fd26cf65ce538ebab05" title="Sets a material.">IVideoDriver::setMaterial()</a> call. When overriding this, you can set some renderstates or for example a vertex or pixel shader if you like. </p>
248<dl><dt><b>Parameters:</b></dt><dd>
249 <table class="params">
250 <tr><td class="paramname">material,:</td><td>The new material parameters to be set. The renderer may change the material flags in this material. For example if this material does not accept the zbuffer = true, it can set it to false. This is useful, because in the next lastMaterial will be just the material in this call. </td></tr>
251 <tr><td class="paramname">lastMaterial,:</td><td>The material parameters which have been set before this material. </td></tr>
252 <tr><td class="paramname">resetAllRenderstates,:</td><td>True if all renderstates should really be reset. This is usually true if the last rendering mode was not a usual 3d rendering mode, but for example a 2d rendering mode. You should reset really all renderstates if this is true, no matter if the lastMaterial had some similar settings. This is used because in most cases, some common renderstates are not changed if they are already there, for example bilinear filtering, wireframe, gouraudshading, lighting, zbuffer, zwriteenable, backfaceculling and fogenable. </td></tr>
253 <tr><td class="paramname">services,:</td><td>Interface providing some methods for changing advanced, internal states of a <a class="el" href="classirr_1_1video_1_1_i_video_driver.html" title="Interface to driver which is able to perform 2d and 3d graphics functions.">IVideoDriver</a>. </td></tr>
254 </table>
255 </dd>
256</dl>
257
258<p>Definition at line <a class="el" href="_i_material_renderer_8h_source.html#l00050">50</a> of file <a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a>.</p>
259
260</div>
261</div>
262<a class="anchor" id="a694b1285671853cb151c03100fd01c73"></a><!-- doxytag: member="irr::video::IMaterialRenderer::OnUnsetMaterial" ref="a694b1285671853cb151c03100fd01c73" args="()" -->
263<div class="memitem">
264<div class="memproto">
265 <table class="memname">
266 <tr>
267 <td class="memname">virtual void irr::video::IMaterialRenderer::OnUnsetMaterial </td>
268 <td>(</td>
269 <td class="paramname"></td><td>)</td>
270 <td><code> [inline, virtual]</code></td>
271 </tr>
272 </table>
273</div>
274<div class="memdoc">
275
276<p>Called by the <a class="el" href="classirr_1_1video_1_1_i_video_driver.html" title="Interface to driver which is able to perform 2d and 3d graphics functions.">IVideoDriver</a> to unset this material. </p>
277<p>Called during the <a class="el" href="classirr_1_1video_1_1_i_video_driver.html#a8c9e31b41b7e6fd26cf65ce538ebab05" title="Sets a material.">IVideoDriver::setMaterial()</a> call before the new material will get the <a class="el" href="classirr_1_1video_1_1_i_material_renderer.html#aeaffc03c1b9feb40cd01469726b287e3" title="Called by the IVideoDriver implementation the let the renderer set its needed render states...">OnSetMaterial()</a> call. </p>
278
279<p>Definition at line <a class="el" href="_i_material_renderer_8h_source.html#l00076">76</a> of file <a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a>.</p>
280
281</div>
282</div>
283<hr/>The documentation for this class was generated from the following file:<ul>
284<li><a class="el" href="_i_material_renderer_8h_source.html">IMaterialRenderer.h</a></li>
285</ul>
286</div>
287</div>
288 <div id="nav-path" class="navpath">
289 <ul>
290 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
291 <li class="navelem"><a class="el" href="namespaceirr_1_1video.html">video</a> </li>
292 <li class="navelem"><a class="el" href="classirr_1_1video_1_1_i_material_renderer.html">IMaterialRenderer</a> </li>
293<!-- window showing the filter options -->
294<div id="MSearchSelectWindow"
295 onmouseover="return searchBox.OnSearchSelectShow()"
296 onmouseout="return searchBox.OnSearchSelectHide()"
297 onkeydown="return searchBox.OnSearchSelectKey(event)">
298<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>
299
300<!-- iframe showing the search results (closed by default) -->
301<div id="MSearchResultsWindow">
302<iframe src="javascript:void(0)" frameborder="0"
303 name="MSearchResults" id="MSearchResults">
304</iframe>
305</div>
306
307
308 <li class="footer">
309<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
310Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:48 for Irrlicht 3D Engine by
311<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
312 </ul>
313 </div>
314
315
316</body>
317</html>
generated by cgit v1.1 at 2024-06-27 09:29:52 +0000