Parcourir la source

Merge pull request #13679 from donmccurdy/docs-buffergeometry-geometry

Docs: Update (Buffer)Geometry comparison.
Mr.doob il y a 7 ans
Parent
commit
fe648408be
2 fichiers modifiés avec 17 ajouts et 14 suppressions
  1. 9 8
      docs/api/core/BufferGeometry.html
  2. 8 6
      docs/api/core/Geometry.html

+ 9 - 8
docs/api/core/BufferGeometry.html

@@ -12,14 +12,15 @@
 
 		<div class="desc">
 		<p>
-		This class is an efficient alternative to [page:Geometry], because it stores all data, including
-		vertex positions, face indices, normals, colors, UVs, and custom attributes within buffers; this
-		reduces the cost of passing all this data to the GPU.<br />
-		This also makes BufferGeometry harder to work with than [page:Geometry]; rather than accessing
-		position data as [page:Vector3] objects, color data as [page:Color] objects, and so on, you have to
-		access the raw data from the appropriate [page:BufferAttribute attribute buffer]. This makes
-		BufferGeometry best-suited for static objects where you don't need to manipulate the geometry much
-		after instantiating it.
+		An efficient representation of mesh, line, or point geometry. Includes vertex positions, face
+		indices, normals, colors, UVs, and custom attributes within buffers, reducing the cost of
+		passing all this data to the GPU.
+		</p>
+		<p>
+		To read and edit data in BufferGeometry attributes, see [page:BufferAttribute] documentation.
+		</p>
+		<p>
+		For a less efficient but easier-to-use representation of geometry, see [page:Geometry].
 		</p>
 
 		<h2>Example</h2>

+ 8 - 6
docs/api/core/Geometry.html

@@ -11,12 +11,14 @@
 		<h1>[name]</h1>
 
 		<div class="desc">
-		Base class for all geometries (but not for [page:BufferGeometry BufferGeometries]).<br />
-		This can also be used directly for building custom geometries.<br /><br />
-
-		Geometries are easier to work with than [page:BufferGeometry BufferGeometries] as they store
-		attributes such as vertices, faces, colors and so on directly (rather than in [page:BufferAttribute buffers]),
-		however they are generally slower.
+		<p>
+		Geometry is a user-friendly alternative to [page:BufferGeometry]. Geometries store attributes
+		(vertex positions, faces, colors, etc.) using objects like [page:Vector3] or [page:Color] that
+		are easier to read and edit, but less efficient than typed arrays.
+		</p>
+		<p>
+		Prefer [page:BufferGeometry] for large or serious projects.
+		</p>
 		</div>