Inicio Explorar Ayuda
Registro Iniciar sesión
samien
/
three.js
espejo de https://github.com/mrdoob/three.js.git
1
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: a2d4aa5cdf
Ramas Etiquetas
three.js
/
docs
/
pages
/
SSAOPass.html

SSAOPass.html 9.4 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207 
  1. <!DOCTYPE html>
    2. 

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

  3. <head>
    4. 

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

  5. 	<title>SSAOPass - 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. 		<p class="inheritance" translate="no"><a href="Pass.html">Pass</a> → </p>
    13. 

  13. 	<h1 translate="no">SSAOPass</h1>
    14. 

  14. 		<section>
    15. 

  15. 			<header>
    16. 

  16. 				<div class="class-description"><p>A pass for a basic SSAO effect.</p>
    17. 

  17. <p><a href="SAOPass.html">SAOPass</a> and GTAPass produce a more advanced AO but are also
    18. 

  18. more expensive.</p></div>
    19. 

  19. 				<h2>Code Example</h2>
    20. 

  20. 				<div translate="no"><pre><code class="language-js">const ssaoPass = new SSAOPass( scene, camera, width, height );
    21. 

  21. composer.addPass( ssaoPass );
    22. 

  22. </code></pre></div>
    23. 

  23. 			</header>
    24. 

  24. 			<article>
    25. 

  25. 				<h2 class="subsection-title">Import</h2>
    26. 

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

  27. 				<pre><code class="language-js">import { SSAOPass } from 'three/addons/postprocessing/SSAOPass.js';</code></pre>
    28. 

  28. 				<div class="container-overview">
    29. 

  29. 					<h2>Constructor</h2>
    30. 

  30. 					<h3 class="name name-method" id="SSAOPass" translate="no">new <a href="#SSAOPass">SSAOPass</a><span class="signature">( scene : <span class="param-type">Scene</span>, camera : <span class="param-type">Camera</span>, width : <span class="param-type">number</span>, height : <span class="param-type">number</span>, kernelSize : <span class="param-type">number</span> )</span> </h3>
    31. 

  31. 					<div class="method">
    32. 

  32. 						<div class="description">
    33. 

  33. 							<p>Constructs a new SSAO pass.</p>
    34. 

  34. 						</div>
    35. 

  35. 						<table class="params">
    36. 

  36. 							<tbody>
    37. 

  37. 								<tr>
    38. 

  38. 									<td class="name"><code>scene</code></td>
    39. 

  39. 									<td class="description last"><p>The scene to compute the AO for.</p></td>
    40. 

  40. 								</tr>
    41. 

  41. 								<tr>
    42. 

  42. 									<td class="name"><code>camera</code></td>
    43. 

  43. 									<td class="description last"><p>The camera.</p></td>
    44. 

  44. 								</tr>
    45. 

  45. 								<tr>
    46. 

  46. 									<td class="name"><code>width</code></td>
    47. 

  47. 									<td class="description last"><p>The width of the effect.<br/>Default is <code>512</code>.</p></td>
    48. 

  48. 								</tr>
    49. 

  49. 								<tr>
    50. 

  50. 									<td class="name"><code>height</code></td>
    51. 

  51. 									<td class="description last"><p>The height of the effect.<br/>Default is <code>512</code>.</p></td>
    52. 

  52. 								</tr>
    53. 

  53. 								<tr>
    54. 

  54. 									<td class="name"><code>kernelSize</code></td>
    55. 

  55. 									<td class="description last"><p>The kernel size.<br/>Default is <code>32</code>.</p></td>
    56. 

  56. 								</tr>
    57. 

  57. 							</tbody>
    58. 

  58. 						</table>
    59. 

  59. 					</div>
    60. 

  60. 				</div>
    61. 

  61. 				<h2 class="subsection-title">Properties</h2>
    62. 

  62. 				<div class="member">
    63. 

  63. 					<h3 class="name" id="camera" translate="no">.<a href="#camera">camera</a><span class="type-signature"> : <a href="Camera.html">Camera</a></span> </h3>
    64. 

  64. 					<div class="description">
    65. 

  65. 						<p>The camera.</p>
    66. 

  66. 					</div>
    67. 

  67. 				</div>
    68. 

  68. 				<div class="member">
    69. 

  69. 					<h3 class="name" id="clear" translate="no">.<a href="#clear">clear</a><span class="type-signature"> : boolean</span> </h3>
    70. 

  70. 					<div class="description">
    71. 

  71. 						<p>Overwritten to perform a clear operation by default.<br/>Default is <code>true</code>.</p>
    72. 

  72. 					</div>
    73. 

  73. 						<dl class="details">
    74. 

  74. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#clear">Pass#clear</a></dt>
    75. 

  75. 						</dl>
    76. 

  76. 				</div>
    77. 

  77. 				<div class="member">
    78. 

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

  79. 					<div class="description">
    80. 

  80. 						<p>The height of the effect.<br/>Default is <code>512</code>.</p>
    81. 

  81. 					</div>
    82. 

  82. 				</div>
    83. 

  83. 				<div class="member">
    84. 

  84. 					<h3 class="name" id="kernelRadius" translate="no">.<a href="#kernelRadius">kernelRadius</a><span class="type-signature"> : number</span> </h3>
    85. 

  85. 					<div class="description">
    86. 

  86. 						<p>The kernel radius controls how wide the
    87. 

  87. AO spreads.<br/>Default is <code>8</code>.</p>
    88. 

  88. 					</div>
    89. 

  89. 				</div>
    90. 

  90. 				<div class="member">
    91. 

  91. 					<h3 class="name" id="maxDistance" translate="no">.<a href="#maxDistance">maxDistance</a><span class="type-signature"> : number</span> </h3>
    92. 

  92. 					<div class="description">
    93. 

  93. 						<p>Defines the maximum distance that should be
    94. 

  94. affected by the AO.<br/>Default is <code>0.1</code>.</p>
    95. 

  95. 					</div>
    96. 

  96. 				</div>
    97. 

  97. 				<div class="member">
    98. 

  98. 					<h3 class="name" id="minDistance" translate="no">.<a href="#minDistance">minDistance</a><span class="type-signature"> : number</span> </h3>
    99. 

  99. 					<div class="description">
    100. 

  100. 						<p>Defines the minimum distance that should be
    101. 

  101. affected by the AO.<br/>Default is <code>0.005</code>.</p>
    102. 

  102. 					</div>
    103. 

  103. 				</div>
    104. 

  104. 				<div class="member">
    105. 

  105. 					<h3 class="name" id="needsSwap" translate="no">.<a href="#needsSwap">needsSwap</a><span class="type-signature"> : boolean</span> </h3>
    106. 

  106. 					<div class="description">
    107. 

  107. 						<p>Overwritten to disable the swap.<br/>Default is <code>false</code>.</p>
    108. 

  108. 					</div>
    109. 

  109. 						<dl class="details">
    110. 

  110. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#needsSwap">Pass#needsSwap</a></dt>
    111. 

  111. 						</dl>
    112. 

  112. 				</div>
    113. 

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

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

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

  116. 						<p>The output configuration.<br/>Default is <code>0</code>.</p>
    117. 

  117. 					</div>
    118. 

  118. 				</div>
    119. 

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

  120. 					<h3 class="name" id="scene" translate="no">.<a href="#scene">scene</a><span class="type-signature"> : <a href="Scene.html">Scene</a></span> </h3>
    121. 

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

  122. 						<p>The scene to render the AO for.</p>
    123. 

  123. 					</div>
    124. 

  124. 				</div>
    125. 

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

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

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

  128. 						<p>The width of the effect.<br/>Default is <code>512</code>.</p>
    129. 

  129. 					</div>
    130. 

  130. 				</div>
    131. 

  131. 				<h2 class="subsection-title">Methods</h2>
    132. 

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

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

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

  135. 							<p>Frees the GPU-related resources allocated by this instance. Call this
    136. 

  136. method whenever the pass is no longer used in your app.</p>
    137. 

  137. 						</div>
    138. 

  138. 						<dl class="details">
    139. 

  139. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#dispose">Pass#dispose</a></dt>
    140. 

  140. 						</dl>
    141. 

  141. 					</div>
    142. 

  142. 					<h3 class="name name-method" id="render" translate="no">.<a href="#render">render</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span>, writeBuffer : <span class="param-type">WebGLRenderTarget</span>, readBuffer : <span class="param-type">WebGLRenderTarget</span>, deltaTime : <span class="param-type">number</span>, maskActive : <span class="param-type">boolean</span> )</span> </h3>
    143. 

  143. 					<div class="method">
    144. 

  144. 						<div class="description">
    145. 

  145. 							<p>Performs the SSAO pass.</p>
    146. 

  146. 						</div>
    147. 

  147. 						<table class="params">
    148. 

  148. 							<tbody>
    149. 

  149. 								<tr>
    150. 

  150. 									<td class="name"><code>renderer</code></td>
    151. 

  151. 									<td class="description last"><p>The renderer.</p></td>
    152. 

  152. 								</tr>
    153. 

  153. 								<tr>
    154. 

  154. 									<td class="name"><code>writeBuffer</code></td>
    155. 

  155. 									<td class="description last"><p>The write buffer. This buffer is intended as the rendering
    156. 

  156. destination for the pass.</p></td>
    157. 

  157. 								</tr>
    158. 

  158. 								<tr>
    159. 

  159. 									<td class="name"><code>readBuffer</code></td>
    160. 

  160. 									<td class="description last"><p>The read buffer. The pass can access the result from the
    161. 

  161. previous pass from this buffer.</p></td>
    162. 

  162. 								</tr>
    163. 

  163. 								<tr>
    164. 

  164. 									<td class="name"><code>deltaTime</code></td>
    165. 

  165. 									<td class="description last"><p>The delta time in seconds.</p></td>
    166. 

  166. 								</tr>
    167. 

  167. 								<tr>
    168. 

  168. 									<td class="name"><code>maskActive</code></td>
    169. 

  169. 									<td class="description last"><p>Whether masking is active or not.</p></td>
    170. 

  170. 								</tr>
    171. 

  171. 							</tbody>
    172. 

  172. 						</table>
    173. 

  173. 						<dl class="details">
    174. 

  174. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#render">Pass#render</a></dt>
    175. 

  175. 						</dl>
    176. 

  176. 					</div>
    177. 

  177. 					<h3 class="name name-method" id="setSize" translate="no">.<a href="#setSize">setSize</a><span class="signature">( width : <span class="param-type">number</span>, height : <span class="param-type">number</span> )</span> </h3>
    178. 

  178. 					<div class="method">
    179. 

  179. 						<div class="description">
    180. 

  180. 							<p>Sets the size of the pass.</p>
    181. 

  181. 						</div>
    182. 

  182. 						<table class="params">
    183. 

  183. 							<tbody>
    184. 

  184. 								<tr>
    185. 

  185. 									<td class="name"><code>width</code></td>
    186. 

  186. 									<td class="description last"><p>The width to set.</p></td>
    187. 

  187. 								</tr>
    188. 

  188. 								<tr>
    189. 

  189. 									<td class="name"><code>height</code></td>
    190. 

  190. 									<td class="description last"><p>The height to set.</p></td>
    191. 

  191. 								</tr>
    192. 

  192. 							</tbody>
    193. 

  193. 						</table>
    194. 

  194. 						<dl class="details">
    195. 

  195. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#setSize">Pass#setSize</a></dt>
    196. 

  196. 						</dl>
    197. 

  197. 					</div>
    198. 

  198. 				<h2 class="subsection-title">Source</h2>
    199. 

  199. 				<p>
    200. 

  200. 					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/postprocessing/SSAOPass.js" target="_blank" rel="noopener" translate="no">examples/jsm/postprocessing/SSAOPass.js</a>
    201. 

  201. 				</p>
    202. 

  202. 			</article>
    203. 

  203. 		</section>
    204. 

  204. <script src="../scripts/linenumber.js"></script>
    205. 

  205. <script src="../scripts/page.js"></script>
    206. 

  206. </body>
    207. 

  207. </html>
    208.
粤ICP备19079148号