-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #76572 from acazuc/ktx_format_support
Add support for KTX image format so that we can use Basis Universal for GLTF
- Loading branch information
Showing
55 changed files
with
20,856 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 66 additions & 0 deletions
66
modules/gltf/extensions/gltf_document_extension_texture_ktx.cpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| /**************************************************************************/ | ||
| /* gltf_document_extension_texture_ktx.cpp */ | ||
| /**************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /**************************************************************************/ | ||
| /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | ||
| /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ | ||
| /* */ | ||
| /* Permission is hereby granted, free of charge, to any person obtaining */ | ||
| /* a copy of this software and associated documentation files (the */ | ||
| /* "Software"), to deal in the Software without restriction, including */ | ||
| /* without limitation the rights to use, copy, modify, merge, publish, */ | ||
| /* distribute, sublicense, and/or sell copies of the Software, and to */ | ||
| /* permit persons to whom the Software is furnished to do so, subject to */ | ||
| /* the following conditions: */ | ||
| /* */ | ||
| /* The above copyright notice and this permission notice shall be */ | ||
| /* included in all copies or substantial portions of the Software. */ | ||
| /* */ | ||
| /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ | ||
| /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ | ||
| /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | ||
| /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ | ||
| /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ | ||
| /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ | ||
| /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #include "gltf_document_extension_texture_ktx.h" | ||
|
|
||
| // Import process. | ||
| Error GLTFDocumentExtensionTextureKTX::import_preflight(Ref<GLTFState> p_state, Vector<String> p_extensions) { | ||
| if (!p_extensions.has("KHR_texture_basisu")) { | ||
| return ERR_SKIP; | ||
| } | ||
| return OK; | ||
| } | ||
|
|
||
| Vector<String> GLTFDocumentExtensionTextureKTX::get_supported_extensions() { | ||
| Vector<String> ret; | ||
| ret.push_back("KHR_texture_basisu"); | ||
| return ret; | ||
| } | ||
|
|
||
| Error GLTFDocumentExtensionTextureKTX::parse_image_data(Ref<GLTFState> p_state, const PackedByteArray &p_image_data, const String &p_mime_type, Ref<Image> r_image) { | ||
| if (p_mime_type == "image/ktx2") { | ||
| return r_image->load_ktx_from_buffer(p_image_data); | ||
| } | ||
| return OK; | ||
| } | ||
|
|
||
| Error GLTFDocumentExtensionTextureKTX::parse_texture_json(Ref<GLTFState> p_state, const Dictionary &p_texture_json, Ref<GLTFTexture> r_gltf_texture) { | ||
| if (!p_texture_json.has("extensions")) { | ||
| return OK; | ||
| } | ||
| const Dictionary &extensions = p_texture_json["extensions"]; | ||
| if (!extensions.has("KHR_texture_basisu")) { | ||
| return OK; | ||
| } | ||
| const Dictionary &texture_ktx = extensions["KHR_texture_basisu"]; | ||
| ERR_FAIL_COND_V(!texture_ktx.has("source"), ERR_PARSE_ERROR); | ||
| r_gltf_texture->set_src_image(texture_ktx["source"]); | ||
| return OK; | ||
| } |
47 changes: 47 additions & 0 deletions
47
modules/gltf/extensions/gltf_document_extension_texture_ktx.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /**************************************************************************/ | ||
| /* gltf_document_extension_texture_ktx.h */ | ||
| /**************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /**************************************************************************/ | ||
| /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | ||
| /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ | ||
| /* */ | ||
| /* Permission is hereby granted, free of charge, to any person obtaining */ | ||
| /* a copy of this software and associated documentation files (the */ | ||
| /* "Software"), to deal in the Software without restriction, including */ | ||
| /* without limitation the rights to use, copy, modify, merge, publish, */ | ||
| /* distribute, sublicense, and/or sell copies of the Software, and to */ | ||
| /* permit persons to whom the Software is furnished to do so, subject to */ | ||
| /* the following conditions: */ | ||
| /* */ | ||
| /* The above copyright notice and this permission notice shall be */ | ||
| /* included in all copies or substantial portions of the Software. */ | ||
| /* */ | ||
| /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ | ||
| /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ | ||
| /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | ||
| /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ | ||
| /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ | ||
| /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ | ||
| /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #ifndef GLTF_DOCUMENT_EXTENSION_TEXTURE_KTX_H | ||
| #define GLTF_DOCUMENT_EXTENSION_TEXTURE_KTX_H | ||
|
|
||
| #include "gltf_document_extension.h" | ||
|
|
||
| class GLTFDocumentExtensionTextureKTX : public GLTFDocumentExtension { | ||
| GDCLASS(GLTFDocumentExtensionTextureKTX, GLTFDocumentExtension); | ||
|
|
||
| public: | ||
| // Import process. | ||
| Error import_preflight(Ref<GLTFState> p_state, Vector<String> p_extensions) override; | ||
| Vector<String> get_supported_extensions() override; | ||
| Error parse_image_data(Ref<GLTFState> p_state, const PackedByteArray &p_image_data, const String &p_mime_type, Ref<Image> r_image) override; | ||
| Error parse_texture_json(Ref<GLTFState> p_state, const Dictionary &p_texture_json, Ref<GLTFTexture> r_gltf_texture) override; | ||
| }; | ||
|
|
||
| #endif // GLTF_DOCUMENT_EXTENSION_TEXTURE_KTX_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| #!/usr/bin/env python | ||
|
|
||
| Import("env") | ||
| Import("env_modules") | ||
|
|
||
| env_ktx = env_modules.Clone() | ||
|
|
||
| # libktx thirdparty source files | ||
|
|
||
| thirdparty_obj = [] | ||
|
|
||
| thirdparty_dir = "#thirdparty/libktx/" | ||
| thirdparty_sources = [ | ||
| "lib/checkheader.c", | ||
| "lib/filestream.c", | ||
| "lib/hashlist.c", | ||
| "lib/memstream.c", | ||
| "lib/swap.c", | ||
| "lib/texture.c", | ||
| "lib/texture1.c", | ||
| "lib/texture2.c", | ||
| "lib/dfdutils/createdfd.c", | ||
| "lib/dfdutils/colourspaces.c", | ||
| "lib/dfdutils/interpretdfd.c", | ||
| "lib/dfdutils/printdfd.c", | ||
| "lib/dfdutils/queries.c", | ||
| "lib/dfdutils/vk2dfd.c", | ||
| ] | ||
| thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources] | ||
|
|
||
| env_ktx.Prepend(CPPPATH=[thirdparty_dir + "include"]) | ||
| env_ktx.Prepend(CPPPATH=[thirdparty_dir + "utils"]) | ||
| env_ktx.Prepend(CPPPATH=[thirdparty_dir + "lib"]) | ||
| env_ktx.Prepend(CPPPATH=[thirdparty_dir + "other_include"]) | ||
|
|
||
| if env["module_basis_universal_enabled"]: | ||
| thirdparty_sources += [thirdparty_dir + "lib/basis_transcode.cpp"] | ||
| env_ktx.Prepend(CPPPATH=["#thirdparty/basis_universal"]) | ||
|
|
||
| if env["vulkan"]: | ||
| env_ktx.Prepend(CPPPATH=["#thirdparty/vulkan/include"]) | ||
| else: | ||
| # Falls back on bundled `vkformat_enum.h`. | ||
| env_ktx.Append(CPPDEFINES=["LIBKTX"]) | ||
|
|
||
| env_ktx.Append(CPPDEFINES=[("KHRONOS_STATIC", 1)]) | ||
|
|
||
| env_thirdparty = env_ktx.Clone() | ||
| env_thirdparty.disable_warnings() | ||
| env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources) | ||
| env.modules_sources += thirdparty_obj | ||
|
|
||
| # Godot source files | ||
| module_obj = [] | ||
|
|
||
| env_ktx.add_source_files(module_obj, "*.cpp") | ||
| env.modules_sources += module_obj | ||
|
|
||
| # Needed to force rebuilding the module files when the thirdparty library is updated. | ||
| env.Depends(module_obj, thirdparty_obj) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| def can_build(env, platform): | ||
| return True | ||
|
|
||
|
|
||
| def configure(env): | ||
| pass |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /**************************************************************************/ | ||
| /* register_types.cpp */ | ||
| /**************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /**************************************************************************/ | ||
| /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | ||
| /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ | ||
| /* */ | ||
| /* Permission is hereby granted, free of charge, to any person obtaining */ | ||
| /* a copy of this software and associated documentation files (the */ | ||
| /* "Software"), to deal in the Software without restriction, including */ | ||
| /* without limitation the rights to use, copy, modify, merge, publish, */ | ||
| /* distribute, sublicense, and/or sell copies of the Software, and to */ | ||
| /* permit persons to whom the Software is furnished to do so, subject to */ | ||
| /* the following conditions: */ | ||
| /* */ | ||
| /* The above copyright notice and this permission notice shall be */ | ||
| /* included in all copies or substantial portions of the Software. */ | ||
| /* */ | ||
| /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ | ||
| /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ | ||
| /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | ||
| /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ | ||
| /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ | ||
| /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ | ||
| /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #include "register_types.h" | ||
|
|
||
| #include "texture_loader_ktx.h" | ||
|
|
||
| static Ref<ResourceFormatKTX> resource_loader_ktx; | ||
|
|
||
| void initialize_ktx_module(ModuleInitializationLevel p_level) { | ||
| if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) { | ||
| return; | ||
| } | ||
|
|
||
| resource_loader_ktx.instantiate(); | ||
| ResourceLoader::add_resource_format_loader(resource_loader_ktx); | ||
| } | ||
|
|
||
| void uninitialize_ktx_module(ModuleInitializationLevel p_level) { | ||
| if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) { | ||
| return; | ||
| } | ||
|
|
||
| ResourceLoader::remove_resource_format_loader(resource_loader_ktx); | ||
| resource_loader_ktx.unref(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /**************************************************************************/ | ||
| /* register_types.h */ | ||
| /**************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /**************************************************************************/ | ||
| /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | ||
| /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ | ||
| /* */ | ||
| /* Permission is hereby granted, free of charge, to any person obtaining */ | ||
| /* a copy of this software and associated documentation files (the */ | ||
| /* "Software"), to deal in the Software without restriction, including */ | ||
| /* without limitation the rights to use, copy, modify, merge, publish, */ | ||
| /* distribute, sublicense, and/or sell copies of the Software, and to */ | ||
| /* permit persons to whom the Software is furnished to do so, subject to */ | ||
| /* the following conditions: */ | ||
| /* */ | ||
| /* The above copyright notice and this permission notice shall be */ | ||
| /* included in all copies or substantial portions of the Software. */ | ||
| /* */ | ||
| /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ | ||
| /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ | ||
| /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | ||
| /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ | ||
| /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ | ||
| /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ | ||
| /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #ifndef KTX_REGISTER_TYPES_H | ||
| #define KTX_REGISTER_TYPES_H | ||
|
|
||
| #include "modules/register_module_types.h" | ||
|
|
||
| void initialize_ktx_module(ModuleInitializationLevel p_level); | ||
| void uninitialize_ktx_module(ModuleInitializationLevel p_level); | ||
|
|
||
| #endif // KTX_REGISTER_TYPES_H |
Oops, something went wrong.