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


			
				
					
						
						
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>RecurrentDenoiseNode - 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">RecurrentDenoiseNode</h1>
		<section>
			<header>
				<div class="class-description"><p>Post processing node for denoising temporally-accumulated screen-space effects
such as SSGI (ambient occlusion / indirect diffuse) and SSR (specular reflections).</p>
<p>The denoising kernel is selected at construction time via <code>mode</code>:
<code>'diffuse'</code> (SSGI) or <code>'specular'</code> (SSR). The kernel uses a fixed 8-sample Vogel disk.</p></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">RecurrentDenoiseNode</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 { recurrentDenoise } from 'three/addons/tsl/display/RecurrentDenoiseNode.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="RecurrentDenoiseNode" translate="no">new <a href="#RecurrentDenoiseNode">RecurrentDenoiseNode</a><span class="signature">( inputTexture : <span class="param-type"><a href="TextureNode.html">TextureNode</a></span>, camera : <span class="param-type"><a href="Camera.html">Camera</a></span>, options : <span class="param-type"><a href="global.html#RecurrentDenoiseNodeOptions">RecurrentDenoiseNodeOptions</a></span> )</span> </h3>
					<div class="method">
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">inputTexture</strong>
									</td>
									<td class="description last">
										<p>Temporally filtered input to denoise (e.g. TRAA output).</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">camera</strong>
									</td>
									<td class="description last">
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">options</strong>
									</td>
									<td class="description last">
										<p>Default is <code>{}</code>.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="accumulate" translate="no">.<a href="#accumulate">accumulate</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>When <code>true</code>, apply temporal blending after spatial denoising. When <code>false</code>, output spatially
filtered colour only (alpha is passed through from the input temporal pass).</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="alphaSource" translate="no">.<a href="#alphaSource">alphaSource</a><span class="type-signature"> : <a href="global.html#DenoiseAlphaSource">DenoiseAlphaSource</a></span> </h3>
					<div class="description">
						<p>Which channel of the raw texture drives alpha-based edge stopping.
<code>'raylength'</code> — alpha encodes SSR ray length; <code>'ao'</code> — alpha encodes AO factor;
<code>'none'</code> — skip alpha-based edge stopping.</p>
						<p>Default is <code>'raylength'</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="mode" translate="no">.<a href="#mode">mode</a><span class="type-signature"> : <a href="global.html#DenoiseMode">DenoiseMode</a></span> </h3>
					<div class="description">
						<p>Denoising kernel type.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="getRenderTarget" translate="no">.<a href="#getRenderTarget">getRenderTarget</a><span class="signature">()</span><span class="type-signature"> : <a href="RenderTarget.html">RenderTarget</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the internal output render target (e.g. for temporal reprojection/SSGI temporal feedback loops).</p>
						</div>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/tsl/display/RecurrentDenoiseNode.js" translate="no" target="_blank" rel="noopener">examples/jsm/tsl/display/RecurrentDenoiseNode.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>