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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>ComputeNode - 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> → </p>
	<h1 translate="no">ComputeNode</h1>
		<section>
			<header>
				<div class="class-description"><p>TODO</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="ComputeNode" translate="no">new <a href="#ComputeNode">ComputeNode</a><span class="signature">( computeNode : <span class="param-type">Node</span>, workgroupSize : <span class="param-type">Array.&lt;number></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new compute node.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>TODO</p></td>
								</tr>
								<tr>
									<td class="name"><code>workgroupSize</code></td>
									<td class="description last"><p>TODO.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="computeNode" translate="no">.<a href="#computeNode">computeNode</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
					<div class="description">
						<p>TODO</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="count" translate="no">.<a href="#count">count</a><span class="type-signature"> : number | Array.&lt;number></span> </h3>
					<div class="description">
						<p>TODO</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="isComputeNode" translate="no">.<a href="#isComputeNode">isComputeNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="name" translate="no">.<a href="#name">name</a><span class="type-signature"> : string</span> </h3>
					<div class="description">
						<p>The name or label of the uniform.<br/>Default is <code>''</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#name">Node#name</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="onInitFunction" translate="no">.<a href="#onInitFunction">onInitFunction</a><span class="type-signature"> : function</span> </h3>
					<div class="description">
						<p>TODO</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.OBJECT</code> since <a href="ComputeNode.html#updateBefore">ComputeNode#updateBefore</a>
is executed once per object by default.<br/>Default is <code>'object'</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#updateBeforeType">Node#updateBeforeType</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="version" translate="no">.<a href="#version">version</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>TODO</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#version">Node#version</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="workgroupSize" translate="no">.<a href="#workgroupSize">workgroupSize</a><span class="type-signature"> : Array.&lt;number></span> </h3>
					<div class="description">
						<p>TODO<br/>Default is <code>[ 64 ]</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>Executes the <code>dispose</code> event for this node.</p>
						</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#dispose">Node#dispose</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="getCount" translate="no">.<a href="#getCount">getCount</a><span class="signature">()</span><span class="type-signature"> : number | Array.&lt;number></span> </h3>
					<div class="method">
						<div class="description">
							<p>TODO</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> </dt>
						</dl>
					</div>
					<h3 class="name name-method" id="label" translate="no">.<a href="#label">label</a><span class="signature">( name : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the <a href="ComputeNode.html#name">ComputeNode#name</a> property.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>name</code></td>
									<td class="description last"><p>The name of the uniform.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="important tag-deprecated"><strong>Deprecated:</strong> Yes</dt>
						</dl>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="onInit" translate="no">.<a href="#onInit">onInit</a><span class="signature">( callback : <span class="param-type">function</span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>TODO</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>callback</code></td>
									<td class="description last"><p>TODO.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setCount" translate="no">.<a href="#setCount">setCount</a><span class="signature">( count : <span class="param-type">number | Array.&lt;number></span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>TODO</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>count</code></td>
									<td class="description last"><p>Array with [ x, y, z ] values for dispatch or a single number for the count</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> </dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setName" translate="no">.<a href="#setName">setName</a><span class="signature">( name : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the <a href="ComputeNode.html#name">ComputeNode#name</a> property.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>name</code></td>
									<td class="description last"><p>The name of the uniform.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</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">NodeFrame</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>The method execute the compute for this node.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>frame</code></td>
									<td class="description last"><p>A reference to the current node frame.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#updateBefore">Node#updateBefore</a></dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/gpgpu/ComputeNode.js" target="_blank" rel="noopener" translate="no">src/nodes/gpgpu/ComputeNode.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>