Explorar el Código

Updated docs.

Mr.doob hace 10 años
padre
commit
ed19c0d122

+ 0 - 72
docs/api/extras/renderers/plugins/DepthPassPlugin.html

@@ -1,72 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-	<head>
-		<meta charset="utf-8" />
-		<script src="../../../../list.js"></script>
-		<script src="../../../../page.js"></script>
-		<link type="text/css" rel="stylesheet" href="../../../../page.css" />
-	</head>
-	<body>
-		<h1>[name]</h1>
-
-		<div class="desc">todo</div>
-
-
-		<h2>Constructor</h2>
-
-
-		<h3>[name]()</h3>
-		<div>
-		todo
-		</div>
-
-
-		<h2>Properties</h2>
-
-
-
-		<h3>[property:boolean enabled]</h3>
-		<div>
-		todo
-		</div> 
-
-		<h3>[property:object renderTarget]</h3>
-		<div>
-		todo
-		</div> 
-
-		<h2>Methods</h2>
-
-
-
-		<h3>[method:todo init]([page:todo renderer])</h3>
-		<div>
-		renderer -- todo
-		</div>
-		<div>
-		todo
-		</div>
-
-		<h3>[method:todo update]([page:todo scene], [page:todo camera])</h3>
-		<div>
-		scene -- todo <br />
-		camera -- todo
-		</div>
-		<div>
-		todo
-		</div>
-
-		<h3>[method:todo render]([page:todo scene], [page:todo camera])</h3>
-		<div>
-		scene -- todo <br />
-		camera -- todo
-		</div>
-		<div>
-		todo
-		</div>
-
-		<h2>Source</h2>
-
-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
-	</body>
-</html>

+ 0 - 36
docs/api/extras/shaders/ShaderFlares.html

@@ -1,36 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-	<head>
-		<meta charset="utf-8" />
-		<script src="../../../list.js"></script>
-		<script src="../../../page.js"></script>
-		<link type="text/css" rel="stylesheet" href="../../../page.css" />
-	</head>
-	<body>
-		<h1>[name]</h1>
-
-		<div class="desc">
-		Contains the shader code fragments of the lensflare implementations. 
-		These shouldn't be edited.
-		</div>
-
-
-		<h2>Properties</h2>
-
-
-		<h3>[property:object lensFlare]</h3>
-		<div>
-		The object that contains the vertex code and fragment code of the lensflares implementation when there are no vertex textures available. 
-		</div> 
-
-		<h3>[property:object lensFlareVertexTexture]</h3>
-		<div>
-		The object that contains the vertex code and fragment code of the lensflares implementation when there are vertex textures available.
-		</div> 
-
-
-		<h2>Source</h2>
-
-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
-	</body>
-</html>

+ 3 - 3
docs/api/extras/objects/LensFlare.html → docs/api/objects/LensFlare.html

@@ -2,9 +2,9 @@
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
-		<script src="../../../list.js"></script>
-		<script src="../../../page.js"></script>
-		<link type="text/css" rel="stylesheet" href="../../../page.css" />
+		<script src="../../list.js"></script>
+		<script src="../../page.js"></script>
+		<link type="text/css" rel="stylesheet" href="../../page.css" />
 	</head>
 	<body>
 		[page:Object3D] &rarr;

+ 0 - 12
docs/api/extras/renderers/plugins/LensFlarePlugin.html → docs/api/renderers/webgl/plugins/LensFlarePlugin.html

@@ -14,26 +14,14 @@
 
 		<h2>Constructor</h2>
 
-
 		<h3>[name]()</h3>
 		<div>
 		Creates a new [name]. 
 		</div>
 
 
-
 		<h2>Methods</h2>
 
-
-
-		<h3>[method:todo init]([page:WebglRenderer renderer])</h3>
-		<div>
-		renderer -- The WebglRenderer that uses the plugin.
-		</div>
-		<div>
-		Initializes the plugin to work with the renderer. This gets called when the plugin gets added as a plugin to the renderer.
-		</div>
-
 		<h3>[method:todo render]([page:Scene scene], [page:Camera camera], [page:Number viewportWidth], [page:Number viewportHeight])</h3>
 		<div>
 		scene -- The scene to render. <br />

+ 0 - 13
docs/api/extras/renderers/plugins/ShadowMapPlugin.html → docs/api/renderers/webgl/plugins/ShadowMapPlugin.html

