jtBaseApp/node_modules/ktx-parse/dist/container.d.ts

/**
 * Represents an unpacked KTX 2.0 texture container. Data for individual mip levels are stored in
 * the `.levels` array, typically compressed in Basis Universal formats. Additional properties
 * provide metadata required to process, transcode, and upload these textures.
 */
export declare class KTX2Container {
    /**
     * Specifies the image format using Vulkan VkFormat enum values. When using Basis Universal
     * texture formats, `vkFormat` must be VK_FORMAT_UNDEFINED.
     */
    vkFormat: number;
    /**
     * Size of the data type in bytes used to upload the data to a graphics API. When `vkFormat` is
     * VK_FORMAT_UNDEFINED, `typeSize` must be 1.
     */
    typeSize: number;
    /** Width of the texture image for level 0, in pixels. */
    pixelWidth: number;
    /** Height of the texture image for level 0, in pixels. */
    pixelHeight: number;
    /** Depth of the texture image for level 0, in pixels (3D textures only). */
    pixelDepth: number;
    /** Number of array elements (array textures only). */
    layerCount: number;
    /**
     * Number of cubemap faces. For cubemaps and cubemap arrays, `faceCount` must be 6. For all
     * other textures, `faceCount` must be 1. Cubemap faces are stored in +X, -X, +Y, -Y, +Z, -Z
     * order.
     */
    faceCount: number;
    /** Indicates which supercompression scheme has been applied to mip level images, if any. */
    supercompressionScheme: number;
    /** Mip levels, ordered largest (original) to smallest (~1px). */
    levels: KTX2Level[];
    /** Data Format Descriptor. */
    dataFormatDescriptor: KTX2DataFormatDescriptorBasicFormat[];
    /** Key/Value Data. */
    keyValue: {
        [key: string]: string | Uint8Array;
    };
    /** Supercompression Global Data. */
    globalData: KTX2GlobalDataBasisLZ | null;
}
export interface KTX2Level {
    /** Compressed data of the mip level. */
    levelData: Uint8Array;
    /**
     * Size of the mip level after reflation from supercompression, if applicable. When
     * `supercompressionType` is BASISLZ, `uncompressedByteLength` must be 0. When
     * `supercompressionType` is `NONE`, `uncompressedByteLength` must match the `levelData` byte
     * length.
     *
     * _**NOTICE:** this implies that for formats such as UASTC, `uncompressedByteLength` may
     * indicate size after ZSTD reflation (and of transcoded ASTC data), but does _not_ indicate
     * size of decoded RGBA32 pixels._
     */
    uncompressedByteLength: number;
}
export interface KTX2DataFormatDescriptorBasicFormat {
    vendorId: number;
    descriptorType: number;
    versionNumber: number;
    /** @deprecated Inferred. */
    descriptorBlockSize: number;
    colorModel: number;
    colorPrimaries: number;
    transferFunction: number;
    flags: number;
    texelBlockDimension: [number, number, number, number];
    bytesPlane: [number, number, number, number, number, number, number, number];
    samples: KTX2BasicFormatSample[];
}
export interface KTX2BasicFormatSample {
    bitOffset: number;
    bitLength: number;
    /** @deprecated Renamed to 'channelType'. */
    channelID?: number;
    channelType: number;
    samplePosition: number[];
    sampleLower: number;
    sampleUpper: number;
}
export interface KTX2GlobalDataBasisLZ {
    endpointCount: number;
    selectorCount: number;
    imageDescs: KTX2GlobalDataBasisLZImageDesc[];
    endpointsData: Uint8Array;
    selectorsData: Uint8Array;
    tablesData: Uint8Array;
    extendedData: Uint8Array;
}
interface KTX2GlobalDataBasisLZImageDesc {
    imageFlags: number;
    rgbSliceByteOffset: number;
    rgbSliceByteLength: number;
    alphaSliceByteOffset: number;
    alphaSliceByteLength: number;
}
export {};