0.7.0

donmccurdy · Mar 14, 2024 · 396d097 · 396d097
1 parent 30a25c2
commit 396d097
Show file tree

Hide file tree

Showing 7 changed files with 363 additions and 290 deletions.
diff --git a/docs/classes/KTX2Container.md b/docs/classes/KTX2Container.md
@@ -31,7 +31,11 @@ provide metadata required to process, transcode, and upload these textures.
 
 ### constructor
 
-• **new KTX2Container**()
+• **new KTX2Container**(): [`KTX2Container`](KTX2Container.md)
+
+#### Returns
+
+[`KTX2Container`](KTX2Container.md)
 
 ## Properties
 
@@ -43,7 +47,7 @@ Data Format Descriptor.
 
 #### Defined in
 
-[container.ts:57](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L57)
+[container.ts:59](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L59)
 
 ___
 
@@ -57,7 +61,7 @@ order.
 
 #### Defined in
 
-[container.ts:48](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L48)
+[container.ts:50](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L50)
 
 ___
 
@@ -69,7 +73,7 @@ Supercompression Global Data.
 
 #### Defined in
 
-[container.ts:77](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L77)
+[container.ts:79](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L79)
 
 ___
 
@@ -85,7 +89,7 @@ Key/Value Data.
 
 #### Defined in
 
-[container.ts:74](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L74)
+[container.ts:76](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L76)
 
 ___
 
@@ -97,7 +101,7 @@ Number of array elements (array textures only).
 
 #### Defined in
 
-[container.ts:41](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L41)
+[container.ts:43](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L43)
 
 ___
 
@@ -109,7 +113,7 @@ Mip levels, ordered largest (original) to smallest (~1px).
 
 #### Defined in
 
-[container.ts:54](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L54)
+[container.ts:56](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L56)
 
 ___
 
@@ -121,7 +125,7 @@ Depth of the texture image for level 0, in pixels (3D textures only).
 
 #### Defined in
 
-[container.ts:38](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L38)
+[container.ts:40](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L40)
 
 ___
 
@@ -133,7 +137,7 @@ Height of the texture image for level 0, in pixels.
 
 #### Defined in
 
-[container.ts:35](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L35)
+[container.ts:37](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L37)
 
 ___
 
@@ -145,19 +149,19 @@ Width of the texture image for level 0, in pixels.
 
 #### Defined in
 
-[container.ts:32](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L32)
+[container.ts:34](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L34)
 
 ___
 
 ### supercompressionScheme
 
