samien
/
three.js
зеркало из https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>GodraysNode - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Node.html">Node</a> → <a href="TempNode.html">TempNode</a> → </p>
	<h1 translate="no">GodraysNode</h1>
		<section>
			<header>
				<div class="class-description"><p>Post-Processing node for apply Screen-space raymarched godrays to a scene.</p>
<p>After the godrays have been computed, it's recommened to apply a Bilateral
Blur to the result to mitigate raymarching and noise artifacts.</p>
<p>The composite with the scene pass is ideally done with <code>depthAwareBlend()</code>,
which mitigates aliasing and light leaking.</p>
<p>Limitations:</p>
<ul>
<li>Only point and directional lights are currently supported.</li>
<li>The effect requires a full shadow setup. Meaning shadows must be enabled in the renderer,
3D objects must cast and receive shadows and the main light must cast shadows.</li>
</ul>
<p>Reference: This Node is a part of <a href="https://github.com/Ameobea/three-good-godrays" target="_blank" rel="noopener">three-good-godrays</a>.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const godraysPass = godrays( scenePassDepth, camera, light );
const blurPass = bilateralBlur( godraysPassColor ); // optional blur
const outputBlurred = depthAwareBlend( scenePassColor, blurPassColor, scenePassDepth, camera, { blendColor, edgeRadius, edgeStrength } ); // composite
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">GodraysNode</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>
				<pre><code class="language-js">import { godrays } from 'three/addons/tsl/display/GodraysNode.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="GodraysNode" translate="no">new <a href="#GodraysNode">GodraysNode</a><span class="signature">( depthNode : <span class="param-type"><a href="TextureNode.html">TextureNode</a></span>, camera : <span class="param-type"><a href="Camera.html">Camera</a></span>, light : <span class="param-type"><a href="DirectionalLight.html">DirectionalLight</a> | <a href="PointLight.html">PointLight</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new Godrays node.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">depthNode</strong>
									</td>
									<td class="description last">
										<p>A texture node that represents the scene's depth.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">camera</strong>
									</td>
									<td class="description last">
										<p>The camera the scene is rendered with.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">light</strong>
									</td>
									<td class="description last">
										<p>The light the godrays are rendered for.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="density" translate="no">.<a href="#density">density</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
					<div class="description">
						<p>The rate of accumulation for the godrays.  Higher values roughly equate to more humid air/denser fog.</p>
						<p>Default is <code>0.7</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="depthNode" translate="no">.<a href="#depthNode">depthNode</a><span class="type-signature"> : <a href="TextureNode.html">TextureNode</a></span> </h3>
					<div class="description">
						<p>A node that represents the beauty pass's depth.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="distanceAttenuation" translate="no">.<a href="#distanceAttenuation">distanceAttenuation</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
					<div class="description">
						<p>Higher values decrease the accumulation of godrays the further away they are from the light source.</p>
						<p>Default is <code>2</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="maxDensity" translate="no">.<a href="#maxDensity">maxDensity</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
					<div class="description">
						<p>The maximum density of the godrays.  Limits the maximum brightness of the godrays.</p>
						<p>Default is <code>0.5</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="raymarchSteps" translate="no">.<a href="#raymarchSteps">raymarchSteps</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;uint></span> </h3>
					<div class="description">
						<p>The number of raymarching steps</p>
						<p>Default is <code>60</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="resolutionScale" translate="no">.<a href="#resolutionScale">resolutionScale</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The resolution scale.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="updateBeforeType" translate="no">.<a href="#updateBeforeType">updateBeforeType</a><span class="type-signature"> : string</span> </h3>
					<div class="description">
						<p>The <code>updateBeforeType</code> is set to <code>NodeUpdateType.FRAME</code> since the node renders
its effect once per frame in <code>updateBefore()</code>.</p>
						<p>Default is <code>'frame'</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#updateBeforeType">TempNode#updateBeforeType</a></dt>
						</dl>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Frees internal resources. This method should be called
when the effect is no longer required.</p>
						</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#dispose">TempNode#dispose</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="getTextureNode" translate="no">.<a href="#getTextureNode">getTextureNode</a><span class="signature">()</span><span class="type-signature"> : <a href="PassTextureNode.html">PassTextureNode</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the result of the effect as a texture node.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A texture node that represents the result of the effect.</dt>
						</dl>
					</div>
					<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>
					<div class="method">
						<div class="description">
							<p>Sets the size of the effect.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">width</strong>
									</td>
									<td class="description last">
										<p>The width of the effect.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">height</strong>
									</td>
									<td class="description last">
										<p>The height of the effect.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="setup" translate="no">.<a href="#setup">setup</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : <a href="PassTextureNode.html">PassTextureNode</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>This method is used to setup the effect's TSL code.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">builder</strong>
									</td>
									<td class="description last">
										<p>The current node builder.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#setup">TempNode#setup</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="updateBefore" translate="no">.<a href="#updateBefore">updateBefore</a><span class="signature">( frame : <span class="param-type"><a href="NodeFrame.html">NodeFrame</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>This method is used to render the effect once per frame.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">frame</strong>
									</td>
									<td class="description last">
										<p>The current node frame.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#updateBefore">TempNode#updateBefore</a></dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/tsl/display/GodraysNode.js" translate="no" target="_blank" rel="noopener">examples/jsm/tsl/display/GodraysNode.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>