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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663
							<!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.</p>
						<p>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.</p>
						<p>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>
<table class="props">
	<tbody>
		<tr>
				<td class="name">
					<strong>calls</strong>
						<br>
<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">
					<strong>frameCalls</strong>
						<br>
<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">
					<strong>timestamp</strong>
						<br>
<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>.</p>
						<p>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>
<table class="props">
	<tbody>
		<tr>
				<td class="name">
					<strong>attributes</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active attributes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>attributesSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active attributes in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>geometries</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active geometries.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>indexAttributes</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active index attributes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>indexAttributesSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active index attributes in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>indirectStorageAttributes</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active indirect storage attributes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>indirectStorageAttributesSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active indirect storage attributes in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>programs</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active programs.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>programsSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active programs in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>readbackBuffers</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active readback buffers.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>readbackBuffersSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active readback buffers in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>renderTargets</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active renderTargets.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>storageAttributes</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active storage attributes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>storageAttributesSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active storage attributes in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>textures</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active textures.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>texturesSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active textures in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>uniformBuffers</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The number of active uniform buffers.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>uniformBuffersSize</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The memory size of active uniform buffers in bytes.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>total</strong>
						<br>
<span class="param-type">number</span>
				</td>
			<td class="description last">
				<p>The total memory size in bytes.</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>
<table class="props">
	<tbody>
		<tr>
				<td class="name">
					<strong>calls</strong>
						<br>
<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">
					<strong>frameCalls</strong>
						<br>
<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">
					<strong>drawCalls</strong>
						<br>
<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">
					<strong>triangles</strong>
						<br>
<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">
					<strong>points</strong>
						<br>
<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">
					<strong>lines</strong>
						<br>
<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">
					<strong>timestamp</strong>
						<br>
<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="createAttribute" translate="no">.<a href="#createAttribute">createAttribute</a><span class="signature">( attribute : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks a regular attribute memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">attribute</strong>
									</td>
									<td class="description last">
										<p>The attribute to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createIndexAttribute" translate="no">.<a href="#createIndexAttribute">createIndexAttribute</a><span class="signature">( attribute : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks an index attribute memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">attribute</strong>
									</td>
									<td class="description last">
										<p>The index attribute to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createIndirectStorageAttribute" translate="no">.<a href="#createIndirectStorageAttribute">createIndirectStorageAttribute</a><span class="signature">( attribute : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks an indirect storage attribute memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">attribute</strong>
									</td>
									<td class="description last">
										<p>The indirect storage attribute to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createProgram" translate="no">.<a href="#createProgram">createProgram</a><span class="signature">( program : <span class="param-type"><a href="ProgrammableStage.html">ProgrammableStage</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks program memory explicitly, updating counts and byte tracking.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">program</strong>
									</td>
									<td class="description last">
										<p>The program to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createReadbackBuffer" translate="no">.<a href="#createReadbackBuffer">createReadbackBuffer</a><span class="signature">( readbackBuffer : <span class="param-type"><a href="ReadbackBuffer.html">ReadbackBuffer</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks a readback buffer memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">readbackBuffer</strong>
									</td>
									<td class="description last">
										<p>The readback buffer to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createStorageAttribute" translate="no">.<a href="#createStorageAttribute">createStorageAttribute</a><span class="signature">( attribute : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks a storage attribute memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">attribute</strong>
									</td>
									<td class="description last">
										<p>The storage attribute to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createTexture" translate="no">.<a href="#createTexture">createTexture</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks texture memory explicitly, updating counts and byte tracking.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">texture</strong>
									</td>
									<td class="description last">
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="createUniformBuffer" translate="no">.<a href="#createUniformBuffer">createUniformBuffer</a><span class="signature">( uniformBuffer : <span class="param-type"><a href="UniformBuffer.html">UniformBuffer</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks a uniform buffer memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">uniformBuffer</strong>
									</td>
									<td class="description last">
										<p>The uniform buffer to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="destroyAttribute" translate="no">.<a href="#destroyAttribute">destroyAttribute</a><span class="signature">( attribute : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks attribute memory explicitly, updating counts and byte tracking.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">attribute</strong>
									</td>
									<td class="description last">
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="destroyProgram" translate="no">.<a href="#destroyProgram">destroyProgram</a><span class="signature">( program : <span class="param-type">Object</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks program memory explicitly, updating counts and byte tracking.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">program</strong>
									</td>
									<td class="description last">
										<p>The program to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="destroyReadbackBuffer" translate="no">.<a href="#destroyReadbackBuffer">destroyReadbackBuffer</a><span class="signature">( readbackBuffer : <span class="param-type"><a href="ReadbackBuffer.html">ReadbackBuffer</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks a readback buffer memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">readbackBuffer</strong>
									</td>
									<td class="description last">
										<p>The readback buffer to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="destroyTexture" translate="no">.<a href="#destroyTexture">destroyTexture</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks texture memory explicitly, updating counts and byte tracking.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">texture</strong>
									</td>
									<td class="description last">
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="destroyUniformBuffer" translate="no">.<a href="#destroyUniformBuffer">destroyUniformBuffer</a><span class="signature">( uniformBuffer : <span class="param-type"><a href="UniformBuffer.html">UniformBuffer</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Tracks a uniform buffer memory explicitly.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">uniformBuffer</strong>
									</td>
									<td class="description last">
										<p>The uniform buffer to track.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<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"><a href="Object3D.html">Object3D</a></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">
										<strong translate="no">object</strong>
									</td>
									<td class="description last">
										<p>The 3D object that is going to be rendered.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">count</strong>
									</td>
									<td class="description last">
										<p>The vertex or index count.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">instanceCount</strong>
									</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" translate="no" target="_blank" rel="noopener">src/renderers/common/Info.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>