Accueil Explorer Aide
Connexion
javascript
/
three.js
miroir de https://github.com/tazdij/three.js.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Parcourir la source

Docs: Add BufferAttribute Usage constants documentation (#22173)

* Add docs page for usage

* GeometryUsage -> BufferAttributeUsage

* Add links to new docs page

* Update chinese docs

* Update BufferAttributeUsage.html

* Update BufferAttributeUsage.html

* Update BufferAttributeUsage.html

* Update BufferAttributeUsage.html

* Update BufferAttributeUsage.html
Garrett Johnson il y a 4 ans
Parent
ea3762dadd
commit
3a9152af37
5 fichiers modifiés avec 107 ajouts et 4 suppressions
Vue séparée Afficher les stats Diff
  1. 51 0
      docs/api/en/constants/BufferAttributeUsage.html
  2. 2 2
      docs/api/en/core/BufferAttribute.html
  3. 51 0
      docs/api/zh/constants/BufferAttributeUsage.html
  4. 2 2
      docs/api/zh/core/BufferAttribute.html
  5. 1 0
      docs/list.json

+ 51 - 0
docs/api/en/constants/BufferAttributeUsage.html
Voir le fichier 

@@ -0,0 +1,51 @@
 
+<!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>
 
+		<h1>Buffer Attribute Usage Constants</h1>
 
+
 
+		<p>
 
+			The usage constants can be used to provide a hint to the API regarding how the geometry buffer attribute will be used in order to optimize performance.
 
+		</p>
 
+
 
+		<h2>Code Example</h2>
 
+
 
+		<code>
 
+		const geometry = new THREE.BufferGeometry();
 
+		const positionAttribute = new THREE.BufferAttribute( array, 3 , false );
 
+		positionAttribute.setUsage( THREE.DynamicDrawUsage );
 
+		geometry.setAttribute( 'position', positionAttribute );
 
+		</code>
 
+
 
+		<h2>Examples</h2>
 
+		<p>[example:webgl_buffergeometry_drawrange materials / buffergeometry / drawrange ]</p>
 
+
 
+		<h2>Geometry Usage</h2>
 
+		<code>
 
+		THREE.StaticDrawUsage
 
+		THREE.DynamicDrawUsage
 
+		THREE.StreamDrawUsage
 
+
 
+		THREE.StaticReadUsage
 
+		THREE.DynamicReadUsage
 
+		THREE.StreamReadUsage
 
+
 
+		THREE.StaticCopyUsage
 
+		THREE.DynamicCopyUsage
 
+		THREE.StreamCopyUsage
 
+		</code>
 
+
 
+		For more detailed information on each of these constants see [link:https://www.khronos.org/opengl/wiki/Buffer_Object#Buffer_Object_Usage this OpenGL documentation].
 
+
 
+		<h2>Source</h2>
 
+
 
+		<p>
 
+			[link:https://github.com/mrdoob/three.js/blob/master/src/constants.js src/constants.js]
 
+		</p>
 
+	</body>
 
+</html>

+ 2 - 2
docs/api/en/core/BufferAttribute.html
Voir le fichier 

@@ -97,7 +97,7 @@
 
 		<p>
 
 			Defines the intended usage pattern of the data store for optimization purposes. Corresponds to the *usage* parameter of
 
 			[link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bufferData WebGLRenderingContext.bufferData]().
 
-			Default is *THREE.StaticDrawUsage*.
 
+			Default is [page:BufferAttributeUsage StaticDrawUsage]. See usage [page:BufferAttributeUsage constants] for all possible values.
 
 		</p>
 
 
 		<h3>[property:Integer version]</h3>
 
@@ -179,7 +179,7 @@
 
 		</p>
 
 
 		<h3>[method:BufferAttribute setUsage] ( [param:Usage value] ) </h3>
 
-		<p>Set [page:BufferAttribute.usage usage] to value.</p>
 
+		<p>Set [page:BufferAttribute.usage usage] to value. See usage [page:BufferAttributeUsage constants] for all possible input values.</p>
 
 
 		<h3>[method:BufferAttribute setX]( [param:Integer index], [param:Float x] ) </h3>
 
 		<p>Sets the x component of the vector at the given index.</p>

+ 51 - 0
docs/api/zh/constants/BufferAttributeUsage.html
Voir le fichier 

@@ -0,0 +1,51 @@
 
+<!DOCTYPE html>
 
+<html lang="zh">
 
+	<head>
 
+		<meta charset="utf-8" />
 
+		<base href="../../../" />
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		<h1>Buffer Attribute Usage Constants</h1>
 
+
 
+		<p>
 
+			The usage constants can be used to provide a hint to the API regarding how the geometry buffer attribute will be used in order to optimize performance.
 
+		</p>
 
+
 
+		<h2>Code Example</h2>
 
+
 
+		<code>
 
+		const geometry = new THREE.BufferGeometry();
 
+		const positionAttribute = new THREE.BufferAttribute( array, 3 , false );
 
+		positionAttribute.setUsage( THREE.DynamicDrawUsage );
 
+		geometry.setAttribute( 'position', positionAttribute );
 
+		</code>
 
+
 
+		<h2>Examples</h2>
 
+		<p>[example:webgl_buffergeometry_drawrange materials / buffergeometry / drawrange ]</p>
 
+
 
+		<h2>Geometry Usage</h2>
 
+		<code>
 
+		THREE.StaticDrawUsage
 
+		THREE.DynamicDrawUsage
 
+		THREE.StreamDrawUsage
 
+
 
+		THREE.StaticReadUsage
 
+		THREE.DynamicReadUsage
 
+		THREE.StreamReadUsage
 
+
 
+		THREE.StaticCopyUsage
 
+		THREE.DynamicCopyUsage
 
+		THREE.StreamCopyUsage
 
+		</code>
 
+
 
+		For more detailed information on each of these constants see [link:https://www.khronos.org/opengl/wiki/Buffer_Object#Buffer_Object_Usage this OpenGL documentation].
 
+
 
+		<h2>Source</h2>
 
+
 
+		<p>
 
+			[link:https://github.com/mrdoob/three.js/blob/master/src/constants.js src/constants.js]
 
+		</p>
 
+	</body>
 
+</html>

+ 2 - 2
docs/api/zh/core/BufferAttribute.html
Voir le fichier 

@@ -87,7 +87,7 @@
 
 		<p>
 
 			Defines the intended usage pattern of the data store for optimization purposes. Corresponds to the *usage* parameter of
 
 			[link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bufferData WebGLRenderingContext.bufferData]().
 
-			Default is *THREE.StaticDrawUsage*.
 
+			Default is [page:BufferAttributeUsage StaticDrawUsage]. See usage [page:BufferAttributeUsage constants] for all possible values.
 
 		</p>
 
 
 		<h3>[property:Integer version]</h3>
 
@@ -160,7 +160,7 @@
 
 		</p>
 
 
 		<h3>[method:BufferAttribute setUsage] ( [param:Usage value] ) </h3>
 
-		<p>Set [page:BufferAttribute.usage usage] to value.</p>
 
+		<p>Set [page:BufferAttribute.usage usage] to value. See usage [page:BufferAttributeUsage constants] for all possible input values.</p>
 
 
 		<h3>[method:BufferAttribute setX]( [param:Integer index], [param:Float x] ) </h3>
 
 		<p>设置给定索引的矢量的第一维数据（设置 X 值）。</p>

+ 1 - 0
docs/list.json
Voir le fichier 

@@ -75,6 +75,7 @@
 
 				"Animation": "api/en/constants/Animation",
 
 				"Core": "api/en/constants/Core",
 
 				"CustomBlendingEquation": "api/en/constants/CustomBlendingEquations",
 
+				"BufferAttributeUsage": "api/en/constants/BufferAttributeUsage",
 
 				"Materials": "api/en/constants/Materials",
 
 				"Renderer": "api/en/constants/Renderer",
 
 				"Textures": "api/en/constants/Textures"