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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>OutlineEffect - 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>
	<h1 translate="no">OutlineEffect</h1>
		<section>
			<header>
				<div class="class-description"><p>An outline effect for toon shaders.</p>
<p>Note that this class can only be used with <a href="WebGLRenderer.html">WebGLRenderer</a>.
When using <a href="WebGPURenderer.html">WebGPURenderer</a>, use <a href="ToonOutlinePassNode.html">ToonOutlinePassNode</a>.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const effect = new OutlineEffect( renderer );
function render() {
	effect.render( scene, camera );
}
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">OutlineEffect</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 { OutlineEffect } from 'three/addons/effects/OutlineEffect.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="OutlineEffect" translate="no">new <a href="#OutlineEffect">OutlineEffect</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span>, parameters : <span class="param-type">OutlineEffect~Options</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new outline effect.</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>parameters</code></td>
									<td class="description last"><p>The configuration parameter.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="render" translate="no">.<a href="#render">render</a><span class="signature">( scene : <span class="param-type">Object3D</span>, camera : <span class="param-type">Camera</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>When using this effect, this method should be called instead of the
default <a href="WebGLRenderer.html#render">WebGLRenderer#render</a>.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>scene</code></td>
									<td class="description last"><p>The scene to render.</p></td>
								</tr>
								<tr>
									<td class="name"><code>camera</code></td>
									<td class="description last"><p>The camera.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="renderOutline" translate="no">.<a href="#renderOutline">renderOutline</a><span class="signature">( scene : <span class="param-type">Object3D</span>, camera : <span class="param-type">Camera</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>This method can be used to render outlines in VR.</p>
<pre><code class="language-js">const effect = new OutlineEffect( renderer );
let renderingOutline = false;
scene.onAfterRender = function () {
	if ( renderingOutline ) return;
	renderingOutline = true;
	effect.renderOutline( scene, camera );
	renderingOutline = false;
};
function render() {
	renderer.render( scene, camera );
}
</code></pre>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>scene</code></td>
									<td class="description last"><p>The scene to render.</p></td>
								</tr>
								<tr>
									<td class="name"><code>camera</code></td>
									<td class="description last"><p>The camera.</p></td>
								</tr>
							</tbody>
						</table>
					</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>Resizes the effect.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>width</code></td>
									<td class="description last"><p>The width of the effect in logical pixels.</p></td>
								</tr>
								<tr>
									<td class="name"><code>height</code></td>
									<td class="description last"><p>The height of the effect in logical pixels.</p></td>
								</tr>
							</tbody>
						</table>
					</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>This type represents configuration settings of <code>OutlineEffect</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>defaultThickness</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					0.003
				</td>
			<td class="description last"><p>The outline thickness.</p></td>
		</tr>
		<tr>
				<td class="name"><code>defaultColor</code></td>
			<td class="type">
<span class="param-type">Array.&lt;number></span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
				<td class="default">
					[0,0,0]
				</td>
			<td class="description last"><p>The outline color.</p></td>
		</tr>
		<tr>
				<td class="name"><code>defaultAlpha</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>The outline alpha value.</p></td>
		</tr>
		<tr>
				<td class="name"><code>defaultKeepAlive</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 to keep alive cached internal materials or not.</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/effects/OutlineEffect.js" target="_blank" rel="noopener" translate="no">examples/jsm/effects/OutlineEffect.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>