[Merged by Bors] - Support array / cubemap / cubemap array textures in KTX2 #5325

superdump · 2022-07-15T09:06:51Z

Objective

Fix / support KTX2 array / cubemap / cubemap array textures
Fixes Unable to load texture array file in ktx2 format #4495 . Supersedes bevy_render: Fix KTX2 UASTC array textures #4514 .

Solution

Add Option<TextureViewDescriptor> to Image to enable configuration of the TextureViewDimension of a texture.
- This allows users to set D2Array, D3, Cube, CubeArray or whatever they need
- Automatically configure this when loading KTX2
Transcode all layers and faces instead of just one
Use the UASTC block size of 128 bits, and the number of blocks in x/y for a given mip level in order to determine the offset of the layer and face within the KTX2 mip level data
wgpu wants data ordered as layer 0 mip 0..n, layer 1 mip 0..n, etc. See https://docs.rs/wgpu/latest/wgpu/util/trait.DeviceExt.html#tymethod.create_texture_with_data
Reorder the data KTX2 mip X layer Y face Z to wgpu layer Y face Z mip X order
Add a skybox example to demonstrate / test loading cubemaps from PNG and KTX2, including ASTC 4x4, BC7, and ETC2 compression for support everywhere. Note that you need to enable the ktx2,zstd features to be able to load the compressed textures.

Changelog

Fixed: KTX2 array / cubemap / cubemap array textures
Fixes: Validation failure for compressed textures stored in KTX2 where the width/height are not a multiple of the block dimensions.
Added: Image now has an Option<TextureViewDescriptor> field to enable configuration of the texture view. This is useful for configuring the TextureViewDimension when it is not just a plain 2D texture and the loader could/did not identify what it should be.

This allows configuration of custom TextureViewDimension for cubemaps, etc.

… handling

alice-i-cecile · 2022-07-15T12:49:45Z

Do we have a setup for testing this sort of thing in CI?

superdump · 2022-07-15T14:10:29Z

Do we have a setup for testing this sort of thing in CI?

I want to, for sure. First I need a clean example that exercises the different cases. I currently have a mass of code locally. :)

alice-i-cecile · 2022-07-18T13:48:16Z

bors try

bors · 2022-07-18T14:05:52Z

try

Build succeeded:

…ical size wgpu 0.13 has validation to ensure that the width and height specified for a texture are both multiples of the respective block width and block height. Using Extent3d's physical_size() method, that takes a TextureFormat argument, ensures this.

Uses multiple different compressed texture formats for compatibility.

superdump · 2022-07-21T10:12:20Z

Note that this adds the following textures to the repo:

 669336 assets/textures/Ryfjallet_cubemap.png
1451640 assets/textures/Ryfjallet_cubemap_astc4x4.ktx2
1360022 assets/textures/Ryfjallet_cubemap_bc7.ktx2
 603092 assets/textures/Ryfjallet_cubemap_etc2.ktx2

Cargo.toml

examples/README.md

alice-i-cecile

Seemingly rendering correctly for me on Windows 10. Colors and stitching are correct. The code itself looks fine from a quality perspective.

We should clean up the example comment, as @mockersf notes.
The camera controls aren't doing anything for me; does it makes sense for non-mouse controls to be enabled here?
I'm getting a stream of warnings in the terminal:

2022-07-21T17:07:48.591226Z WARN bevy_asset::asset_server: no AssetLoader found for the following extension: ktx2
2022-07-21T17:07:51.591514Z INFO skybox: Skipping unsupported format: ("textures/Ryfjallet_cubemap_etc2.ktx2", ETC2)
2022-07-21T17:07:52.141224Z INFO skybox: Swapping to textures/Ryfjallet_cubemap.png...
2022-07-21T17:07:54.590887Z INFO skybox: Skipping unsupported format: ("textures/Ryfjallet_cubemap_astc4x4.ktx2", ASTC_LDR)

mockersf · 2022-07-21T20:38:32Z

The camera controls aren't doing anything for me; does it makes sense for non-mouse controls to be enabled here?

That's a skybox, moving the camera shouldn't change it. Maybe placing a cube to show that the camera is moving could be useful?

I'm getting a stream of warnings in the terminal:

2022-07-21T17:07:48.591226Z WARN bevy_asset::asset_server: no AssetLoader found for the following extension: ktx2 2022-07-21T17:07:51.591514Z INFO skybox: Skipping unsupported format: ("textures/Ryfjallet_cubemap_etc2.ktx2", ETC2) 2022-07-21T17:07:52.141224Z INFO skybox: Swapping to textures/Ryfjallet_cubemap.png... 2022-07-21T17:07:54.590887Z INFO skybox: Skipping unsupported format: ("textures/Ryfjallet_cubemap_astc4x4.ktx2", ASTC_LDR)

You're GPU probably doesn't support compressed textures

