samien
/
three.js
mirror de https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>BokehPass - 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">BokehPass</h1>
		<section>
			<header>
				<div class="class-description"><p>Pass for creating depth of field (DOF) effect.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const bokehPass = new BokehPass( scene, camera, {
	focus: 500
	aperture: 5,
	maxblur: 0.01
} );
composer.addPass( bokehPass );
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">BokehPass</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 { BokehPass } from 'three/addons/postprocessing/BokehPass.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="BokehPass" translate="no">new <a href="#BokehPass">BokehPass</a><span class="signature">( scene : <span class="param-type">Scene</span>, camera : <span class="param-type">Camera</span>, params : <span class="param-type">BokehPass~Options</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new Bokeh pass.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>scene</code></td>
									<td class="description last"><p>The scene to render the DOF for.</p></td>
								</tr>
								<tr>
									<td class="name"><code>camera</code></td>
									<td class="description last"><p>The camera.</p></td>
								</tr>
								<tr>
									<td class="name"><code>params</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="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="materialBokeh" translate="no">.<a href="#materialBokeh">materialBokeh</a><span class="type-signature"> : <a href="ShaderMaterial.html">ShaderMaterial</a></span> </h3>
					<div class="description">
						<p>The pass bokeh material.</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 the DOF for.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="uniforms" translate="no">.<a href="#uniforms">uniforms</a><span class="type-signature"> : Object</span> </h3>
					<div class="description">
						<p>The pass uniforms.  Use this object if you want to update the
<code>focus</code>, <code>aperture</code> or <code>maxblur</code> values at runtime.</p>
<pre><code class="language-js">pass.uniforms.focus.value = focus;
pass.uniforms.aperture.value = aperture;
pass.uniforms.maxblur.value = maxblur;
</code></pre>
					</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 Bokeh 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>BokehPass</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>focus</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					1
				</td>
			<td class="description last"><p>Defines the effect's focus which is the distance along the camera's look direction in world units.</p></td>
		</tr>
		<tr>
				<td class="name"><code>aperture</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					0.025
				</td>
			<td class="description last"><p>Defines the effect's aperture.</p></td>
		</tr>
		<tr>
				<td class="name"><code>maxblur</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					1
				</td>
			<td class="description last"><p>Defines the effect's maximum blur.</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/BokehPass.js" target="_blank" rel="noopener" translate="no">examples/jsm/postprocessing/BokehPass.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>