@@ -12,11 +12,8 @@
 		<div class="desc">The Webglrenderer plugin class that allows shadowmaps to be rendered in the WebglRenderer. This plugin is automatically loaded in the Webglrenderer.</div>
 
 
-
-
 		<h2>Constructor</h2>
 
-
 		<h3>[name]()</h3>
 		<div>
 		Creates a new [name]. 
@@ -25,16 +22,6 @@
 
 		<h2>Methods</h2>
 
-
-
-		<h3>[method:todo init]([page:WebGLRenderer renderer])</h3>
-		<div>
-		renderer -- The WebglRenderer that uses the plugin.
-		</div>
-		<div>
-		Initializes the plugin to work with the renderer. This gets called when the plugin gets added as a plugin to the renderer.
-		</div>
-
 		<h3>[method:todo update]([page:Scene scene], [page:Camera camera])</h3>
 		<div>
 		scene -- The scene to render. <br />

+ 2 - 16
docs/api/extras/renderers/plugins/SpritePlugin.html → docs/api/renderers/webgl/plugins/SpritePlugin.html

@@ -14,32 +14,18 @@
 
 		<h2>Constructor</h2>
 
-
 		<h3>[name]()</h3>
 		<div>
 		Creates a new [name]. 
 		</div>
 
 
-
 		<h2>Methods</h2>
 
-
-
-		<h3>[method:todo init]([page:WebglRenderer renderer])</h3>
-		<div>
-		renderer -- The WebglRenderer that uses the plugin.
-		</div>
-		<div>
-		Initializes the plugin to work with the renderer. This gets called when the plugin gets added as a plugin to the renderer.
-		</div>
-
-		<h3>[method:todo render]([page:Scene scene], [page:Camera camera], [page:Number viewportWidth], [page:Number viewportHeight])</h3>
+		<h3>[method:todo render]([page:Scene scene], [page:Camera camera])</h3>
 		<div>
 		scene -- The scene to render. <br />
-		camera -- The camera to render. <br />
-		viewportWidth -- The width of the viewport. <br />
-		viewportHeight -- The height of the viewport.
+		camera -- The camera to render.
 		</div>
 		<div>
 		Renders the sprites defined in the scene. This gets automatically called as post-render function to draw the lensflares.

+ 7 - 12
docs/list.js

@@ -98,6 +98,7 @@ var list = {
 
 		"Objects": [
 			[ "Bone", "api/objects/Bone" ],
+			[ "LensFlare", "api/objects/LensFlare" ],
 			[ "Line", "api/objects/Line" ],
 			[ "LOD", "api/objects/LOD" ],
 			[ "Mesh", "api/objects/Mesh" ],
@@ -126,6 +127,12 @@ var list = {
 			[ "WebGLShader", "api/renderers/webgl/WebGLShader" ]
 		],
 
+		"Renderers / WebGL / Plugins": [
+			[ "LensFlarePlugin", "api/renderers/webgl/plugins/LensFlarePlugin" ],
+			[ "ShadowMapPlugin", "api/renderers/webgl/plugins/ShadowMapPlugin" ],
+			[ "SpritePlugin", "api/renderers/webgl/plugins/SpritePlugin" ]
+		],
+
 		"Scenes": [
 			[ "Fog", "api/scenes/Fog" ],
 			[ "FogExp2", "api/scenes/FogExp2" ],
@@ -222,21 +229,9 @@ var list = {
 
 		"Extras / Objects": [
 			[ "ImmediateRenderObject", "api/extras/objects/ImmediateRenderObject" ],
-			[ "LensFlare", "api/extras/objects/LensFlare" ],
 			[ "MorphBlendMesh", "api/extras/objects/MorphBlendMesh" ]
 		],
 
-		"Extras / Renderers / Plugins": [
-			[ "DepthPassPlugin", "api/extras/renderers/plugins/DepthPassPlugin" ],
-			[ "LensFlarePlugin", "api/extras/renderers/plugins/LensFlarePlugin" ],
-			[ "ShadowMapPlugin", "api/extras/renderers/plugins/ShadowMapPlugin" ],
-			[ "SpritePlugin", "api/extras/renderers/plugins/SpritePlugin" ]
-		],
-
-		"Extras / Shaders": [
-			[ "ShaderFlares", "api/extras/shaders/ShaderFlares" ]
-		],
-
 		"Examples" : [
 			[ "LookupTable", "api/examples/Lut" ]