Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donmccurdy/ktx-specification
KTX file format source
https://github.com/donmccurdy/ktx-specification
Last synced: 2 days ago
JSON representation
KTX file format source
- Host: GitHub
- URL: https://github.com/donmccurdy/ktx-specification
- Owner: donmccurdy
- License: other
- Fork: true (KhronosGroup/KTX-Specification)
- Created: 2022-07-21T15:30:16.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-07-22T15:03:50.000Z (about 2 years ago)
- Last Synced: 2023-04-09T19:47:47.128Z (over 1 year ago)
- Homepage:
- Size: 3.08 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.adoc
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Home of the KTX File Format Specification
[](https://travis-ci.org/KhronosGroup/KTX-Specification)
KTX is a file format that can be used for storing GPU-ready texture data (with cubemaps, mip levels, etc).
Like DDS but with more features and more formal specification. It supports Basis Universal transcodable formats and supercompression which can yield JPEG-sized universal textures. glTF will use Basis Universal textures in KTX v2 containers.
Click to see the [latest published version of the KTX File Format Specification](https://github.khronos.org/KTX-Specification/ktxspec_v2.html)
or [latest published version of the KTX Fragment URI](https://github.khronos.org/KTX-Specification/ktx_frag.html)
(they look much better than the ersatz views provided by GitHub) or run
```.bash
make
```
in a Unix-like environment with [AsciiDoctor](https://asciidoctor.org/docs/install-toolchain/)
installed to generate the publishable specs. They are the files `out/ktxspec_v2.html` and `out/ktx_frag.html`.
Everything needed is inlined.
The canonical spec. text is in the file `ktxspec.adoc`.
If you have questions or comments that don't merit creating an issue such as "why did you do
so-and-so?" use GitHub [Discussions](https://github.com/KhronosGroup/KTX-Specification/discussions).
### GPU texture format mappings
To ensure correct mappings from Vulkan's `VkFormat` to other GPU APIs, this repo additionally contains:
- [JSON database](formats.json) ([schema](formats.schema.json)) with mappings to OpenGL, Direct3D, and Metal enums.
- [Switch-case generator](generate_format_switches.rb) that produces 5 files with simple C-like case-return statements.
> **Usage:** `./generate_format_switches.rb []`
A few auxiliary files have `$Date$` keywords. If you care about having
the proper dates shown on files in your workspace, you **must** follow the
instructions below.
$Date$ keywords are expanded via a smudge & clean filter. To install
the filter, issue the following commands in the root of your clone.
On Unix (Linux, Mac OS X, etc.) platforms and Windows using Git for Windows'
Git Bash or Cygwin's bash terminal:
```bash
./install-gitconfig.sh
rm TODO.md
git checkout TODO.md
```
On Windows with the Command Prompt (requires `git.exe` in a directory
on your %PATH%):
```cmd
install-gitconfig.bat
del TODO.md
git checkout TODO.md
```
The first command adds an [include] of the repo's `.gitconfig` to the
local git config file `.git/config`, i.e. the one in your clone of the repo.
`.gitconfig` contains the config of the "dater" filter. The remaining
commands force a new checkout of the affected files to smudge them with the
date. These two are unnecessary if you plan to edit these files.