From 17e0976075c0e5a8ed4824b5a97bce34e28c0d67 Mon Sep 17 00:00:00 2001 From: johh Date: Fri, 18 Aug 2023 21:40:57 +0200 Subject: [PATCH] docs(webgl): document ETC1 limitations --- packages/webgl/src/lib/texture/textureEnums.ts | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/packages/webgl/src/lib/texture/textureEnums.ts b/packages/webgl/src/lib/texture/textureEnums.ts index 04180f8..36ab34f 100644 --- 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, }