gputex 0.3.1 → 0.3.3

package/dist/three.d.ts

@@ -1,11 +1,16 @@
-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 { TextureHint, PreferredFormat, SvgRasterSize, 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, RasterizeSvgOptions, RawPixelSource, SelectFormatOptions, WebGLBlockEncoder, WebGLCapabilities, WebGLEncodeBytesResult, WebGLEncoderConstructor, WebGLEncoderImageSource, WebGLEncoderOptions, WebGLFormatSelection, WebGPUFeature, createWebGLContext, detectCapabilities, detectWebGLCapabilities, generateMipChain, getSharedWebGLContext, isWebGLAvailable, padToBlockMultiple, rasterizeSvg, selectFormat, selectWebGLFormat } from './index.js';
 import { Texture, CompressedTexture, Loader, CompressedPixelFormat } from 'three';
 
 /**
  * Everything `compressTexture()` can take as an image source. A superset
  * of `EncoderImageSource` (see Encoder.ts) that also accepts URL strings
  * and Blob / File objects — the common cases in a web app.
+ *
+ * SVG works through all of these: a URL to an `.svg` file, a string of
+ * inline SVG markup (detected by a leading `<`), an SVG Blob/File, or an
+ * HTMLImageElement whose src is SVG. Vector sources are rasterised to RGBA
+ * before encoding — see the `svgSize` option.
  */
 type CompressTextureSource = string | Blob | File | ImageBitmap | HTMLImageElement | HTMLCanvasElement | OffscreenCanvas | ImageData;
 interface CompressOptions {
@@ -21,6 +26,14 @@ interface CompressOptions {
     preferredFormat?: PreferredFormat;
     /** Pick the sRGB or linear variant of the chosen format. Default 'srgb'. */
     colorSpace?: 'srgb' | 'linear';
+    /**
+     * Rasterisation size for SVG sources. A number scales the SVG so its
+     * longest side matches (aspect ratio preserved); `{ width, height }`
+     * rasterises at exactly that size. Default: the SVG's intrinsic size
+     * (absolute width/height attributes, else the viewBox dimensions).
+     * Ignored for non-SVG sources.
+     */
+    svgSize?: SvgRasterSize;
     /** Flip the image vertically before encoding. Default true (matches Three.js convention). */
     flipY?: boolean;
     /** Generate a full mip chain down to 1×1 on the CPU, encode every level. */
@@ -79,6 +92,12 @@ declare class GputexLoader extends Loader<Texture> {
     preferredFormat?: PreferredFormat;
     /** Pick the sRGB or linear variant of the chosen format. Default 'srgb'. */
     colorSpace: 'srgb' | 'linear';
+    /**
+     * Rasterisation size for SVG URLs — a number (longest side, aspect
+     * preserved) or exact `{ width, height }`. Default: the SVG's intrinsic
+     * size. See `CompressOptions.svgSize`.
+     */
+    svgSize?: SvgRasterSize;
     /** Flip the image vertically before encoding. Default true (matches Three.js convention). */
     flipY: boolean;
     /** Generate + encode a full mip chain. Default false. */
@@ -152,4 +171,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, PreferredFormat, TextureFormat, TextureHint, buildCompressedTexture, compressTexture, encodeToTexture, threeFormatFor };
+export { type CompressOptions, type CompressResult, type CompressTextureSource, EncodeQuality, type EncodeResult, type EncodeToTextureOptions, Encoder, EncoderImageSource, GputexLoader, PreferredFormat, SvgRasterSize, TextureFormat, TextureHint, buildCompressedTexture, compressTexture, encodeToTexture, threeFormatFor };