superdump · 2022-07-21T21:50:40Z

In the version of them example where I had environment mapped reflections, I had the grid of pbr spheres, but I quickly removed them from the example as they don't make sense without the reflections. But something to anchor the view I suppose. Even if it's just the 3d_scene setup. :)

superdump · 2022-07-21T21:52:52Z

There's probably a clearer UX for showing which compressed formats are supported, and which is being used.

HackerFoo · 2022-07-30T05:54:16Z

crates/bevy_render/src/texture/ktx2.rs

+                        );
+                        let (num_blocks_x, num_blocks_y) = (
+                            ((level_width + block_width_pixels - 1) / block_width_pixels) .max(1),
+                            ((level_height + block_height_pixels - 1) / block_height_pixels) .max(1),


Division rounding up is used often. Could we abstract this into a local definition of div_ceil until it's available?

Also, maybe NonZeroUsize could help to avoid most of the .max(1) suffixes.

Good idea! I was thinking of extracting the rounding code. Some functionality is in wgpu’s texture format description but there are other cases. I’m going to be out today so won’t have time to address this unfortunately.

Given that we're shotgunning this into 0.8 (and rob isn't available to make changes right now), I think this should be done later. Good idea though!

Co-authored-by: François <mockersf@gmail.com>

assets/shaders/cubemap_unlit.wgsl

cart · 2022-07-30T07:02:42Z

bors r+

# Objective - Fix / support KTX2 array / cubemap / cubemap array textures - Fixes #4495 . Supersedes #4514 . ## Solution - Add `Option<TextureViewDescriptor>` to `Image` to enable configuration of the `TextureViewDimension` of a texture. - This allows users to set `D2Array`, `D3`, `Cube`, `CubeArray` or whatever they need - Automatically configure this when loading KTX2 - Transcode all layers and faces instead of just one - Use the UASTC block size of 128 bits, and the number of blocks in x/y for a given mip level in order to determine the offset of the layer and face within the KTX2 mip level data - `wgpu` wants data ordered as layer 0 mip 0..n, layer 1 mip 0..n, etc. See https://docs.rs/wgpu/latest/wgpu/util/trait.DeviceExt.html#tymethod.create_texture_with_data - Reorder the data KTX2 mip X layer Y face Z to `wgpu` layer Y face Z mip X order - Add a `skybox` example to demonstrate / test loading cubemaps from PNG and KTX2, including ASTC 4x4, BC7, and ETC2 compression for support everywhere. Note that you need to enable the `ktx2,zstd` features to be able to load the compressed textures. --- ## Changelog - Fixed: KTX2 array / cubemap / cubemap array textures - Fixes: Validation failure for compressed textures stored in KTX2 where the width/height are not a multiple of the block dimensions. - Added: `Image` now has an `Option<TextureViewDescriptor>` field to enable configuration of the texture view. This is useful for configuring the `TextureViewDimension` when it is not just a plain 2D texture and the loader could/did not identify what it should be. Co-authored-by: Carter Anderson <mcanders1@gmail.com>

bors · 2022-07-30T07:24:20Z

Pull request successfully merged into main.

Build succeeded:

…5325) # Objective - Fix / support KTX2 array / cubemap / cubemap array textures - Fixes bevyengine#4495 . Supersedes bevyengine#4514 . ## Solution - Add `Option<TextureViewDescriptor>` to `Image` to enable configuration of the `TextureViewDimension` of a texture. - This allows users to set `D2Array`, `D3`, `Cube`, `CubeArray` or whatever they need - Automatically configure this when loading KTX2 - Transcode all layers and faces instead of just one - Use the UASTC block size of 128 bits, and the number of blocks in x/y for a given mip level in order to determine the offset of the layer and face within the KTX2 mip level data - `wgpu` wants data ordered as layer 0 mip 0..n, layer 1 mip 0..n, etc. See https://docs.rs/wgpu/latest/wgpu/util/trait.DeviceExt.html#tymethod.create_texture_with_data - Reorder the data KTX2 mip X layer Y face Z to `wgpu` layer Y face Z mip X order - Add a `skybox` example to demonstrate / test loading cubemaps from PNG and KTX2, including ASTC 4x4, BC7, and ETC2 compression for support everywhere. Note that you need to enable the `ktx2,zstd` features to be able to load the compressed textures. --- ## Changelog - Fixed: KTX2 array / cubemap / cubemap array textures - Fixes: Validation failure for compressed textures stored in KTX2 where the width/height are not a multiple of the block dimensions. - Added: `Image` now has an `Option<TextureViewDescriptor>` field to enable configuration of the texture view. This is useful for configuring the `TextureViewDimension` when it is not just a plain 2D texture and the loader could/did not identify what it should be. Co-authored-by: Carter Anderson <mcanders1@gmail.com>

superdump added 3 commits July 14, 2022 15:14

bevy_render: Add an optional TextureViewDescriptor to Image

