mirror of
https://github.com/Nexoniarz/YAPF.git
synced 2026-11-03 13:04:26 +00:00
0ba1f0af17yapf.js: decodeTexture (container, yapf-sum checks, code books with context decoding, 16-bit / float planes, GPU block tiles), BC1-BC7 / BC6H block decoding and textureToRGBA for display. Matches the C library on 417 generated files (surfaces bit-exact) and survives fuzzing with clean YapfErrors; fixtures in bindings/js/test-data keep it checked. VS Code preview: pickers for mip, face, layer, frame and slice; storage, normal-map convention and version in the info bar. Figma import: textures converted to 8-bit, 8-bit images stay exact. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DVrVthWN8GsmgHGUhhsCYm
43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
# yapf.js — YAPF in JavaScript
|
|
|
|
Encoder (version 1) and decoder (versions 1 and 2) in one dependency-free file. Works in
|
|
browsers, Node.js, web workers, Figma plugins and VS Code webviews, and
|
|
produces exactly the same bytes as the C library.
|
|
|
|
```js
|
|
const YAPF = require('./yapf.js'); // or <script src="yapf.js"> → window.YAPF
|
|
|
|
const img = YAPF.decode(bytes); // Uint8Array → image
|
|
// img = { width, height, channels, pixels, gpuFormat, flags, mipLevels, mips }
|
|
|
|
const file = YAPF.encode({ width, height, channels: 4, pixels }); // → Uint8Array
|
|
|
|
// draw on a canvas
|
|
ctx.putImageData(new ImageData(YAPF.toRGBA(img), img.width, img.height), 0, 0);
|
|
```
|
|
|
|
`decode` throws an `Error` for corrupt or unsupported data. Speed: a 4K
|
|
image decodes in about 150 ms in Node / Chrome (the C library: 6 ms).
|
|
|
|
TypeScript types are in `yapf.d.ts`.
|
|
|
|
Example: `node example.mjs ../../other/YAPF.YAPF` · tests: `node test.js`.
|
|
|
|
## Textures (YAPF 2)
|
|
|
|
```js
|
|
const tex = YAPF.decodeTexture(bytes); // any v1 / v2 file
|
|
// tex: { width, height, depth, layers, frames, faces, shape, mipLevels,
|
|
// payload, format, sample, channels, flags, channelMap, normal,
|
|
// primaries, transfer, frameUs, notes, surfaces: [...] }
|
|
const s = YAPF.surfaceIndex(tex, frame, layer, face, mip);
|
|
const view = YAPF.textureToRGBA(tex, s); // { width, height, rgba } for a canvas
|
|
```
|
|
|
|
`surfaces[s]` is a `Uint8Array` (8-bit pixels or GPU blocks, ready for
|
|
WebGL / WebGPU compressed textures), `Uint16Array` (16-bit, half) or
|
|
`Float32Array`. Checksums are verified (`{ verify: false }` skips them);
|
|
errors are `YAPF.YapfError` with a `code` (`corrupt`, `checksum`,
|
|
`truncated`, `not-yapf`, `version`, `unsupported`). `decode()` also reads
|
|
8-bit version 2 files. The decoder is checked against the C library on the
|
|
files in `test-data/`.
|