Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Moved shadow docs to lights/shadows folder

Lewy Blue 8 years ago
parent
61736b1696
commit
abf9a82b6a
4 changed files with 149 additions and 149 deletions
Unified View Show Diff Stats
  1. 33 33
      docs/api/lights/shadows/DirectionalLightShadow.html
  2. 75 75
      docs/api/lights/shadows/LightShadow.html
  3. 38 38
      docs/api/lights/shadows/SpotLightShadow.html
  4. 3 3
      docs/list.js

+ 33 - 33
docs/api/lights/DirectionalLightShadow.html → docs/api/lights/shadows/DirectionalLightShadow.html
View File 

@@ -1,33 +1,33 @@
 
-<!DOCTYPE html>

-<html lang="en">

-	<head>

-		<meta charset="utf-8" />

-		<base href="../../" />

-		<script src="list.js"></script>

-		<script src="page.js"></script>

-		<link type="text/css" rel="stylesheet" href="page.css" />

-	</head>

-	<body>

-		[page:LightShadow] &rarr;

-

-		<h1>[name]</h1>

-

-		<div class="desc">TODO</div>

-

-		<h2>Constructor</h2>

-

-		The constructor creates an [page:OrthographicCamera OrthographicCamera] to manage the shadow's view of the world.

-

-		<h2>Properties</h2>

-

-		See the base [page:LightShadow LightShadow] class for common properties.

-

-		<h2>Methods</h2>

-

-		See the base [page:LightShadow LightShadow] class for common methods.

-

-		<h2>Source</h2>

-

-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

-	</body>

-</html>

+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8" />
 
+		<base href="../../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		[page:LightShadow] &rarr;
 
+
 
+		<h1>[name]</h1>
 
+
 
+		<div class="desc">TODO</div>
 
+
 
+		<h2>Constructor</h2>
 
+
 
+		The constructor creates an [page:OrthographicCamera OrthographicCamera] to manage the shadow's view of the world.
 
+
 
+		<h2>Properties</h2>
 
+
 
+		See the base [page:LightShadow LightShadow] class for common properties.
 
+
 
+		<h2>Methods</h2>
 
+
 
+		See the base [page:LightShadow LightShadow] class for common methods.
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 75 - 75
docs/api/lights/LightShadow.html → docs/api/lights/shadows/LightShadow.html
View File 

@@ -1,75 +1,75 @@
 
-<!DOCTYPE html>

-<html lang="en">

-	<head>

-		<meta charset="utf-8" />

-		<base href="../../" />

-		<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]( [page:Camera camera] )</h3>

-		<div>

-		[page:Camera camera] — The shadow's view of the world.

-		</div>

-

-		<h2>Properties</h2>

-

-		<h3>[property:Camera camera]</h3>

-		<div>

-			The shadow's view of the world.

-		</div>

-

-		<h3>[property:Float bias]</h3>

-		<div>

-			Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.<br />

-			Default — *0*.

-		</div>

-

-		<h3>[property:Float radius]</h3>

-		<div>

-			TODO<br />

-			Default - *0*.

-		</div>

-

-		<h3>[property:Vector2 mapSize]</h3>

-		<div>

-			The width and height of the shadow map stored in a [page:Vector2 Vector2].<br />

-			Default — *( 512, 512 )*.

-		</div>

-

-		<h3>[property:WebGLRenderTarget map]</h3>

-		<div>

-			The depth map generated using the internal camera; a location beyond a pixel's depth is in shadow. Computed internally during rendering.

-		</div>

-

-		<h3>[property:Matrix4 matrix]</h3>

-		<div>

-			Model to shadow camera space, to compute location and depth in shadow map. Stored in a [page:Matrix4 Matrix4]. Computed internally during rendering.

-		</div>

-

-

-		<h2>Methods</h2>

-		<h3>[method:LightShadow copy]( [page:LightShadow source] )</h3>

-		<div>

-		Copies value of *source* to this LightShadow object.

-		</div>

-

-		<h3>[method:LightShadow clone]()</h3>

-		<div>

-		It returns a clone of LightShadow.

-		</div>

-

-		<h2>Source</h2>

-

-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

-	</body>

-</html>

+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8" />
 
+		<base href="../../../" />
 
+		<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]( [page:Camera camera] )</h3>
 
+		<div>
 
+		[page:Camera camera] — The shadow's view of the world.
 
+		</div>
 
+
 
+		<h2>Properties</h2>
 
+
 
