Browse Source

Document TextureLoader

sole 13 years ago
parent
commit
4ed02ff6c1
2 changed files with 61 additions and 0 deletions
  1. 60 0
      docs/api/loaders/TextureLoader.html
  2. 1 0
      docs/list.js

+ 60 - 0
docs/api/loaders/TextureLoader.html

@@ -0,0 +1,60 @@
+<!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">Class for loading a [page:Texture texture].</div>
+		<div class="desc">Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when <em>things</em> happen, you need to add listeners to the object.</div>
+
+		<h2>Constructor</h2>
+
+		<h3>[name]()</h3>
+		
+		
+		<h2>Methods</h2>
+
+		<h3>.load( [page:String url] )</h3>
+		<div>
+		url — required
+		</div>
+		
+		<div class="desc">Begin loading from <em>url</em></div>
+
+
+		<h2>Properties</h2>
+
+		<h3>.crossOrigin</h3>
+		<div>
+		default — *null*.<br />
+		If set, assigns the *crossOrigin* attribute of the image to the value of *crossOrigin*, prior to starting the load.
+		</div>
+
+		<h2>Events</h2>
+		
+		<h3>load</h3>
+		<div class="desc">
+		Dispatched when the texture has completed loading
+		</div>
+		<div>
+		content — loaded texture object
+		</div>
+		
+		<h3>error</h3>
+		<div class="desc">
+		Dispatched when the texture can't be loaded
+		</div>
+		<div>
+		message — error message
+		</div>
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>

+ 1 - 0
docs/list.js

@@ -45,6 +45,7 @@ var list = {
 		[ "JSONLoader", "loaders/JSONLoader" ],
 		[ "LoadingMonitor", "loaders/LoadingMonitor" ],
 		[ "SceneLoader", "loaders/SceneLoader" ],
+		[ "TextureLoader", "loaders/TextureLoader" ],
 	],
 
 	"Materials": [