UNPKG

7.02 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>exports - Documentation</title>
6
7 <script src="scripts/prettify/prettify.js"></script>
8 <script src="scripts/prettify/lang-css.js"></script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
13 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
14 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
15</head>
16<body>
17
18<input type="checkbox" id="nav-trigger" class="nav-trigger" />
19<label for="nav-trigger" class="navicon-button x">
20 <div class="navicon"></div>
21</label>
22
23<label for="nav-trigger" class="overlay"></label>
24
25<nav>
26 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EdgesHelper.html">EdgesHelper</a><ul class='methods'><li data-type='method'><a href="EdgesHelper.html#.AddEdges">AddEdges</a></li></ul></li><li><a href="FluxCameras.html">FluxCameras</a><ul class='methods'><li data-type='method'><a href="FluxCameras.html#.cameraFromJSON">cameraFromJSON</a></li><li data-type='method'><a href="FluxCameras.html#.cameraToJSON">cameraToJSON</a></li><li data-type='method'><a href="FluxCameras.html#fromJSON">fromJSON</a></li><li data-type='method'><a href="FluxCameras.html#getCamera">getCamera</a></li><li data-type='method'><a href="FluxCameras.html#setView">setView</a></li><li data-type='method'><a href="FluxCameras.html#toJSON">toJSON</a></li><li data-type='method'><a href="FluxCameras.html#updateCamera">updateCamera</a></li></ul></li><li><a href="FluxRenderContext.html">FluxRenderContext</a><ul class='methods'><li data-type='method'><a href="FluxRenderContext.html#.getNextContext">getNextContext</a></li></ul></li><li><a href="FluxViewport.html">FluxViewport</a><ul class='methods'><li data-type='method'><a href="FluxViewport.html#.getChangeEvent">getChangeEvent</a></li><li data-type='method'><a href="FluxViewport.html#.getEdgesModes">getEdgesModes</a></li><li data-type='method'><a href="FluxViewport.html#.getViews">getViews</a></li><li data-type='method'><a href="FluxViewport.html#.isKnownGeom">isKnownGeom</a></li><li data-type='method'><a href="FluxViewport.html#activateShadows">activateShadows</a></li><li data-type='method'><a href="FluxViewport.html#downloadState">downloadState</a></li><li data-type='method'><a href="FluxViewport.html#focus">focus</a></li><li data-type='method'><a href="FluxViewport.html#fromJSON">fromJSON</a></li><li data-type='method'><a href="FluxViewport.html#getAutoFocus">getAutoFocus</a></li><li data-type='method'><a href="FluxViewport.html#getGlCanvas">getGlCanvas</a></li><li data-type='method'><a href="FluxViewport.html#homeCamera">homeCamera</a></li><li data-type='method'><a href="FluxViewport.html#render">render</a></li><li data-type='method'><a href="FluxViewport.html#setAutoFocus">setAutoFocus</a></li><li data-type='method'><a href="FluxViewport.html#setClearColor">setClearColor</a></li><li data-type='method'><a href="FluxViewport.html#setEdgesMode">setEdgesMode</a></li><li data-type='method'><a href="FluxViewport.html#setFogDensity">setFogDensity</a></li><li data-type='method'><a href="FluxViewport.html#setGeometryEntity">setGeometryEntity</a></li><li data-type='method'><a href="FluxViewport.html#setGeometryJson">setGeometryJson</a></li><li data-type='method'><a href="FluxViewport.html#setSize">setSize</a></li><li data-type='method'><a href="FluxViewport.html#setTessUrl">setTessUrl</a></li><li data-type='method'><a href="FluxViewport.html#setupDefaultLighting">setupDefaultLighting</a></li><li data-type='method'><a href="FluxViewport.html#setView">setView</a></li><li data-type='method'><a href="FluxViewport.html#toJSON">toJSON</a></li></ul></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_deleteFromScene">_deleteFromScene</a></li><li><a href="global.html#_removeGeometries">_removeGeometries</a></li></ul>
27</nav>
28
29<div id="main">
30
31 <h1 class="page-title">exports</h1>
32
33
34
35
36
37
38
39<section>
40
41<header>
42
43 <h2>
44 exports
45 </h2>
46
47 <div class="class-description">FluxRenderer
48
49Multipass rendering uses GPU shaders to accomplish ambient obscurance
50and stencil buffer shadows.
51
52Context swapping lets a single OpenGL context and canvas be used for multiple renderers.</div>
53
54
55</header>
56
57<article>
58 <div class="container-overview">
59
60
61
62
63 <h2>Constructor</h2>
64
65
66 <h4 class="name" id="exports"><span class="type-signature"></span>new exports<span class="signature">(domParent, width, height)</span><span class="type-signature"></span></h4>
67
68
69
70
71
72<div class="description">
73 Class wrapping the renderer with custom passes and context swapping.
74</div>
75
76
77
78
79
80
81
82
83
84 <h5>Parameters:</h5>
85
86
87<table class="params">
88 <thead>
89 <tr>
90
91 <th>Name</th>
92
93
94 <th>Type</th>
95
96
97
98
99
100 <th class="last">Description</th>
101 </tr>
102 </thead>
103
104 <tbody>
105
106
107 <tr>
108
109 <td class="name"><code>domParent</code></td>
110
111
112 <td class="type">
113
114
115<span class="param-type">Element</span>
116
117
118
119 </td>
120
121
122
123
124
125 <td class="description last">The div container for the canvas</td>
126 </tr>
127
128
129
130 <tr>
131
132 <td class="name"><code>width</code></td>
133
134
135 <td class="type">
136
137
138<span class="param-type">Number</span>
139
140
141
142 </td>
143
144
145
146
147
148 <td class="description last">The width of the canvas</td>
149 </tr>
150
151
152
153 <tr>
154
155 <td class="name"><code>height</code></td>
156
157
158 <td class="type">
159
160
161<span class="param-type">Number</span>
162
163
164
165 </td>
166
167
168
169
170
171 <td class="description last">The height of the canvas</td>
172 </tr>
173
174
175 </tbody>
176</table>
177
178
179
180
181
182
183<dl class="details">
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210 <dt class="tag-source">Source:</dt>
211 <dd class="tag-source"><ul class="dummy"><li>
212 <a href="FluxRenderer.js.html">FluxRenderer.js</a>, <a href="FluxRenderer.js.html#line24">line 24</a>
213 </li></ul></dd>
214
215
216
217
218
219
220
221</dl>
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239 </div>
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258</article>
259
260</section>
261
262
263
264
265</div>
266
267<br class="clear">
268
269<footer>
270 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Aug 05 2016 09:44:56 GMT-0700 (PDT) using the Minami theme.
271</footer>
272
273<script>prettyPrint();</script>
274<script src="scripts/linenumber.js"></script>
275</body>
276</html>
\No newline at end of file