docs(webgl): document ETC1 limitations

codename-gadget · Aug 18, 2023 · 17e0976 · 17e0976
1 parent 04ccb3d
commit 17e0976
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/webgl/src/lib/texture/textureEnums.ts b/packages/webgl/src/lib/texture/textureEnums.ts
@@ -463,7 +463,13 @@ export enum CompressedTextureStorageFormat {
 
 	// WEBGL_compressed_texture_etc1
 
-	/** Compresses 24-bit RGB data with no alpha channel. */
+	/**
+	 * Compressed 24-bit RGB data with no alpha channel.
+	 *
+	 * @remarks Due to limitations with ETC1, textures with mipmaps will appear
+	 * black until **ALL** mip-levels are uploaded. To work around this, before using the texture,
+	 * upload the first level and await `generateMipmaps()` on your texture immediately afterwards.
+	 */
 	rgbEtc1 = 0x8d64,
 }