Skip to content

Commit bec588f

Browse files
authored
Add list of supported KHR extensions to bevy_gltf's docs (#19100)
# Objective - Fixes #15068 ## Solution - Docs! ## Testing I created this list by browsing Bevy's source code rather than testing gltf files so its possible there is some partial/wonky support I didn't uncover.
1 parent d639d59 commit bec588f

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

crates/bevy_gltf/src/lib.rs

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,43 @@
8989
//! Be careful when using this feature, if you misspell a label it will simply ignore it without warning.
9090
//!
9191
//! You can use [`GltfAssetLabel`] to ensure you are using the correct label.
92+
//!
93+
//! # Supported KHR Extensions
94+
//!
95+
//! glTF files may use functionality beyond the base glTF specification, specified as a list of
96+
//! required extensions. The table below shows which of the ratified Khronos extensions are
97+
//! supported by Bevy.
98+
//!
99+
//! | Extension | Supported | Requires feature |
100+
//! | --------------------------------- | --------- | ----------------------------------- |
101+
//! | `KHR_animation_pointer` | ❌ | |
102+
//! | `KHR_draco_mesh_compression` | ❌ | |
103+
//! | `KHR_lights_punctual` | ✅ | |
104+
//! | `KHR_materials_anisotropy` | ✅ | `pbr_anisotropy_texture` |
105+
//! | `KHR_materials_clearcoat` | ✅ | `pbr_multi_layer_material_textures` |
106+
//! | `KHR_materials_dispersion` | ❌ | |
107+
//! | `KHR_materials_emissive_strength` | ✅ | |
108+
//! | `KHR_materials_ior` | ✅ | |
109+
//! | `KHR_materials_iridescence` | ❌ | |
110+
//! | `KHR_materials_sheen` | ❌ | |
111+
//! | `KHR_materials_specular` | ✅ | `pbr_specular_textures` |
112+
//! | `KHR_materials_transmission` | ✅ | `pbr_transmission_textures` |
113+
//! | `KHR_materials_unlit` | ✅ | |
114+
//! | `KHR_materials_variants` | ❌ | |
115+
//! | `KHR_materials_volume` | ✅ | |
116+
//! | `KHR_mesh_quantization` | ❌ | |
117+
//! | `KHR_texture_basisu` | ❌\* | |
118+
//! | `KHR_texture_transform` | ✅\** | |
119+
//! | `KHR_xmp_json_ld` | ❌ | |
120+
//! | `EXT_mesh_gpu_instancing` | ❌ | |
121+
//! | `EXT_meshopt_compression` | ❌ | |
122+
//! | `EXT_texture_webp` | ❌\* | |
123+
//!
124+
//! \*Bevy supports ktx2 and webp formats but doesn't support the extension's syntax, see [#19104](https://github.com/bevyengine/bevy/issues/19104).
125+
//!
126+
//! \**`KHR_texture_transform` is only supported on `base_color_texture`, see [#15310](https://github.com/bevyengine/bevy/issues/15310).
127+
//!
128+
//! See the [glTF Extension Registry](https://github.com/KhronosGroup/glTF/blob/main/extensions/README.md) for more information on extensions.
92129
93130
mod assets;
94131
mod convert_coordinates;

0 commit comments

Comments
 (0)