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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>SSRPass - 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="Pass.html">Pass</a> → </p>
	<h1 translate="no">SSRPass</h1>
		<section>
			<header>
				<div class="class-description"><p>A pass for a basic SSR effect.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const ssrPass = new SSRPass( {
	renderer,
	scene,
	camera,
	width: innerWidth,
	height: innerHeight
} );
composer.addPass( ssrPass );
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">SSRPass</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { SSRPass } from 'three/addons/postprocessing/SSRPass.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="SSRPass" translate="no">new <a href="#SSRPass">SSRPass</a><span class="signature">( options : <span class="param-type">SSRPass~Options</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new SSR pass.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>options</code></td>
									<td class="description last"><p>The pass options.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="blur" translate="no">.<a href="#blur">blur</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to blur reflections or not.<br/>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="bouncing" translate="no">.<a href="#bouncing">bouncing</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether bouncing is enabled or not.<br/>Default is <code>false</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="camera" translate="no">.<a href="#camera">camera</a><span class="type-signature"> : <a href="Camera.html">Camera</a></span> </h3>
					<div class="description">
						<p>The camera.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="clear" translate="no">.<a href="#clear">clear</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Overwritten to perform a clear operation by default.<br/>Default is <code>true</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#clear">Pass#clear</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="distanceAttenuation" translate="no">.<a href="#distanceAttenuation">distanceAttenuation</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to use distance attenuation or not.<br/>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="fresnel" translate="no">.<a href="#fresnel">fresnel</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to use fresnel or not.<br/>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="groundReflector" translate="no">.<a href="#groundReflector">groundReflector</a><span class="type-signature"> : <a href="ReflectorForSSRPass.html">ReflectorForSSRPass</a></span> </h3>
					<div class="description">
						<p>The ground reflector.<br/>Default is <code>0</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="height" translate="no">.<a href="#height">height</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The height of the effect.<br/>Default is <code>512</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="infiniteThick" translate="no">.<a href="#infiniteThick">infiniteThick</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to use infinite thickness or not.<br/>Default is <code>false</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="maxDistance" translate="no">.<a href="#maxDistance">maxDistance</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>Controls how far a fragment can reflect.<br/>Default is <code>180</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="opacity" translate="no">.<a href="#opacity">opacity</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The opacity.<br/>Default is <code>0.5</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="output" translate="no">.<a href="#output">output</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The output configuration.<br/>Default is <code>0</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="renderer" translate="no">.<a href="#renderer">renderer</a><span class="type-signature"> : <a href="WebGLRenderer.html">WebGLRenderer</a></span> </h3>
					<div class="description">
						<p>The renderer.</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. Valid values are in the range
<code>[0,1]</code>. <code>1</code> means best quality but also results in
more computational overhead. Setting to <code>0.5</code> means
the effect is computed in half-resolution.<br/>Default is <code>1</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="scene" translate="no">.<a href="#scene">scene</a><span class="type-signature"> : <a href="Scene.html">Scene</a></span> </h3>
					<div class="description">
						<p>The scene to render.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="selective" translate="no">.<a href="#selective">selective</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether the pass is selective or not.<br/>Default is <code>false</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="selects" translate="no">.<a href="#selects">selects</a><span class="type-signature"> : Array.&lt;<a href="Object3D.html">Object3D</a>></span> </h3>
					<div class="description">
						<p>Which 3D objects should be affected by SSR. If not set, the entire scene is affected.<br/>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="thickness" translate="no">.<a href="#thickness">thickness</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>Controls the cutoff between what counts as a
possible reflection hit and what does not.<br/>Default is <code>.018</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="width" translate="no">.<a href="#width">width</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The width of the effect.<br/>Default is <code>512</code>.</p>
					</div>
				</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 the GPU-related resources allocated by this instance. Call this
method whenever the pass is no longer used in your app.</p>
						</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#dispose">Pass#dispose</a></dt>
						</dl>
					</div>
					<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>
					<div class="method">
						<div class="description">
							<p>Performs the SSR pass.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>renderer</code></td>
									<td class="description last"><p>The renderer.</p></td>
								</tr>
								<tr>
									<td class="name"><code>writeBuffer</code></td>
									<td class="description last"><p>The write buffer. This buffer is intended as the rendering
