Add ability to compress textures with Basis Universal #16142
Conversation
|
Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s). |
|
Snapshot stored with reference name: Test environment: To test a playground add it to the URL, for example: https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/refs/pull/16142/merge/index.html#WGZLGJ#4600 Links to test babylon tools with this snapshot: https://playground.babylonjs.com/?snapshot=refs/pull/16142/merge To test the snapshot in the playground with a playground ID add it after the snapshot query string: https://playground.babylonjs.com/?snapshot=refs/pull/16142/merge#BCU1XR#0 |
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
… basisu-encoder
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
…eSRGBBuffer" This reverts commit 2504c3f.
|
Visualization tests for WebGPU |
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
|
WebGL2 visualization test reporter: |
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
alexchuber
force-pushed
the
basisu-encoder
branch
from
2e82263 to
b739d2b
Compare
| * Initialize resources for the Basis Universal encoder. | ||
| * @returns a promise that resolves when the Basis Universal encoder resources are initialized | ||
| */ | ||
| export async function InitializeBasisEncoderAsync(): Promise<void> { |
There was a problem hiding this comment.
Nitty, but any opinions about whether the encoder should be a class or not?
On the one hand,
- It is stateful (workerpool management)
- Module level functions clutter the BABYLON namespace and (I assume) require unique names
On the other,
- Since this is a singleton, it makes sense to leave things at the module-level
- Opportunity to move this all into
basis.ts, our transcoder module that is also module-level. Only if you guys think so?
There was a problem hiding this comment.
@RaananW will probably vote for no class :) (And I agree!)
| * @returns a promise that resolves when the worker is initialized | ||
| * @internal | ||
| */ | ||
| export function initializeWebWorker(worker: Worker, wasmBinary: ArrayBuffer, moduleUrl?: string) { |
There was a problem hiding this comment.
NOTE: I'd like to eventually move this to workerUtils and reuse, if possible, across other places... but perhaps sometime after this PR. I don't think this makes it to the public API right now, anyway
There was a problem hiding this comment.
yup let's keep this one under control :D
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
| * @returns a promise resolving with the basis-encoded image data | ||
| * @experimental This API is subject to change in the future. | ||
| */ | ||
| export async function EncodeTextureToBasisAsync(babylonTexture: BaseTexture, options?: Pick<BasisEncoderParameters, "basisFormat">): Promise<Uint8Array> { |
There was a problem hiding this comment.
I considered making the input just an ArrayBuffer[View] of 32-bit RGBA pixel data, but decided against it for now for ease of use (and so I do not have to check so many cases :))
We can always create another method later, should a user want to be able to pass raw image data.
Does this make sense?
| */ | ||
| export async function EncodeTextureToBasisAsync(babylonTexture: BaseTexture, options?: Pick<BasisEncoderParameters, "basisFormat">): Promise<Uint8Array> { | ||
| // Wait for texture to load so we can get its size | ||
| await WhenTextureReadyAsync(babylonTexture); |
There was a problem hiding this comment.
If a texture never loads (maybe it is delay-loaded), then this function will hang indefinitely. Is this OK?
On a higher-level note, I keep going back and forth over whether we should wait for the texture to load, or if the user should.
I initially thought that we should handle it internally, which is the case right now. But then I considered the delay loading case above, and now I'm not so sure.
(For context, the texture needs to be loaded for using readPixels and getting the texture's size.)
There was a problem hiding this comment.
that's fine by me, the error will still be on the console for the user to debug. That being said, you can detect that the texture is delay loaded and force load it
|
WebGL2 visualization test reporter: |
|
Visualization tests for WebGPU |
|
Converting back to draft until we decide on a long-term plan to standardize how we use compression codecs. Especially because we have a separate KTX2 decoder package, we think this would also be best as a separate package. Same goes for other codecs like Draco's. Once that's sorted, I'll stage what's here accordingly and re-open. |
This PR exposes the method
EncodeTextureToBasisAsyncwhich will encode a non-HDR, non-cube texture data to a KTX v2 image with Basis Universal supercompression.