Преглед на файлове

Docs: CompressedTexture and CompressedArrayTexture image property, Unit test Readme. (#25492)

* Update CompressedTexture.html

image property record type

* Update CompressedArrayTexture.html

image property record type

* Update README.md

fix typo

* Update README.md

Add common troubleshooting information.

* Fix Typo

Typo: conaining instead of containing (same typo in CompressedTexture).

https://github.com/mrdoob/three.js/pull/25492#discussion_r1104033884

* Property Decorator and Label

Update all 4 image overrides to use the object decorator and text to refer to it as an object.
Ed Preston преди 2 години
родител
ревизия
0a0cd31364

+ 10 - 6
docs/api/en/textures/CompressedArrayTexture.html

@@ -39,7 +39,6 @@
 
 		[page:Constant type] -- Default is [page:Textures THREE.UnsignedByteType].
 		See [page:Textures type constants] for other choices.<br />
-
 		</p>
 
 
@@ -49,10 +48,15 @@
 
 		<h3>[property:number wrapR]</h3>
 		<p>
-		This defines how the texture is wrapped in the depth direction.<br />
-		The default is [page:Textures THREE.ClampToEdgeWrapping], where the edge is clamped to the outer edge texels.
-		The other two choices are [page:Textures THREE.RepeatWrapping] and [page:Textures THREE.MirroredRepeatWrapping].
-		See the [page:Textures texture constants] page for details.
+			This defines how the texture is wrapped in the depth direction.<br />
+			The default is [page:Textures THREE.ClampToEdgeWrapping], where the edge is clamped to the outer edge texels.
+			The other two choices are [page:Textures THREE.RepeatWrapping] and [page:Textures THREE.MirroredRepeatWrapping].
+			See the [page:Textures texture constants] page for details.
+		</p>
+
+		<h3>[property:Object image]</h3>
+		<p>
+			Overridden with a object containing width, height, and depth.
 		</p>
 
 		<h3>[property:Boolean isCompressedArrayTexture]</h3>
@@ -63,7 +67,7 @@
 		<h2>Methods</h2>
 
 		<p>
-		See the base [page:CompressedTexture CompressedTexture] class for common methods.
+			See the base [page:CompressedTexture CompressedTexture] class for common methods.
 		</p>
 
 		<h2>Source</h2>

+ 5 - 0
docs/api/en/textures/CompressedTexture.html

@@ -75,6 +75,11 @@
 			False by default. Mipmaps can't be generated for compressed textures
 		</p>
 
+		<h3>[property:Object image]</h3>
+		<p>
+			Overridden with a object containing width and height.
+		</p>
+
 		<h3>[property:Boolean isCompressedTexture]</h3>
 		<p>
 			Read-only flag to check if a given object is of type [name].

+ 2 - 2
docs/api/en/textures/DataArrayTexture.html

@@ -96,9 +96,9 @@
 			Whether to generate mipmaps (if possible) for the texture. Default is `false`.
 		</p>
 
-		<h3>[property:Image image]</h3>
+		<h3>[property:Object image]</h3>
 		<p>
-			Overridden with a record type holding data, width and height and depth.
+			Overridden with a object holding data, width, height, and depth.
 		</p>
 
 		<h3>[property:Boolean isDataArrayTexture]</h3>

+ 2 - 2
docs/api/en/textures/DataTexture.html

@@ -80,9 +80,9 @@
 		Whether to generate mipmaps (if possible) for a texture. False by default.
 		</p>
 
-		<h3>[property:Image image]</h3>
+		<h3>[property:Object image]</h3>
 		<p>
-		Overridden with a record type holding data, width and height.
+			Overridden with a object holding data, width, and height.
 		</p>
 
 		<h3>[property:Boolean isDataTexture]</h3>

+ 6 - 2
test/unit/README.md

@@ -13,11 +13,15 @@ See [How to run things locally](https://threejs.org/docs/#manual/introduction/Ho
 
 ## Notes
 
-Some tests can only be run in a browser environment.
+A small number of tests can only be run in a browser environment.
 
 For browser tests, futher changes to the library will not be reflected until the page is refreshed.
 
-When adding or updating tests, the cost common cause of test failure is forgetting to change `QUnit.todo` to `QUnit.test` when the test is ready.
+## Troubleshooting
+
+When adding or updating tests, the most common cause of test failure is forgetting to change `QUnit.todo` to `QUnit.test` when the test is ready.
+
+An error that indicates "no tests were found" means that an import statement could not be resolved. This is usually caused by a typo in the import path.
 
 ## Debugging