668e96d

This allows configuration of custom TextureViewDimension for cubemaps, etc.

bevy_render: Fix and improve KTX2 array/cubemap/cubemap array texture…

949999a

… handling

bevy_render: Automatically configure the texture view dimension for KTX2

13ddd58

superdump added C-Bug An unexpected or incorrect behavior C-Enhancement A new feature A-Rendering Drawing game state to the screen labels Jul 15, 2022

superdump added this to the Bevy 0.8 milestone Jul 15, 2022

Merge branch 'main' into ktx2-array-cubemap

2031fb3

superdump mentioned this pull request Jul 15, 2022

bevy_render: Fix KTX2 UASTC array textures #4514

Closed

superdump requested a review from cart July 15, 2022 09:56

superdump changed the title ~~Ktx2 array cubemap~~ Support array / cubemap / cubemap array textures in KTX2 Jul 15, 2022

bors bot added a commit that referenced this pull request Jul 18, 2022

Try #5325:

731eaf0

superdump added 3 commits July 19, 2022 13:10

Merge branch 'main' into ktx2-array-cubemap

09f9bee

Add skybox example for testing cubemaps

76dc3ca

Uses multiple different compressed texture formats for compatibility.

superdump added 2 commits July 21, 2022 12:16

Appease clippy

970830a

skybox: Clarify required cargo features

d54a8eb

mockersf reviewed Jul 21, 2022

View reviewed changes

Cargo.toml Show resolved Hide resolved

mockersf reviewed Jul 21, 2022

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

alice-i-cecile mentioned this pull request Jul 21, 2022

[Merged by Bors] - Fix KTX2 R8_SRGB, R8_UNORM, R8G8_SRGB, R8G8_UNORM, R8G8B8_SRGB, R8G8B8_UNORM support #4594

Closed

alice-i-cecile reviewed Jul 21, 2022

View reviewed changes

examples/README.md Outdated Show resolved Hide resolved

alice-i-cecile requested changes Jul 21, 2022

View reviewed changes

cart removed this from the Bevy 0.8 milestone Jul 30, 2022

HackerFoo reviewed Jul 30, 2022

View reviewed changes

superdump and others added 2 commits July 30, 2022 08:38

Update Cargo.toml

ac0803e

Co-authored-by: François <mockersf@gmail.com>

Update Cargo.toml

4082590

Co-authored-by: François <mockersf@gmail.com>

superdump commented Jul 30, 2022

View reviewed changes

assets/shaders/cubemap_unlit.wgsl Outdated Show resolved Hide resolved

superdump commented Jul 30, 2022

View reviewed changes

assets/shaders/cubemap_unlit.wgsl Show resolved Hide resolved

cart added 2 commits July 29, 2022 23:59

Address shader comments

4198858

Fix readme

b10ae8e

bors bot changed the title ~~Support array / cubemap / cubemap array textures in KTX2~~ [Merged by Bors] - Support array / cubemap / cubemap array textures in KTX2 Jul 30, 2022

bors bot closed this Jul 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Support array / cubemap / cubemap array textures in KTX2 #5325

[Merged by Bors] - Support array / cubemap / cubemap array textures in KTX2 #5325

superdump commented Jul 15, 2022 •

edited

alice-i-cecile commented Jul 15, 2022

superdump commented Jul 15, 2022

alice-i-cecile commented Jul 18, 2022

bors bot commented Jul 18, 2022

superdump commented Jul 21, 2022

alice-i-cecile left a comment •

edited

mockersf commented Jul 21, 2022

superdump commented Jul 21, 2022

superdump commented Jul 21, 2022

HackerFoo Jul 30, 2022

superdump Jul 30, 2022

cart Jul 30, 2022

cart commented Jul 30, 2022

bors bot commented Jul 30, 2022

[Merged by Bors] - Support array / cubemap / cubemap array textures in KTX2 #5325

[Merged by Bors] - Support array / cubemap / cubemap array textures in KTX2 #5325

Conversation

superdump commented Jul 15, 2022 • edited

Objective

Solution

Changelog

alice-i-cecile commented Jul 15, 2022

superdump commented Jul 15, 2022

alice-i-cecile commented Jul 18, 2022

bors bot commented Jul 18, 2022

try

superdump commented Jul 21, 2022

alice-i-cecile left a comment • edited

Choose a reason for hiding this comment

mockersf commented Jul 21, 2022

superdump commented Jul 21, 2022

superdump commented Jul 21, 2022

HackerFoo Jul 30, 2022

Choose a reason for hiding this comment

superdump Jul 30, 2022

Choose a reason for hiding this comment

cart Jul 30, 2022

Choose a reason for hiding this comment

cart commented Jul 30, 2022

bors bot commented Jul 30, 2022

superdump commented Jul 15, 2022 •

edited

alice-i-cecile left a comment •

edited