Created docs for interleave and instanced buffers and geometries

50132bac · looeee · 2ccb4d9e · 50132bac · 50132bac · 50132bac
6 changed file
--- a/docs/api/core/InstancedBufferAttribute.html
+++ b/docs/api/core/InstancedBufferAttribute.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:BufferAttribute] &rarr;
+
+		<h1>[name]</h1>
+
+		<div class="desc">
+		An instanced version of [page:BufferAttribute].
+		</div>
+
+		<h2>Constructor</h2>
+		<h3>[name]( [page:TypedArray array], [page:Integer itemSize], [page:Number meshPerAttribute] )</h3>
+		<div>
+		</div>
+
+		<h2>Properties</h2>
+		See [page:BufferAttribute] for inherited properties.
+
+		<h3>[property:Number meshPerAttribute]</h3>
+		<div>
+			Default is *1*.
+		</div>
+
+		<h3>[property:Boolean isInstancedBufferAttribute]</h3>
+		<div>
+			Default is *true*.
+		</div>
+
+		<h2>Methods</h2>
+		See [page:BufferAttribute] for inherited methods.
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
--- a/docs/api/core/InstancedBufferGeometry.html
+++ b/docs/api/core/InstancedBufferGeometry.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:BufferGeometry] &rarr;
+
+		<h1>[name]</h1>
+
+		<div class="desc">
+		An instanced version of [page:BufferGeometry].
+		</div>
+
+		<h2>Constructor</h2>
+		<h3>[name]( )</h3>
+		<div>
+		</div>
+
+		<h2>Properties</h2>
+		See [page:BufferGeometry] for inherited properties.
+
+		<h3>[property:Number maxInstancedCount]</h3>
+		<div>
+			Default is *undefined*.
+		</div>
+
+		<h3>[property:Boolean isInstancedBufferGeometry]</h3>
+		<div>
+			Default is *true*.
+		</div>
+
+		<h2>Methods</h2>
+		See [page:BufferAttribute] for inherited methods.
+
+		<h3>[property:Number addGroup]( start, count, materialIndex )</h3>
+		<div>
+
+		</div>
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
--- a/docs/api/core/InstancedInterleavedBuffer.html
+++ b/docs/api/core/InstancedInterleavedBuffer.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:InterleavedBuffer] &rarr;
+
+		<h1>[name]</h1>
+
+		<div class="desc">
+		An instanced version of [page:InterleavedBuffer].
+		</div>
+
+		<h2>Constructor</h2>
+		<h3>[name]( [page:TypedArray array], [page:Integer itemSize], [page:Number meshPerAttribute] )</h3>
+		<div>
+		</div>
+
+		<h2>Properties</h2>
+		See [page:InterleavedBuffer] for inherited properties.
+
+		<h3>[property:Number meshPerAttribute]</h3>
+		<div>
+			Default is *1*.
+		</div>
+
+		<h3>[property:Boolean isInstancedInterleavedBuffer]</h3>
+		<div>
+			Default is *true*.
+		</div>
+
+		<h2>Methods</h2>
+		See [page:InterleavedBuffer] for inherited methods.
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
--- a/docs/api/core/InterleavedBuffer.html
+++ b/docs/api/core/InterleavedBuffer.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">
+		</div>
+
+		<h2>Constructor</h2>
+		<h3>[name]( [page:TypedArray array], [page:Integer stride] )</h3>
+		<div>
+		</div>
+
+		<h2>Properties</h2>
+
+		<h3>[property:Array array]</h3>
+		<div>
+		</div>
+
+		<h3>[property:Integer stride]</h3>
+		<div>
+		</div>
+
+		<h3>[property:Integer count]</h3>
+		<div>
+		Gives the total number of elements in the array.
+		</div>
+
+		<h3>[property:Boolean dynamic]</h3>
+		<div>
+		Default is *false*.
+		</div>
+
+		<h3>[property:Object updateRange]</h3>
+		<div>
+		Object containing offset and count.
+		</div>
+
+		<h3>[property:Number updateRange.offset]</h3>
+		<div>
+		DEfault is *0*.
+		</div>
+
+		<h3>[property:Number updateRange.count]</h3>
+		<div>
+		Default is *-1*.
+		</div>
+
+		<h3>[property:Integer version]</h3>
+		<div>
+		A version number, incremented every time the needsUpdate property is set to true.
+		</div>
+
+		<h3>[property:Integer isInterleavedBuffer]</h3>
+		<div>
+		Default is *true*.
+		</div>
+
+		<h3>[property:Integer needsUpdate]</h3>
+		<div>
+		Default is *false*. Setting this to true increments [page:InterleavedBuffer.version version].
+		</div>
+
+		<h2>Methods</h2>
+
+		<h3>[method:null setArray] ( [page:TypedArray array] ) </h3>
+		<div>
+		 array - must be  a Typed Array.
+		</div>
+
+		<h3>[method:InterleavedBuffer setDynamic] ( [page:Boolean value] ) </h3>
+		<div>
+			Set [page:InterleavedBuffer.dynamic dynamic] to value.
+		</div>
+
+		<h3>[method:InterleavedBuffer copy]( source ) </h3>
+		<div>
+		 Copy the array, count, stride and value of dynamic to this.
+		</div>
+
+		<h3>[method:InterleavedBuffer copyAt]( index1, attribute, index2 ) </h3>
+		<div>
+		</div>
+
+		<h3>[method:InterleavedBuffer set]( value, offset ) </h3>
+		<div>
+		</div>
+
+		<h3>[method:InterleavedBuffer clone]( index, x, y ) </h3>
+		<div>
+		</div>
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
--- a/docs/api/core/InterleavedBufferAttribute.html
+++ b/docs/api/core/InterleavedBufferAttribute.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">
+
+		</div>
+
+		<h2>Constructor</h2>
+		<h3>[name]( [page:InterleavedBuffer interleavedBuffer], [page:Integer itemSize], [page:Integer offset], [page:Boolean normalized] )</h3>
+		<div>
+		</div>
+
+		<h2>Properties</h2>
+
+		<h3>[property:InterleavedBuffer data]</h3>
+		<div>
+			The [page:InterleavedBuffer InterleavedBuffer] instance passed in the constructor.
+		</div>
+
+		<h3>[property:Integer itemSize]</h3>
+		<div>
+		</div>
+
+		<h3>[property:Integer offset]</h3>
+		<div>
+		</div>
+
+		<h3>[property:Boolean normalized]</h3>
+		<div>
+			Default is *true*.
+		</div>
+
+		<h3>[property:Boolean isInterleavedBufferAttribute]</h3>
+		<div>
+			Default is *true*.
+		</div>
+
+		<h2>Methods</h2>
+
+		<h3>[method:Integer count]()</h3>
+		<div>
+			The value of [page:InterleavedBufferAttribute.data data].count.
+		</div>
+
+		<h3>[method:Array array]()</h3>
+		<div>
+			The value of [page:InterleavedBufferAttribute.data data].array.
+		</div>
+
+		<h3>[method:null getX]( index ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null getY]( index ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null getZ]( index ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null getW]( index ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null setX]( index, x ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null setY]( index, y ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null setZ]( index, z ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null setXY]( index, x, y ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null setXYZ]( index, x, y, z ) </h3>
+		<div>
+
+		</div>
+
+		<h3>[method:null setXYZW]( index, x, y, z, w ) </h3>
+		<div>
+
+		</div>
+
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
--- a/docs/list.js
+++ b/docs/list.js
@@ -62,6 +62,11 @@ var list = {
 			[ "EventDispatcher", "api/core/EventDispatcher" ],
 			[ "Face3", "api/core/Face3" ],
 			[ "Geometry", "api/core/Geometry" ],
+			[ "InstancedBufferAttribute", "api/core/InstancedBufferAttribute" ],
+			[ "InstancedBufferGeometry", "api/core/InstancedBufferGeometry" ],
+			[ "InstancedInterleavedBuffer", "api/core/InstancedInterleavedBuffer" ],
+			[ "InterleavedBuffer", "api/core/InterleavedBuffer" ],
+			[ "InterleavedBufferAttribute", "api/core/InterleavedBufferAttribute" ],
 			[ "Layers", "api/core/Layers" ],
 			[ "Object3D", "api/core/Object3D" ],
 			[ "Raycaster", "api/core/Raycaster" ],