+		<h3>[property:Camera camera]</h3>
 
+		<div>
 
+			The shadow's view of the world.
 
+		</div>
 
+
 
+		<h3>[property:Float bias]</h3>
 
+		<div>
 
+			Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.<br />
 
+			Default — *0*.
 
+		</div>
 
+
 
+		<h3>[property:Float radius]</h3>
 
+		<div>
 
+			TODO<br />
 
+			Default - *0*.
 
+		</div>
 
+
 
+		<h3>[property:Vector2 mapSize]</h3>
 
+		<div>
 
+			The width and height of the shadow map stored in a [page:Vector2 Vector2].<br />
 
+			Default — *( 512, 512 )*.
 
+		</div>
 
+
 
+		<h3>[property:WebGLRenderTarget map]</h3>
 
+		<div>
 
+			The depth map generated using the internal camera; a location beyond a pixel's depth is in shadow. Computed internally during rendering.
 
+		</div>
 
+
 
+		<h3>[property:Matrix4 matrix]</h3>
 
+		<div>
 
+			Model to shadow camera space, to compute location and depth in shadow map. Stored in a [page:Matrix4 Matrix4]. Computed internally during rendering.
 
+		</div>
 
+
 
+
 
+		<h2>Methods</h2>
 
+		<h3>[method:LightShadow copy]( [page:LightShadow source] )</h3>
 
+		<div>
 
+		Copies value of *source* to this LightShadow object.
 
+		</div>
 
+
 
+		<h3>[method:LightShadow clone]()</h3>
 
+		<div>
 
+		It returns a clone of LightShadow.
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 38 - 38
docs/api/lights/SpotLightShadow.html → docs/api/lights/shadows/SpotLightShadow.html
View File 

@@ -1,38 +1,38 @@
 
-<!DOCTYPE html>

-<html lang="en">

-	<head>

-		<meta charset="utf-8" />

-		<base href="../../" />

-		<script src="list.js"></script>

-		<script src="page.js"></script>

-		<link type="text/css" rel="stylesheet" href="page.css" />

-	</head>

-	<body>

-		[page:LightShadow] &rarr;

-

-		<h1>[name]</h1>

-

-		<div class="desc">TODO</div>

-

-		<h2>Constructor</h2>

-

-		The constructor creates a [page:PerspectiveCamera PerspectiveCamera] to manage the shadow's view of the world.

-

-		<h2>Properties</h2>

-

-		See the base [page:LightShadow LightShadow] class for common properties.

-

-		<h2>Methods</h2>

-

-		See the base [page:LightShadow LightShadow] class for common methods.

-

-		<h3>[method:SpotLightShadow update]( [page:SpotLight light] )</h3>

-		<div>

-		Updates the internal perspective camera.

-		</div>

-

-		<h2>Source</h2>

-

-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

-	</body>

-</html>

+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8" />
 
+		<base href="../../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		[page:LightShadow] &rarr;
 
+
 
+		<h1>[name]</h1>
 
+
 
+		<div class="desc">TODO</div>
 
+
 
+		<h2>Constructor</h2>
 
+
 
+		The constructor creates a [page:PerspectiveCamera PerspectiveCamera] to manage the shadow's view of the world.
 
+
 
+		<h2>Properties</h2>
 
+
 
+		See the base [page:LightShadow LightShadow] class for common properties.
 
+
 
+		<h2>Methods</h2>
 
+
 
+		See the base [page:LightShadow LightShadow] class for common methods.
 
+
 
+		<h3>[method:SpotLightShadow update]( [page:SpotLight light] )</h3>
 
+		<div>
 
+		Updates the internal perspective camera.
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 3 - 3
docs/list.js
View File 

@@ -186,9 +186,9 @@ var list = {
 
 		],
 
 		],
 
 
 
 		"Lights / Shadows": [
 
 		"Lights / Shadows": [
 
-			[ "DirectionalLightShadow", "api/lights/DirectionalLightShadow" ],
 
-			[ "LightShadow", "api/lights/LightShadow" ],
 
-			[ "SpotLightShadow", "api/lights/SpotLightShadow" ]
 
+			[ "DirectionalLightShadow", "api/lights/shadows/DirectionalLightShadow" ],
 
+			[ "LightShadow", "api/lights/shadows/LightShadow" ],
 
+			[ "SpotLightShadow", "api/lights/shadows/SpotLightShadow" ]
 
 		],
 
 		],
 
 
 
 		"Loaders": [
 
 		"Loaders": [