gputex 0.2.0 → 0.3.1

package/dist/three.d.ts

@@ -1,4 +1,4 @@
-import { TextureHint, EncodeQuality, TextureFormat, Encoder, EncoderImageSource } from './index.js';
+import { TextureHint, PreferredFormat, EncodeQuality, TextureFormat, Encoder, EncoderImageSource } from './index.js';
 export { ASTC4x4Encoder, ASTC4x4WebGLEncoder, BC1Encoder, BC1WebGLEncoder, BC5Encoder, BC5WebGLEncoder, BC7Encoder, BC7WebGLEncoder, Capabilities, EncodeBytesResult, EncodeCallOptions, EncoderConstructor, EncoderOptions, ExtensionProvider, FeatureProvider, FormatSelection, FormatVariant, MipLevel, RawPixelSource, SelectFormatOptions, WebGLBlockEncoder, WebGLCapabilities, WebGLEncodeBytesResult, WebGLEncoderConstructor, WebGLEncoderImageSource, WebGLEncoderOptions, WebGLFormatSelection, WebGPUFeature, createWebGLContext, detectCapabilities, detectWebGLCapabilities, generateMipChain, getSharedWebGLContext, isWebGLAvailable, padToBlockMultiple, selectFormat, selectWebGLFormat } from './index.js';
 import { Texture, CompressedTexture, Loader, CompressedPixelFormat } from 'three';
 
@@ -11,6 +11,14 @@ type CompressTextureSource = string | Blob | File | ImageBitmap | HTMLImageEleme
 interface CompressOptions {
     /** How the texture will be used. Drives format selection. Default 'color'. */
     hint?: TextureHint;
+    /**
+     * Prefer a specific format over the default choice when the device
+     * supports it; falls back to the normal selection (BC7 → ASTC → RGBA8)
+     * when it doesn't. Currently only 'bc1': half the memory of BC7 for
+     * opaque colour textures, at lower quality. Only honoured with
+     * `hint: 'color'` — BC1 can't carry real alpha or normal maps.
+     */
+    preferredFormat?: PreferredFormat;
     /** Pick the sRGB or linear variant of the chosen format. Default 'srgb'. */
     colorSpace?: 'srgb' | 'linear';
     /** Flip the image vertically before encoding. Default true (matches Three.js convention). */
@@ -63,6 +71,12 @@ declare function compressTexture(source: CompressTextureSource, options?: Compre
 declare class GputexLoader extends Loader<Texture> {
     /** Format-selection hint. Default 'color'. */
     hint: TextureHint;
+    /**
+     * Prefer a specific format (currently only 'bc1') when the device
+     * supports it; normal selection otherwise. See
+     * `CompressOptions.preferredFormat`.
+     */
+    preferredFormat?: PreferredFormat;
     /** Pick the sRGB or linear variant of the chosen format. Default 'srgb'. */
     colorSpace: 'srgb' | 'linear';
     /** Flip the image vertically before encoding. Default true (matches Three.js convention). */
@@ -138,4 +152,4 @@ interface EncodeToTextureOptions {
  */
 declare function encodeToTexture(encoder: Encoder, source: EncoderImageSource, { colorSpace, quality, flipY }?: EncodeToTextureOptions): Promise<EncodeResult>;
 
-export { type CompressOptions, type CompressResult, type CompressTextureSource, EncodeQuality, type EncodeResult, type EncodeToTextureOptions, Encoder, EncoderImageSource, GputexLoader, TextureFormat, TextureHint, buildCompressedTexture, compressTexture, encodeToTexture, threeFormatFor };
+export { type CompressOptions, type CompressResult, type CompressTextureSource, EncodeQuality, type EncodeResult, type EncodeToTextureOptions, Encoder, EncoderImageSource, GputexLoader, PreferredFormat, TextureFormat, TextureHint, buildCompressedTexture, compressTexture, encodeToTexture, threeFormatFor };