-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathH3DU.RenderPass.html
executable file
·179 lines (128 loc) · 7.69 KB
/
H3DU.RenderPass.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!DOCTYPE html><html><head><meta http-equiv=Content-Type content="text/html; charset=utf-8"><title>H3DU.RenderPass</title><meta name="viewport" content="width=device-width"><link rel=stylesheet type="text/css" href="/style.css"></head><body> <div class="header">
<p><a href="#navigation">Menu</a> - <a href="#top">Top</a> - <a href="/">Home</a> -
<a href="http://peteroupc.github.io/">Donate to Me</a></p></div>
<div class="mainarea" id="top">
<h1>H3DU.RenderPass</h1>
<p><a href="index.html">Back to documentation index.</a></p>
<p><a name='H3DU.RenderPass'></a></p>
<h3>H3DU.RenderPass(batch, [parameters])</h3>
<p>Describes a batch (a scene graph of 3D objects) and options for
rendering that batch.</p>
<h4>Parameters</h4>
<ul>
<li><code>batch</code> (Type: <a href="H3DU.Batch3D.html">H3DU.Batch3D</a>)<br>The batch to render using the options described by this object.</li>
<li><code>parameters</code> (Type: Object) (optional)<br>An object whose keys have the possibilities given in H3DU.RenderParams#setParams, and whose values are those allowed for each key.</li>
</ul>
<h3>Members</h3>
<ul>
<li><a href="#H3DU.RenderPass_batch">batch</a><br>The batch to render.</li>
<li><a href="#H3DU.RenderPass_clearColor">clearColor</a><br>Whether to clear the color buffer before rendering the batch.</li>
<li><a href="#H3DU.RenderPass_clearDepth">clearDepth</a><br>Whether to clear the depth buffer before rendering the batch.</li>
<li><a href="#H3DU.RenderPass_clearStencil">clearStencil</a><br>Whether to clear the stencil buffer before rendering the batch.</li>
<li><a href="#H3DU.RenderPass_frameBuffer">frameBuffer</a><br>Framebuffer to render to.</li>
<li><a href="#H3DU.RenderPass_shader">shader</a><br>Shader to use.</li>
<li><a href="#H3DU.RenderPass_useFrameBufferSize">useFrameBufferSize</a><br>Use the dimensions of the specified framebuffer rather than those
of the scene rendering it.</li>
</ul>
<h3>Methods</h3>
<ul>
<li><a href="#H3DU.RenderPass_setParams">setParams</a><br>Sets parameters for this render pass object.</li>
</ul>
<p><a name='H3DU.RenderPass_batch'></a></p>
<h3>H3DU.RenderPass#batch</h3>
<p>The batch to render.</p>
<p>Type: <a href="H3DU.Batch3D.html">H3DU.Batch3D</a></p>
<p><a name='H3DU.RenderPass_clearColor'></a></p>
<h3>H3DU.RenderPass#clearColor</h3>
<p>Whether to clear the color buffer before rendering the batch.</p>
<p>Default Value: <code>true</code></p>
<p><a name='H3DU.RenderPass_clearDepth'></a></p>
<h3>H3DU.RenderPass#clearDepth</h3>
<p>Whether to clear the depth buffer before rendering the batch.</p>
<p>Default Value: <code>true</code></p>
<p><a name='H3DU.RenderPass_clearStencil'></a></p>
<h3>H3DU.RenderPass#clearStencil</h3>
<p>Whether to clear the stencil buffer before rendering the batch.</p>
<p>Default Value: <code>true</code></p>
<p><a name='H3DU.RenderPass_frameBuffer'></a></p>
<h3>H3DU.RenderPass#frameBuffer</h3>
<p>Framebuffer to render to.</p>
<p>Type: <a href="H3DU.FrameBufferInfo.html">H3DU.FrameBufferInfo</a></p>
<p>Default Value: <code>null</code></p>
<p><a name='H3DU.RenderPass_shader'></a></p>
<h3>H3DU.RenderPass#shader</h3>
<p>Shader to use.</p>
<p>Type: <a href="H3DU.ShaderInfo.html">H3DU.ShaderInfo</a></p>
<p>Default Value: <code>null</code></p>
<p><a name='H3DU.RenderPass_useFrameBufferSize'></a></p>
<h3>H3DU.RenderPass#useFrameBufferSize</h3>
<p>Use the dimensions of the specified framebuffer rather than those
of the scene rendering it.</p>
<p>Type: boolean</p>
<p>Default Value: <code>false</code></p>
<p><a name='H3DU.RenderPass_setParams'></a></p>
<h3>H3DU.RenderPass#setParams(parameters)</h3>
<p>Sets parameters for this render pass object.</p>
<h4>Parameters</h4>
<ul>
<li><code>parameters</code> (Type: Object)<br>An object whose keys have the possibilities given later, and whose values are those allowed for each key.<ul> <li><code>subScene</code> - The batch to render. An <a href="H3DU.Batch3D.html">H3DU.Batch3D</a> object. <li><code>clearColor</code> - Whether to clear the color buffer before rendering the batch. Either true or false. <li><code>clearDepth</code> - Whether to clear the depth buffer before rendering the batch. Either true or false. <li><code>clearStencil</code> - Whether to clear the stencil buffer before rendering the batch. Either true or false. <li><code>frameBuffer</code> - Framebuffer to render to. An <a href="H3DU.FrameBufferInfo.html">H3DU.FrameBufferInfo</a> object. <li><code>shader</code> - Shader to use. An <a href="H3DU.ShaderInfo.html">H3DU.ShaderInfo</a> object. <li><code>useFrameBufferSize</code> - Use the dimensions of the specified framebuffer rather than those of the scene rendering it. </ul> Any or all of these keys can exist in the parameters object. If a value is undefined, it is ignored.</li>
</ul>
<h4>Return Value</h4>
<p>This object. (Type: <a href="H3DU.RenderPass.html">H3DU.RenderPass</a>)</p>
<p><a href="index.html">Back to documentation index.</a></p>
</div><nav id="navigation"><ul>
<li><a href="/">Back to start site.</a>
<li><a href="https://github.com/peteroupc/peteroupc.github.io">This site's repository (source code)</a>
<li><a href="https://github.com/peteroupc/peteroupc.github.io/issues">Post an issue or comment</a></ul>
<p>
<a href="//twitter.com/share">Share via Twitter</a>, <a href="//www.facebook.com/sharer/sharer.php" id="sharer">Share via Facebook</a>
</p>
</div>
<h3>Navigation</h3>
<ul>
<li><a href="DrawingToy.html">DrawingToy</a></li>
<li><a href="Epitrochoid.html">Epitrochoid</a></li>
<li><a href="H3DU.html">H3DU</a></li>
<li><a href="H3DU.BSplineCurve.html">H3DU.BSplineCurve</a></li>
<li><a href="H3DU.BSplineSurface.html">H3DU.BSplineSurface</a></li>
<li><a href="H3DU.BufferAccessor.html">H3DU.BufferAccessor</a></li>
<li><a href="H3DU.Camera.html">H3DU.Camera</a></li>
<li><a href="H3DU.Curve.html">H3DU.Curve</a></li>
<li><a href="H3DU.CurveBuilder.html">H3DU.CurveBuilder</a></li>
<li><a href="H3DU.CurveTube.html">H3DU.CurveTube</a></li>
<li><a href="H3DU.GraphicsPath.html">H3DU.GraphicsPath</a></li>
<li><a href="H3DU.InputTracker.html">H3DU.InputTracker</a></li>
<li><a href="H3DU.MathUtil.html">H3DU.MathUtil</a></li>
<li><a href="H3DU.MeshBuffer.html">H3DU.MeshBuffer</a></li>
<li><a href="H3DU.Meshes.html">H3DU.Meshes</a></li>
<li><a href="H3DU.PiecewiseCurve.html">H3DU.PiecewiseCurve</a></li>
<li><a href="H3DU.Shape.html">H3DU.Shape</a></li>
<li><a href="H3DU.ShapeGroup.html">H3DU.ShapeGroup</a></li>
<li><a href="H3DU.Surface.html">H3DU.Surface</a></li>
<li><a href="H3DU.SurfaceBuilder.html">H3DU.SurfaceBuilder</a></li>
<li><a href="H3DU.TextFont.html">H3DU.TextFont</a></li>
<li><a href="H3DU.TextureAtlas.html">H3DU.TextureAtlas</a></li>
<li><a href="H3DU.Transform.html">H3DU.Transform</a></li>
<li><a href="Hypotrochoid.html">Hypotrochoid</a></li>
<li><a href="MatrixStack.html">MatrixStack</a></li>
<li><a href="Polyhedra.html">Polyhedra</a></li>
<li><a href="Promise.html">Promise</a></li>
<li><a href="Semantic.html">Semantic</a></li>
<li><a href="StarField.html">StarField</a></li>
<li><a href="Superellipsoid.html">Superellipsoid</a></li>
<li><a href="Supertoroid.html">Supertoroid</a></li>
<li><a href="SurfaceOfRevolution.html">SurfaceOfRevolution</a></li>
<li><a href="Trochoid.html">Trochoid</a></li>
<li><a href="curveCatacaustic.html">curveCatacaustic</a></li>
<li><a href="curveEvolute.html">curveEvolute</a></li>
<li><a href="curveInverse.html">curveInverse</a></li>
<li><a href="curveInvolute.html">curveInvolute</a></li>
<li><a href="curveOrthotomic.html">curveOrthotomic</a></li>
<li><a href="curvePedalCurve.html">curvePedalCurve</a></li>
<li><a href="curveRadialCurve.html">curveRadialCurve</a></li>
<li><a href="polarCurve.html">polarCurve</a></li>
<li><a href="ruledSurface.html">ruledSurface</a></li>
<li><a href="spiralCurve.html">spiralCurve</a></li>
</ul>
</nav>
</body></html>