-• **supercompressionScheme**: `number` = `KHR_SUPERCOMPRESSION_NONE`
+• **supercompressionScheme**: [`Supercompression`](../modules.md#supercompression) = `KHR_SUPERCOMPRESSION_NONE`
 
 Indicates which supercompression scheme has been applied to mip level images, if any.
 
 #### Defined in
 
-[container.ts:51](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L51)
+[container.ts:53](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L53)
 
 ___
 
@@ -170,17 +174,17 @@ VK_FORMAT_UNDEFINED, `typeSize` must be 1.
 
 #### Defined in
 
-[container.ts:29](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L29)
+[container.ts:31](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L31)
 
 ___
 
 ### vkFormat
 
-• **vkFormat**: `number` = `VK_FORMAT_UNDEFINED`
+• **vkFormat**: [`VKFormat`](../modules.md#vkformat) = `VK_FORMAT_UNDEFINED`
 
 Specifies the image format using Vulkan VkFormat enum values. When using Basis Universal
 texture formats, `vkFormat` must be VK_FORMAT_UNDEFINED.
 
 #### Defined in
 
-[container.ts:23](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L23)
+[container.ts:25](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L25)
diff --git a/docs/interfaces/KTX2BasicFormatSample.md b/docs/interfaces/KTX2BasicFormatSample.md
@@ -22,7 +22,7 @@
 
 #### Defined in
 
-[container.ts:122](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L122)
+[container.ts:124](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L124)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 #### Defined in
 
-[container.ts:121](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L121)
+[container.ts:123](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L123)
 
 ___
 
@@ -46,7 +46,7 @@ Renamed to 'channelType'.
 
 #### Defined in
 
-[container.ts:124](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L124)
+[container.ts:126](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L126)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[container.ts:125](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L125)
+[container.ts:127](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L127)
 
 ___
 
@@ -66,7 +66,7 @@ ___
 
 #### Defined in
 
-[container.ts:127](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L127)
+[container.ts:129](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L129)
 
 ___
 
@@ -76,7 +76,7 @@ ___
 
 #### Defined in
 
-[container.ts:126](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L126)
+[container.ts:128](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L128)
 
 ___
 
@@ -86,4 +86,4 @@ ___
 
 #### Defined in
 
-[container.ts:128](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L128)
+[container.ts:130](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L130)
diff --git a/docs/interfaces/KTX2DataFormatDescriptorBasicFormat.md b/docs/interfaces/KTX2DataFormatDescriptorBasicFormat.md
@@ -26,7 +26,7 @@
 
 #### Defined in
 
-[container.ts:116](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L116)
+[container.ts:118](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L118)
 
 ___
 
@@ -36,7 +36,7 @@ ___
 
 #### Defined in
 
-[container.ts:111](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L111)
+[container.ts:113](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L113)
 
 ___
 
@@ -46,7 +46,7 @@ ___
 
 #### Defined in
 
-[container.ts:112](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L112)
+[container.ts:114](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L114)
 
 ___
 
@@ -60,7 +60,7 @@ Inferred.
 
 #### Defined in
 
-[container.ts:110](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L110)
+[container.ts:112](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L112)
 
 ___
 
@@ -70,7 +70,7 @@ ___
 
 #### Defined in
 
-[container.ts:107](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L107)
+[container.ts:109](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L109)
 
 ___
 
@@ -80,7 +80,7 @@ ___
 
 #### Defined in
 
-[container.ts:114](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L114)
+[container.ts:116](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L116)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[container.ts:117](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L117)
+[container.ts:119](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L119)
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[container.ts:115](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L115)
+[container.ts:117](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L117)
 
 ___
 
@@ -110,7 +110,7 @@ ___
 
 #### Defined in
 
-[container.ts:113](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L113)
+[container.ts:115](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L115)
 
 ___
 
@@ -120,7 +120,7 @@ ___
 
 #### Defined in
 
-[container.ts:106](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L106)
+[container.ts:108](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L108)
 
 ___
 
@@ -130,4 +130,4 @@ ___
 
 #### Defined in
 
-[container.ts:108](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L108)
+[container.ts:110](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L110)
diff --git a/docs/interfaces/KTX2GlobalDataBasisLZ.md b/docs/interfaces/KTX2GlobalDataBasisLZ.md
@@ -22,7 +22,7 @@
 
 #### Defined in
 
-[container.ts:136](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L136)
+[container.ts:138](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L138)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 #### Defined in
 
-[container.ts:139](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L139)
+[container.ts:141](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L141)
 
 ___
 
@@ -42,7 +42,7 @@ ___
 
 #### Defined in
 
-[container.ts:142](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L142)
+[container.ts:144](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L144)
 
 ___
 
@@ -52,7 +52,7 @@ ___
 
 #### Defined in
 
-[container.ts:138](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L138)
+[container.ts:140](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L140)
 
 ___
 
@@ -62,7 +62,7 @@ ___
 
 #### Defined in
 
-[container.ts:137](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L137)
+[container.ts:139](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L139)
 
 ___
 
@@ -72,7 +72,7 @@ ___
 
 #### Defined in
 
-[container.ts:140](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L140)
+[container.ts:142](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L142)
 
 ___
 
@@ -82,4 +82,4 @@ ___
 
 #### Defined in
 
-[container.ts:141](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L141)
+[container.ts:143](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L143)
diff --git a/docs/interfaces/KTX2Level.md b/docs/interfaces/KTX2Level.md
@@ -19,7 +19,7 @@ Compressed data of the mip level.
 
 #### Defined in
 
-[container.ts:86](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L86)
+[container.ts:88](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L88)
 
 ___
 
@@ -38,4 +38,4 @@ size of decoded RGBA32 pixels._
 
 #### Defined in
 
-[container.ts:98](https://github.com/donmccurdy/KTX-Parse/blob/9988acf/src/container.ts#L98)
+[container.ts:100](https://github.com/donmccurdy/KTX-Parse/blob/30a25c2/src/container.ts#L100)