ris-ktx2-api 0.1.0-dev.2.4

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0
+
+First public release.
+
+- `IKtx2Texture` and `IKtx2Factory`, the interfaces implemented by `ris-ktx2`
+- `IKtxTextureCreateInfo` and `IKtxBasisParams` for creating textures and configuring Basis Universal compression
+- `VkFormat`, `KtxTranscodeFormat`, `KtxTranscodeFlags`, `KtxUastcFlags`, `KtxCreateStorage`, and `KtxErrorCode`
+- `KtxErrorCode` matches libktx `ktx_error_code_e` from `SUCCESS` (`0`) through `DECOMPRESS_CHECKSUM_ERROR` (`20`). `SUCCESS` and `INVALID_OPERATION` (`10`) are unchanged. libktx's `KTX_ERROR_MAX_ENUM` alias is not a member
+- `TextureFormatInfo` block-layout helpers. `fromVkFormat` covers the original eight formats, the sRGB variants of the mapped block formats, `ASTC_4X4_SFLOAT_BLOCK` (same 4×4, 16-byte layout), and the other 8-bit 4-channel formats that store 4 bytes per pixel
+- npm publishing: pushes to `development` publish `<version>-dev.<run number>` on the `next` dist-tag and do not commit the version bump. Pushes to `main` publish `<version>` on `latest` when that version is not already on npm, then create git tag `v<version>` and a GitHub release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Luka Erkapic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSES/Apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,116 @@
+# ris-ktx2-api
+
+TypeScript interfaces, enumerations, and texture-format helpers for [KTX2](https://registry.khronos.org/KTX/specs/2.0/ktxspec.v2.html) textures. Version 0.1.0.
+
+This package has no WebAssembly and does not read or write files. It is the type surface that `ris-ktx2` implements. `ris-ktx2` wraps Khronos libktx (`libktx.js`) and depends on this package.
+
+Use this package on its own for the enumerations, `TextureFormatInfo`, or to type a function that receives an `IKtx2Factory` or `IKtx2Texture`. Use `ris-ktx2` when you need to load, create, transcode, or compress a texture. `ris-ktx2` exports `Ktx2Factory`, which implements `IKtx2Factory`.
+
+## Install
+
+```sh
+npm install ris-ktx2-api
+```
+
+The package is ESM only. `package.json` `exports` resolves JavaScript to `dist/index.js` and types to `dist/index.d.ts`. There are no runtime dependencies and the module has no import-time side effects.
+
+## Exports
+
+Everything is exported from the package root.
+
+- `IKtx2Texture` — loaded or created KTX/KTX2 texture: dimensions, transcode, Basis and ASTC compression, ZLIB/Zstandard deflate, image get/set, and write-to-memory
+- `IKtx2Factory` — `initializeAsync`, `loadAsync` (a URL string or a browser `File`), `create`, and `createFromBuffer`
+- `IKtxTextureCreateInfo` — base width, height, optional `VkFormat`, optional mip count
+- `IKtxBasisParams` — ETC1S and UASTC compression settings
+- `KtxTranscodeFormat`, `KtxTranscodeFlags` — Basis Universal transcode target and options
+- `KtxUastcFlags` — UASTC encoder level and hint bits
+- `KtxCreateStorage` — `NO_STORAGE` (`0`) or `ALLOC_STORAGE` (`1`)
+- `KtxErrorCode` — libktx `ktx_error_code_e` from `SUCCESS` (`0`) through `DECOMPRESS_CHECKSUM_ERROR` (`20`). libktx's `KTX_ERROR_MAX_ENUM` alias is not included
+- `VkFormat` — Vulkan format enumerators, including extension aliases
+- `TextureFormatInfo` — block width, height, byte size, and mip-level size
+
+`TextureFormatInfo.fromVkFormat` returns a layout when the byte size matches a helper this package already defines. sRGB, signed, integer, and scaled variants share that size, and channel order does not change it.
+
+- `R8G8B8A8_*`, `B8G8R8A8_*`, and `A8B8G8R8_*_PACK32` — 4 bytes per pixel
+- `D24_UNORM_S8_UINT` and `D32_SFLOAT` — 4 bytes per pixel
+- `BC3_UNORM_BLOCK` and `BC3_SRGB_BLOCK`
+- `BC7_UNORM_BLOCK` and `BC7_SRGB_BLOCK`
+- `ETC2_R8G8B8A8_UNORM_BLOCK` and `ETC2_R8G8B8A8_SRGB_BLOCK`
+- `ASTC_4X4_UNORM_BLOCK`, `ASTC_4X4_SRGB_BLOCK`, and `ASTC_4X4_SFLOAT_BLOCK` (`ASTC_4X4_SFLOAT_BLOCK_EXT` is the same value)
+
+Other `VkFormat` values throw.
+
+`KtxTranscodeFormat` and `VkFormat` reuse some numbers (both use `13`, for example). `IKtx2Texture.getTextureFormatInfo` takes either enumeration, and an implementation has to tell them apart by type rather than by the number.
+
+## Usage
+
+`TextureFormatInfo` runs on its own. Creating a texture needs an `IKtx2Factory`. `ris-ktx2` provides that with `Ktx2Factory`.
+
+```ts
+import { Ktx2Factory } from "ris-ktx2";
+import {
+  KtxCreateStorage,
+  KtxErrorCode,
+  KtxTranscodeFlags,
+  KtxTranscodeFormat,
+  TextureFormatInfo,
+  VkFormat,
+  type IKtxTextureCreateInfo,
+} from "ris-ktx2-api";
+
+const createInfo: IKtxTextureCreateInfo = {
+  baseWidth: 256,
+  baseHeight: 256,
+  vkFormat: VkFormat.R8G8B8A8_SRGB,
+  numLevels: 1,
+};
+
+const layout = TextureFormatInfo.fromVkFormat(VkFormat.BC7_SRGB_BLOCK);
+const levelBytes = layout.getDataSize(createInfo.baseWidth, createInfo.baseHeight);
+
+const factory = new Ktx2Factory();
+await factory.initializeAsync();
+const texture = factory.create(createInfo, KtxCreateStorage.ALLOC_STORAGE);
+const code = texture.transcodeBasis(KtxTranscodeFormat.BC7_RGBA, KtxTranscodeFlags.NONE);
+if (code !== KtxErrorCode.SUCCESS) {
+  throw new Error(`transcode failed: ${KtxErrorCode[code]}`);
+}
+const image = texture.getImage(0, 0, 0);
+```
+
+`levelBytes` is the BC7 size of a 256×256 level (65536 bytes). `image` is the level's bytes after transcoding. Call `texture.delete()` when the texture is no longer used.
+
+`KtxTranscodeFlags.PVRTC_DECODE_TO_NEXT_POW2` asks libktx to decode a non-power-of-two ETC1S level to the next larger power of two for PVRTC1. libktx still documents that option as not implemented, and it is ignored when the slice dimensions are already powers of two.
+
+`IKtx2Texture.compressAstc` encodes uncompressed 2D 8-bit images to ASTC. libktx returns `KtxErrorCode.INVALID_OPERATION` for data that is already supercompressed or block-compressed, for packed formats such as RGB565, for component sizes other than 8 bits, and for 1D images. Quality `0` through `100` is the normal range. The libktx parameter is unsigned, so a negative value is treated as greater than `100`.
+
+## Scripts
+
+From the package root:
+
+| Script | Command |
+| --- | --- |
+| Typecheck, then emit an ESM library build and a bundled `.d.ts` | `npm run build` |
+| Typecheck and test | `npm test` |
+| Remove `dist/` | `npm run clean` |
+
+`prepublishOnly` runs the build. Published files are `dist/`, `src/`, `LICENSE`, `LICENSES/`, `THIRD_PARTY_NOTICES.md`, `README.md`, and `CHANGELOG.md`. `idl-symbols.meta.json` is local generator metadata and is not published.
+
+## Releasing
+
+`package.json` `version` is the release version (`0.1.0`). It has no prerelease suffix. Publishing does not commit a version bump.
+
+| Branch | Result |
+| --- | --- |
+| `development` | Each push installs, builds, and tests, then publishes `<version>-dev.<run number>` to npm on the `next` dist-tag. A re-run of that workflow uses `<version>-dev.<run number>.<attempt>`. |
+| `main` | Each push installs, builds, and tests. If `<version>` is not already on npm, it is published on the `latest` dist-tag. The workflow then creates git tag `v<version>` and a GitHub release. |
+
+`npm install ris-ktx2-api@next` installs the `development` prerelease. A plain `npm install ris-ktx2-api` installs `latest`.
+
+Bump `version` on `development` when the next release starts, and merge that commit to `main` to publish it. Setup for the `NPM_TOKEN` secret and provenance is in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+[MIT](LICENSE). Copyright (c) 2026 Luka Erkapic.
+
+`VkFormat` and the KTX transcode, UASTC, and Basis parameter shapes match Khronos and Basis Universal APIs. Those projects are not vendored here. Attribution and the Apache License 2.0 text are in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,47 @@
+# Third-party notices
+
+`ris-ktx2-api` is TypeScript written for this repository and distributed under the MIT License (see `LICENSE`). Copyright (c) 2026 Luka Erkapic.
+
+This package does not vendor KTX-Software, Vulkan-Headers, basis_universal, or their binaries. `idl-symbols.meta.json` is local generator metadata for these sources. It is not a Khronos IDL file and it is not part of the published package.
+
+The enumerations and parameter fields below use the same names and numeric values as the public APIs they interoperate with. Some comments paraphrase that upstream documentation. Because of that, the Apache License 2.0 text is included at `LICENSES/Apache-2.0.txt`.
+
+## Khronos KTX-Software
+
+Copyright 2010-2024 The Khronos Group Inc. and contributors.
+
+SPDX-License-Identifier: Apache-2.0
+
+`KtxTranscodeFormat`, `KtxTranscodeFlags`, `KtxUastcFlags`, `KtxCreateStorage`, `KtxErrorCode`, and the Basis Universal fields on `IKtxBasisParams` follow the public libktx API:
+
+https://github.com/KhronosGroup/KTX-Software
+
+Upstream license overview (v4.3.2): https://github.com/KhronosGroup/KTX-Software/blob/v4.3.2/LICENSE.md
+
+KTX-Software bundles other projects, including basis_universal. Those sources are not redistributed here. The `ris-ktx2` package ships the libktx WebAssembly build. That build is not part of this package.
+
+## Basis Universal
+
+Copyright Binomial LLC.
+
+SPDX-License-Identifier: Apache-2.0
+
+UASTC and ETC1S parameters described by `KtxUastcFlags` and `IKtxBasisParams` originate in the Basis Universal codec, which libktx exposes:
+
+https://github.com/BinomialLLC/basis_universal
+
+## Vulkan `VkFormat`
+
+Copyright 2015-2026 The Khronos Group Inc.
+
+SPDX-License-Identifier: Apache-2.0 OR MIT
+
+`VkFormat` enumerator names and numeric values match the Vulkan `VkFormat` enumeration generated in Vulkan-Headers:
+
+https://github.com/KhronosGroup/Vulkan-Headers
+
+Vulkan-Headers are dual-licensed Apache-2.0 OR MIT. This package is distributed under the MIT License.
+
+## Development dependencies
+
+`vite` (MIT), `vite-plugin-dts` (MIT), `@microsoft/api-extractor` (MIT), `vitest` (MIT), and `@typescript/typescript6` (Apache-2.0) are used to build and test this package. `vite-plugin-dts` uses API Extractor to bundle `dist/index.d.ts`. These tools are not bundled into `dist/`. Their licenses are recorded in `package-lock.json`.