destination for the pass.</p></td>
								</tr>
								<tr>
									<td class="name"><code>readBuffer</code></td>
									<td class="description last"><p>The read buffer. The pass can access the result from the
previous pass from this buffer.</p></td>
								</tr>
								<tr>
									<td class="name"><code>deltaTime</code></td>
									<td class="description last"><p>The delta time in seconds.</p></td>
								</tr>
								<tr>
									<td class="name"><code>maskActive</code></td>
									<td class="description last"><p>Whether masking is active or not.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#render">Pass#render</a></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 pass.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>width</code></td>
									<td class="description last"><p>The width to set.</p></td>
								</tr>
								<tr>
									<td class="name"><code>height</code></td>
									<td class="description last"><p>The height to set.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Pass.html#setSize">Pass#setSize</a></dt>
						</dl>
					</div>
				<h2 class="subsection-title">Type Definitions</h2>
				<div class="member">
					<h3 class="name" id="~Options" translate="no">.<a href="#~Options">Options</a> </h3>
					<div class="description">
						<p>Constructor options of <code>SSRPass</code>.</p>
					</div>
						<h5 class="subsection-title">Properties:</h5>
<table class="props">
	<thead>
	<tr>
		<th>Name</th>
		<th>Type</th>
		<th>Attributes</th>
		<th>Default</th>
		<th class="last">Description</th>
	</tr>
	</thead>
	<tbody>
		<tr>
				<td class="name"><code>renderer</code></td>
			<td class="type">
<span class="param-type"><a href="WebGLRenderer.html">WebGLRenderer</a></span>
			</td>
				<td class="attributes">
				</td>
				<td class="default">
				</td>
			<td class="description last"><p>The renderer.</p></td>
		</tr>
		<tr>
				<td class="name"><code>scene</code></td>
			<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
			</td>
				<td class="attributes">
				</td>
				<td class="default">
				</td>
			<td class="description last"><p>The scene to render.</p></td>
		</tr>
		<tr>
				<td class="name"><code>camera</code></td>
			<td class="type">
<span class="param-type"><a href="Camera.html">Camera</a></span>
			</td>
				<td class="attributes">
				</td>
				<td class="default">
				</td>
			<td class="description last"><p>The camera.</p></td>
		</tr>
		<tr>
				<td class="name"><code>width</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					512
				</td>
			<td class="description last"><p>The width of the effect.</p></td>
		</tr>
		<tr>
				<td class="name"><code>height</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					512
				</td>
			<td class="description last"><p>The width of the effect.</p></td>
		</tr>
		<tr>
				<td class="name"><code>selects</code></td>
			<td class="type">
<span class="param-type">Array.&lt;<a href="Object3D.html">Object3D</a>></span>
			</td>
				<td class="attributes">
					&lt;optional><br>
					&lt;nullable><br>
				</td>
				<td class="default">
					null
				</td>
			<td class="description last"><p>Which 3D objects should be affected by SSR. If not set, the entire scene is affected.</p></td>
		</tr>
		<tr>
				<td class="name"><code>bouncing</code></td>
			<td class="type">
<span class="param-type">boolean</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					false
				</td>
			<td class="description last"><p>Whether bouncing is enabled or not.</p></td>
		</tr>
		<tr>
				<td class="name"><code>groundReflector</code></td>
			<td class="type">
<span class="param-type"><a href="ReflectorForSSRPass.html">ReflectorForSSRPass</a></span>
			</td>
				<td class="attributes">
					&lt;optional><br>
					&lt;nullable><br>
				</td>
				<td class="default">
					null
				</td>
			<td class="description last"><p>A ground reflector.</p></td>
		</tr>
	</tbody>
</table>
				</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/postprocessing/SSRPass.js" target="_blank" rel="noopener" translate="no">examples/jsm/postprocessing/SSRPass.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>