javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Texture] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			This class can only be used in combination with
			[page:WebGLRenderer.copyFramebufferToTexture]().
		</p>

		<code>
			const pixelRatio = window.devicePixelRatio;
			const textureSize = 128 * pixelRatio;

			// instantiate a framebuffer texture
			const frameTexture = new FramebufferTexture( textureSize, textureSize, RGBAFormat );
	
			// calculate start position for copying part of the frame data
			const vector = new Vector2();
			vector.x = ( window.innerWidth * pixelRatio / 2 ) - ( textureSize / 2 );
			vector.y = ( window.innerHeight * pixelRatio / 2 ) - ( textureSize / 2 );

			// render the scene
			renderer.clear();
			renderer.render( scene, camera );

			// copy part of the rendered frame into the framebuffer texture
			renderer.copyFramebufferToTexture( vector, frameTexture );
		</code>

		<h2>Examples</h2>

		<p>[example:webgl_framebuffer_texture]</p>

		<h2>Constructor</h2>

		<h3>
			[name]( [param:Number width], [param:Number height], [param:Constant format] )
		</h3>
		<p>
			[page:Number width] -- The width of the texture.<br />

			[page:Number height] -- The height of the texture.<br />

			[page:Constant format] -- The format used in the texture. See
			[page:Textures format constants] for other choices.<br />
		</p>

		<h2>Properties</h2>

		<p>See the base [page:Texture Texture] class for common properties.</p>

		<h3>[property:Boolean generateMipmaps]</h3>
		<p>Whether to generate mipmaps for the [name]. Default value is `false`.</p>

		<h3>[property:Boolean isFramebufferTexture]</h3>
		<p>Read-only flag to check if a given object is of type [name].</p>

		<h3>[property:number magFilter]</h3>
		<p>
			How the texture is sampled when a texel covers more than one pixel. The
			default is [page:Textures THREE.NearestFilter], which uses the value of
			the closest texel.
			<br /><br />

			See [page:Textures texture constants] for details.
		</p>

		<h3>[property:number minFilter]</h3>
		<p>
			How the texture is sampled when a texel covers less than one pixel. The
			default is [page:Textures THREE.NearestFilter], which uses the value of
			the closest texel.
			<br /><br />

			See [page:Textures texture constants] for details.
		</p>

		<h3>[property:Boolean needsUpdate]</h3>

		<p>True by default. This is required so that the canvas data is loaded.</p>

		<h2>Methods</h2>

		<p>See the base [page:Texture Texture] class for common methods.</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>