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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>Info - 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">Info</h1>
		<section>
			<header>
				<div class="class-description"><p>This renderer module provides a series of statistical information
about the GPU memory and the rendering process. Useful for debugging
and monitoring.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="Info" translate="no">new <a href="#Info">Info</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new info component.</p>
						</div>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="autoReset" translate="no">.<a href="#autoReset">autoReset</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether frame related metrics should automatically
be resetted or not. This property should be set to <code>false</code>
by apps which manage their own animation loop. They must
then call <code>renderer.info.reset()</code> once per frame manually.<br/>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="calls" translate="no">.<a href="#calls">calls</a><span class="type-signature"> : number</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>The number of render calls since the
app has been started.<br/>Default is <code>0</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="compute" translate="no">.<a href="#compute">compute</a><span class="type-signature"> : Object</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>Compute related metrics.</p>
					</div>
						<h5 class="subsection-title">Properties:</h5>
<table class="props">
	<thead>
	<tr>
		<th>Name</th>
		<th>Type</th>
		<th class="last">Description</th>
	</tr>
	</thead>
	<tbody>
		<tr>
				<td class="name"><code>calls</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of compute calls since the app has been started.</p></td>
		</tr>
		<tr>
				<td class="name"><code>frameCalls</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of compute calls of the current frame.</p></td>
		</tr>
		<tr>
				<td class="name"><code>timestamp</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The timestamp of the frame when using <code>renderer.computeAsync()</code>.</p></td>
		</tr>
	</tbody>
</table>
				</div>
				<div class="member">
					<h3 class="name" id="frame" translate="no">.<a href="#frame">frame</a><span class="type-signature"> : number</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>The current frame ID. This ID is managed
by <code>NodeFrame</code>.<br/>Default is <code>0</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="memory" translate="no">.<a href="#memory">memory</a><span class="type-signature"> : Object</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>Memory related metrics.</p>
					</div>
						<h5 class="subsection-title">Properties:</h5>
<table class="props">
	<thead>
	<tr>
		<th>Name</th>
		<th>Type</th>
		<th class="last">Description</th>
	</tr>
	</thead>
	<tbody>
		<tr>
				<td class="name"><code>geometries</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of active geometries.</p></td>
		</tr>
		<tr>
				<td class="name"><code>frameCalls</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of active textures.</p></td>
		</tr>
	</tbody>
</table>
				</div>
				<div class="member">
					<h3 class="name" id="render" translate="no">.<a href="#render">render</a><span class="type-signature"> : Object</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>Render related metrics.</p>
					</div>
						<h5 class="subsection-title">Properties:</h5>
<table class="props">
	<thead>
	<tr>
		<th>Name</th>
		<th>Type</th>
		<th class="last">Description</th>
	</tr>
	</thead>
	<tbody>
		<tr>
				<td class="name"><code>calls</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of render calls since the app has been started.</p></td>
		</tr>
		<tr>
				<td class="name"><code>frameCalls</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of render calls of the current frame.</p></td>
		</tr>
		<tr>
				<td class="name"><code>drawCalls</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of draw calls of the current frame.</p></td>
		</tr>
		<tr>
				<td class="name"><code>triangles</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of rendered triangle primitives of the current frame.</p></td>
		</tr>
		<tr>
				<td class="name"><code>points</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of rendered point primitives of the current frame.</p></td>
		</tr>
		<tr>
				<td class="name"><code>lines</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The number of rendered line primitives of the current frame.</p></td>
		</tr>
		<tr>
				<td class="name"><code>timestamp</code></td>
			<td class="type">
<span class="param-type">number</span>
			</td>
			<td class="description last"><p>The timestamp of the frame.</p></td>
		</tr>
	</tbody>
</table>
				</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>Performs a complete reset of the object.</p>
						</div>
					</div>
					<h3 class="name name-method" id="reset" translate="no">.<a href="#reset">reset</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Resets frame related metrics.</p>
						</div>
					</div>
					<h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">( object : <span class="param-type">Object3D</span>, count : <span class="param-type">number</span>, instanceCount : <span class="param-type">number</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>This method should be executed per draw call and updates the corresponding metrics.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>object</code></td>
									<td class="description last"><p>The 3D object that is going to be rendered.</p></td>
								</tr>
								<tr>
									<td class="name"><code>count</code></td>
									<td class="description last"><p>The vertex or index count.</p></td>
								</tr>
								<tr>
									<td class="name"><code>instanceCount</code></td>
									<td class="description last"><p>The instance count.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/common/Info.js" target="_blank" rel="noopener" translate="no">src/renderers/common/Info.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>