Главная Обзор Помощь
Регистрация Вход
samien
/
three.js
зеркало из https://github.com/mrdoob/three.js.git
1
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: 4315ae7ffb
Ветки Метки
three.js
/
docs
/
pages
/
LightProbeGrid.html

LightProbeGrid.html 12 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>LightProbeGrid - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 	<h1 translate="no">LightProbeGrid</h1>
    13. 

  13. 		<section>
    14. 

  14. 			<header>
    15. 

  15. 				<div class="class-description"><p>A 3D grid of L2 Spherical Harmonic irradiance probes that provides
    16. 

  16. position-dependent diffuse global illumination.</p>
    17. 

  17. <p>Note that this class can only be used with <a href="WebGLRenderer.html">WebGLRenderer</a>.
    18. 

  18. A version for <a href="WebGPURenderer.html">WebGPURenderer</a> will be added at a later point.</p>
    19. 

  19. <p>All seven packed SH sub-volumes are stored in a <strong>single</strong> RGBA
    20. 

  20. <code>WebGL3DRenderTarget</code> using a texture-atlas layout along the Z axis.
    21. 

  21. Each sub-volume occupies <code>( nz + 2 )</code> atlas slices: one padding slice at
    22. 

  22. each end (a copy of the nearest edge data slice) to prevent color bleeding
    23. 

  23. when the hardware trilinear filter reads across a sub-volume boundary.</p>
    24. 

  24. <p>Atlas layout (nz = resolution.z, PADDING = 1):</p>
    25. 

  25. <p>Total atlas depth = <code>7 * ( nz + 2 )</code>.</p>
    26. 

  26. <p>Baking is fully GPU-resident: cubemap rendering, SH projection, and
    27. 

  27. texture packing all happen on the GPU with zero CPU readback.</p></div>
    28. 

  28. 				<h2>Code Example</h2>
    29. 

  29. 				<div translate="no"><pre class="prettyprint source"><code>  slice   0              : padding  (copy of sub-volume 0, data slice 0)
    30. 

  30.   slices  1 … nz         : sub-volume 0 data
    31. 

  31.   slice   nz + 1         : padding  (copy of sub-volume 0, data slice nz-1)
    32. 

  32.   slice   nz + 2         : padding  (copy of sub-volume 1, data slice 0)
    33. 

  33.   slices  nz+3 … 2*nz+2  : sub-volume 1 data
    34. 

  34.   …
    35. 

  35. </code></pre></div>
    36. 

  36. 			</header>
    37. 

  37. 			<article>
    38. 

  38. 				<h2 class="subsection-title">Import</h2>
    39. 

  39. 				<p><span translate="no">LightProbeGrid</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
    40. 

  40. 				<pre><code class="language-js">import { LightProbeGrid } from 'three/addons/lighting/LightProbeGrid.js';</code></pre>
    41. 

  41. 				<div class="container-overview">
    42. 

  42. 					<h2>Constructor</h2>
    43. 

  43. 					<h3 class="name name-method" id="LightProbeGrid" translate="no">new <a href="#LightProbeGrid">LightProbeGrid</a><span class="signature">( width : <span class="param-type">number</span>, height : <span class="param-type">number</span>, depth : <span class="param-type">number</span>, widthProbes : <span class="param-type">number</span>, heightProbes : <span class="param-type">number</span>, depthProbes : <span class="param-type">number</span> )</span> </h3>
    44. 

  44. 					<div class="method">
    45. 

  45. 						<div class="description">
    46. 

  46. 							<p>Constructs a new irradiance probe grid.</p>
    47. 

  47. <p>The volume is centered at the object's position.</p>
    48. 

  48. 						</div>
    49. 

  49. 						<table class="params">
    50. 

  50. 							<tbody>
    51. 

  51. 								<tr>
    52. 

  52. 									<td class="name">
    53. 

  53. 										<strong translate="no">width</strong>
    54. 

  54. 									</td>
    55. 

  55. 									<td class="description last">
    56. 

  56. 										<p>Full width of the volume along X.</p>
    57. 

  57. 										<p>Default is <code>1</code>.</p>
    58. 

  58. 									</td>
    59. 

  59. 								</tr>
    60. 

  60. 								<tr>
    61. 

  61. 									<td class="name">
    62. 

  62. 										<strong translate="no">height</strong>
    63. 

  63. 									</td>
    64. 

  64. 									<td class="description last">
    65. 

  65. 										<p>Full height of the volume along Y.</p>
    66. 

  66. 										<p>Default is <code>1</code>.</p>
    67. 

  67. 									</td>
    68. 

  68. 								</tr>
    69. 

  69. 								<tr>
    70. 

  70. 									<td class="name">
    71. 

  71. 										<strong translate="no">depth</strong>
    72. 

  72. 									</td>
    73. 

  73. 									<td class="description last">
    74. 

  74. 										<p>Full depth of the volume along Z.</p>
    75. 

  75. 										<p>Default is <code>1</code>.</p>
    76. 

  76. 									</td>
    77. 

  77. 								</tr>
    78. 

  78. 								<tr>
    79. 

  79. 									<td class="name">
    80. 

  80. 										<strong translate="no">widthProbes</strong>
    81. 

  81. 									</td>
    82. 

  82. 									<td class="description last">
    83. 

  83. 										<p>Number of probes along X. Defaults to <code>Math.max( 2, Math.round( width ) + 1 )</code>.</p>
    84. 

  84. 									</td>
    85. 

  85. 								</tr>
    86. 

  86. 								<tr>
    87. 

  87. 									<td class="name">
    88. 

  88. 										<strong translate="no">heightProbes</strong>
    89. 

  89. 									</td>
    90. 

  90. 									<td class="description last">
    91. 

  91. 										<p>Number of probes along Y. Defaults to <code>Math.max( 2, Math.round( height ) + 1 )</code>.</p>
    92. 

  92. 									</td>
    93. 

  93. 								</tr>
    94. 

  94. 								<tr>
    95. 

  95. 									<td class="name">
    96. 

  96. 										<strong translate="no">depthProbes</strong>
    97. 

  97. 									</td>
    98. 

  98. 									<td class="description last">
    99. 

  99. 										<p>Number of probes along Z. Defaults to <code>Math.max( 2, Math.round( depth ) + 1 )</code>.</p>
    100. 

  100. 									</td>
    101. 

  101. 								</tr>
    102. 

  102. 							</tbody>
    103. 

  103. 						</table>
    104. 

  104. 					</div>
    105. 

  105. 				</div>
    106. 

  106. 				<h2 class="subsection-title">Properties</h2>
    107. 

  107. 				<div class="member">
    108. 

  108. 					<h3 class="name" id="boundingBox" translate="no">.<a href="#boundingBox">boundingBox</a><span class="type-signature"> : <a href="Box3.html">Box3</a></span> </h3>
    109. 

  109. 					<div class="description">
    110. 

  110. 						<p>The world-space bounding box for the grid. Updated automatically
    111. 

  111. by <a href="LightProbeGrid.html#bake">LightProbeGrid#bake</a>.</p>
    112. 

  112. 					</div>
    113. 

  113. 				</div>
    114. 

  114. 				<div class="member">
    115. 

  115. 					<h3 class="name" id="depth" translate="no">.<a href="#depth">depth</a><span class="type-signature"> : number</span> </h3>
    116. 

  116. 					<div class="description">
    117. 

  117. 						<p>The full depth of the volume along Z.</p>
    118. 

  118. 					</div>
    119. 

  119. 				</div>
    120. 

  120. 				<div class="member">
    121. 

  121. 					<h3 class="name" id="height" translate="no">.<a href="#height">height</a><span class="type-signature"> : number</span> </h3>
    122. 

  122. 					<div class="description">
    123. 

  123. 						<p>The full height of the volume along Y.</p>
    124. 

  124. 					</div>
    125. 

  125. 				</div>
    126. 

  126. 				<div class="member">
    127. 

  127. 					<h3 class="name" id="isLightProbeGrid" translate="no">.<a href="#isLightProbeGrid">isLightProbeGrid</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
    128. 

  128. 					<div class="description">
    129. 

  129. 						<p>This flag can be used for type testing.</p>
    130. 

  130. 						<p>Default is <code>true</code>.</p>
    131. 

  131. 					</div>
    132. 

  132. 				</div>
    133. 

  133. 				<div class="member">
    134. 

  134. 					<h3 class="name" id="resolution" translate="no">.<a href="#resolution">resolution</a><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    135. 

  135. 					<div class="description">
    136. 

  136. 						<p>The number of probes along each axis.</p>
    137. 

  137. 					</div>
    138. 

  138. 				</div>
    139. 

  139. 				<div class="member">
    140. 

  140. 					<h3 class="name" id="texture" translate="no">.<a href="#texture">texture</a><span class="type-signature"> : <a href="Data3DTexture.html">Data3DTexture</a></span> </h3>
    141. 

  141. 					<div class="description">
    142. 

  142. 						<p>The single RGBA atlas 3D texture storing all seven packed SH sub-volumes.</p>
    143. 

  143. 						<p>Default is <code>null</code>.</p>
    144. 

  144. 					</div>
    145. 

  145. 				</div>
    146. 

  146. 				<div class="member">
    147. 

  147. 					<h3 class="name" id="width" translate="no">.<a href="#width">width</a><span class="type-signature"> : number</span> </h3>
    148. 

  148. 					<div class="description">
    149. 

  149. 						<p>The full width of the volume along X.</p>
    150. 

  150. 					</div>
    151. 

  151. 				</div>
    152. 

  152. 				<h2 class="subsection-title">Methods</h2>
    153. 

  153. 					<h3 class="name name-method" id="bake" translate="no">.<a href="#bake">bake</a><span class="signature">( renderer : <span class="param-type"><a href="WebGLRenderer.html">WebGLRenderer</a></span>, scene : <span class="param-type"><a href="Scene.html">Scene</a></span>, options : <span class="param-type">Object</span> )</span> </h3>
    154. 

  154. 					<div class="method">
    155. 

  155. 						<div class="description">
    156. 

  156. 							<p>Bakes all probes by rendering cubemaps at each probe position
    157. 

  157. and projecting to L2 SH. Optionally iterates additional passes to
    158. 

  158. capture indirect bounces — each extra pass samples the previous pass's
    159. 

  159. atlas as indirect light, so a grid added to the scene before baking
    160. 

  160. accumulates one bounce per extra pass.</p>
    161. 

  161. 						</div>
    162. 

  162. 						<table class="params">
    163. 

  163. 							<tbody>
    164. 

  164. 								<tr>
    165. 

  165. 									<td class="name">
    166. 

  166. 										<strong translate="no">renderer</strong>
    167. 

  167. 									</td>
    168. 

  168. 									<td class="description last">
    169. 

  169. 										<p>The renderer.</p>
    170. 

  170. 									</td>
    171. 

  171. 								</tr>
    172. 

  172. 								<tr>
    173. 

  173. 									<td class="name">
    174. 

  174. 										<strong translate="no">scene</strong>
    175. 

  175. 									</td>
    176. 

  176. 									<td class="description last">
    177. 

  177. 										<p>The scene to render.</p>
    178. 

  178. 									</td>
    179. 

  179. 								</tr>
    180. 

  180. 								<tr>
    181. 

  181. 									<td class="name">
    182. 

  182. 										<strong translate="no">options</strong>
    183. 

  183. 									</td>
    184. 

  184. 									<td class="description last">
    185. 

  185. 										<p>Bake options.</p>
    186. 

  186. 						<table class="params">
    187. 

  187. 							<tbody>
    188. 

  188. 								<tr>
    189. 

  189. 									<td class="name">
    190. 

  190. 										<strong translate="no">cubemapSize</strong>
    191. 

  191. 									</td>
    192. 

  192. 									<td class="description last">
    193. 

  193. 										<p>Resolution of each cubemap face.</p>
    194. 

  194. 										<p>Default is <code>8</code>.</p>
    195. 

  195. 									</td>
    196. 

  196. 								</tr>
    197. 

  197. 								<tr>
    198. 

  198. 									<td class="name">
    199. 

  199. 										<strong translate="no">near</strong>
    200. 

  200. 									</td>
    201. 

  201. 									<td class="description last">
    202. 

  202. 										<p>Near plane for the cube camera.</p>
    203. 

  203. 										<p>Default is <code>0.1</code>.</p>
    204. 

  204. 									</td>
    205. 

  205. 								</tr>
    206. 

  206. 								<tr>
    207. 

  207. 									<td class="name">
    208. 

  208. 										<strong translate="no">far</strong>
    209. 

  209. 									</td>
    210. 

  210. 									<td class="description last">
    211. 

  211. 										<p>Far plane for the cube camera.</p>
    212. 

  212. 										<p>Default is <code>100</code>.</p>
    213. 

  213. 									</td>
    214. 

  214. 								</tr>
    215. 

  215. 								<tr>
    216. 

  216. 									<td class="name">
    217. 

  217. 										<strong translate="no">bounces</strong>
    218. 

  218. 									</td>
    219. 

  219. 									<td class="description last">
    220. 

  220. 										<p>Additional bounce passes after the initial direct pass.</p>
    221. 

  221. 										<p>Default is <code>0</code>.</p>
    222. 

  222. 									</td>
    223. 

  223. 								</tr>
    224. 

  224. 							</tbody>
    225. 

  225. 						</table>
    226. 

  226. 									</td>
    227. 

  227. 								</tr>
    228. 

  228. 							</tbody>
    229. 

  229. 						</table>
    230. 

  230. 					</div>
    231. 

  231. 					<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
    232. 

  232. 					<div class="method">
    233. 

  233. 						<div class="description">
    234. 

  234. 							<p>Frees GPU resources.</p>
    235. 

  235. 						</div>
    236. 

  236. 					</div>
    237. 

  237. 					<h3 class="name name-method" id="getProbePosition" translate="no">.<a href="#getProbePosition">getProbePosition</a><span class="signature">( ix : <span class="param-type">number</span>, iy : <span class="param-type">number</span>, iz : <span class="param-type">number</span>, target : <span class="param-type"><a href="Vector3.html">Vector3</a></span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    238. 

  238. 					<div class="method">
    239. 

  239. 						<div class="description">
    240. 

  240. 							<p>Returns the world-space position of the probe at grid indices (ix, iy, iz).</p>
    241. 

  241. 						</div>
    242. 

  242. 						<table class="params">
    243. 

  243. 							<tbody>
    244. 

  244. 								<tr>
    245. 

  245. 									<td class="name">
    246. 

  246. 										<strong translate="no">ix</strong>
    247. 

  247. 									</td>
    248. 

  248. 									<td class="description last">
    249. 

  249. 										<p>X index.</p>
    250. 

  250. 									</td>
    251. 

  251. 								</tr>
    252. 

  252. 								<tr>
    253. 

  253. 									<td class="name">
    254. 

  254. 										<strong translate="no">iy</strong>
    255. 

  255. 									</td>
    256. 

  256. 									<td class="description last">
    257. 

  257. 										<p>Y index.</p>
    258. 

  258. 									</td>
    259. 

  259. 								</tr>
    260. 

  260. 								<tr>
    261. 

  261. 									<td class="name">
    262. 

  262. 										<strong translate="no">iz</strong>
    263. 

  263. 									</td>
    264. 

  264. 									<td class="description last">
    265. 

  265. 										<p>Z index.</p>
    266. 

  266. 									</td>
    267. 

  267. 								</tr>
    268. 

  268. 								<tr>
    269. 

  269. 									<td class="name">
    270. 

  270. 										<strong translate="no">target</strong>
    271. 

  271. 									</td>
    272. 

  272. 									<td class="description last">
    273. 

  273. 										<p>The target vector.</p>
    274. 

  274. 									</td>
    275. 

  275. 								</tr>
    276. 

  276. 							</tbody>
    277. 

  277. 						</table>
    278. 

  278. 						<dl class="details">
    279. 

  279. 							<dt class="tag-returns"><strong>Returns:</strong> The world-space position.</dt>
    280. 

  280. 						</dl>
    281. 

  281. 					</div>
    282. 

  282. 					<h3 class="name name-method" id="updateBoundingBox" translate="no">.<a href="#updateBoundingBox">updateBoundingBox</a><span class="signature">()</span> </h3>
    283. 

  283. 					<div class="method">
    284. 

  284. 						<div class="description">
    285. 

  285. 							<p>Updates the world-space bounding box from the current position and size.</p>
    286. 

  286. 						</div>
    287. 

  287. 					</div>
    288. 

  288. 				<h2 class="subsection-title">Source</h2>
    289. 

  289. 				<p>
    290. 

  290. 					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/lighting/LightProbeGrid.js" translate="no" target="_blank" rel="noopener">examples/jsm/lighting/LightProbeGrid.js</a>
    291. 

  291. 				</p>
    292. 

  292. 			</article>
    293. 

  293. 		</section>
    294. 

  294. <script src="../scripts/linenumber.js"></script>
    295. 

  295. <script src="../scripts/page.js"></script>
    296. 

  296. </body>
    297. 

  297. </html>
    298.
粤ICP备19079148号