0be6d925dc
Which means that reduz' beloved style which we all became used to will now be changed automatically to remove the first empty line. This makes us lean closer to 1TBS (the one true brace style) instead of hybridating it with some Allman-inspired spacing. There's still the case of braces around single-statement blocks that needs to be addressed (but clang-format can't help with that, but clang-tidy may if we agree about it). Part of #33027.
455 lines
16 KiB
C++
455 lines
16 KiB
C++
/*************************************************************************/
|
|
/* resource_importer_layered_texture.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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 "resource_importer_layered_texture.h"
|
|
|
|
#include "resource_importer_texture.h"
|
|
|
|
#include "core/io/config_file.h"
|
|
#include "core/io/image_loader.h"
|
|
#include "editor/editor_file_system.h"
|
|
#include "editor/editor_node.h"
|
|
#include "resource_importer_texture.h"
|
|
#include "scene/resources/texture.h"
|
|
|
|
String ResourceImporterLayeredTexture::get_importer_name() const {
|
|
switch (mode) {
|
|
case MODE_CUBEMAP: {
|
|
return "cubemap_texture";
|
|
} break;
|
|
case MODE_2D_ARRAY: {
|
|
return "2d_array_texture";
|
|
} break;
|
|
case MODE_CUBEMAP_ARRAY: {
|
|
return "cubemap_array_texture";
|
|
} break;
|
|
case MODE_3D: {
|
|
return "cubemap_3d_texture";
|
|
} break;
|
|
}
|
|
|
|
ERR_FAIL_V("");
|
|
}
|
|
|
|
String ResourceImporterLayeredTexture::get_visible_name() const {
|
|
switch (mode) {
|
|
case MODE_CUBEMAP: {
|
|
return "Cubemap";
|
|
} break;
|
|
case MODE_2D_ARRAY: {
|
|
return "Texture2DArray";
|
|
} break;
|
|
case MODE_CUBEMAP_ARRAY: {
|
|
return "CubemapArray";
|
|
} break;
|
|
case MODE_3D: {
|
|
return "3D";
|
|
} break;
|
|
}
|
|
|
|
ERR_FAIL_V("");
|
|
}
|
|
void ResourceImporterLayeredTexture::get_recognized_extensions(List<String> *p_extensions) const {
|
|
ImageLoader::get_recognized_extensions(p_extensions);
|
|
}
|
|
String ResourceImporterLayeredTexture::get_save_extension() const {
|
|
switch (mode) {
|
|
case MODE_CUBEMAP: {
|
|
return "scube";
|
|
} break;
|
|
case MODE_2D_ARRAY: {
|
|
return "stexarray";
|
|
} break;
|
|
case MODE_CUBEMAP_ARRAY: {
|
|
return "scubearray";
|
|
} break;
|
|
case MODE_3D: {
|
|
return "stex3d";
|
|
} break;
|
|
}
|
|
|
|
ERR_FAIL_V(String());
|
|
}
|
|
|
|
String ResourceImporterLayeredTexture::get_resource_type() const {
|
|
switch (mode) {
|
|
case MODE_CUBEMAP: {
|
|
return "StreamCubemap";
|
|
} break;
|
|
case MODE_2D_ARRAY: {
|
|
return "StreamTexture2DArray";
|
|
} break;
|
|
case MODE_CUBEMAP_ARRAY: {
|
|
return "StreamCubemapArray";
|
|
} break;
|
|
case MODE_3D: {
|
|
return "StreamTexture3D";
|
|
} break;
|
|
}
|
|
ERR_FAIL_V(String());
|
|
}
|
|
|
|
bool ResourceImporterLayeredTexture::get_option_visibility(const String &p_option, const Map<StringName, Variant> &p_options) const {
|
|
if (p_option == "compress/lossy_quality" && p_options.has("compress/mode")) {
|
|
return int(p_options["compress/mode"]) == COMPRESS_LOSSY;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
int ResourceImporterLayeredTexture::get_preset_count() const {
|
|
return 0;
|
|
}
|
|
String ResourceImporterLayeredTexture::get_preset_name(int p_idx) const {
|
|
return "";
|
|
}
|
|
|
|
void ResourceImporterLayeredTexture::get_import_options(List<ImportOption> *r_options, int p_preset) const {
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "compress/mode", PROPERTY_HINT_ENUM, "Lossless,Lossy,Video RAM,Uncompressed,Basis Universal", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED), 1));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::FLOAT, "compress/lossy_quality", PROPERTY_HINT_RANGE, "0,1,0.01"), 0.7));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "compress/hdr_compression", PROPERTY_HINT_ENUM, "Disabled,Opaque Only,Always"), 1));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "compress/bptc_ldr", PROPERTY_HINT_ENUM, "Disabled,Enabled,RGBA Only"), 0));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "compress/channel_pack", PROPERTY_HINT_ENUM, "sRGB Friendly,Optimized"), 0));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::BOOL, "mipmaps/generate"), true));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "mipmaps/limit", PROPERTY_HINT_RANGE, "-1,256"), -1));
|
|
|
|
if (mode == MODE_2D_ARRAY || mode == MODE_3D) {
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "slices/horizontal", PROPERTY_HINT_RANGE, "1,256,1"), 8));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "slices/vertical", PROPERTY_HINT_RANGE, "1,256,1"), 8));
|
|
}
|
|
if (mode == MODE_CUBEMAP || mode == MODE_CUBEMAP_ARRAY) {
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "slices/arrangement", PROPERTY_HINT_ENUM, "1x6,2x3,3x2,6x1"), 1));
|
|
if (mode == MODE_CUBEMAP_ARRAY) {
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "slices/layout", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), 1));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "slices/amount", PROPERTY_HINT_RANGE, "1,1024,1,or_greater"), 1));
|
|
}
|
|
}
|
|
}
|
|
|
|
void ResourceImporterLayeredTexture::_save_tex(Vector<Ref<Image>> p_images, const String &p_to_path, int p_compress_mode, float p_lossy, Image::CompressMode p_vram_compression, Image::CompressSource p_csource, Image::UsedChannels used_channels, bool p_mipmaps, bool p_force_po2) {
|
|
for (int i = 0; i < p_images.size(); i++) {
|
|
if (p_force_po2) {
|
|
p_images.write[i]->resize_to_po2();
|
|
}
|
|
|
|
if (p_mipmaps) {
|
|
p_images.write[i]->generate_mipmaps();
|
|
} else {
|
|
p_images.write[i]->clear_mipmaps();
|
|
}
|
|
}
|
|
|
|
FileAccessRef f = FileAccess::open(p_to_path, FileAccess::WRITE);
|
|
f->store_8('G');
|
|
f->store_8('S');
|
|
f->store_8('T');
|
|
f->store_8('L');
|
|
|
|
f->store_32(StreamTextureLayered::FORMAT_VERSION);
|
|
f->store_32(p_images.size());
|
|
f->store_32(mode);
|
|
f->store_32(0); //dataformat
|
|
f->store_32(0); //mipmap limit
|
|
|
|
//reserverd
|
|
f->store_32(0);
|
|
f->store_32(0);
|
|
f->store_32(0);
|
|
|
|
for (int i = 0; i < p_images.size(); i++) {
|
|
ResourceImporterTexture::save_to_stex_format(f, p_images[i], ResourceImporterTexture::CompressMode(p_compress_mode), used_channels, p_vram_compression, p_lossy);
|
|
}
|
|
|
|
f->close();
|
|
}
|
|
|
|
Error ResourceImporterLayeredTexture::import(const String &p_source_file, const String &p_save_path, const Map<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files, Variant *r_metadata) {
|
|
int compress_mode = p_options["compress/mode"];
|
|
float lossy = p_options["compress/lossy_quality"];
|
|
int hdr_compression = p_options["compress/hdr_compression"];
|
|
int bptc_ldr = p_options["compress/bptc_ldr"];
|
|
bool mipmaps = p_options["mipmaps/generate"];
|
|
//bool mipmap_limit = p_options["mipmaps/limit"];
|
|
|
|
int channel_pack = p_options["compress/channel_pack"];
|
|
int hslices = (p_options.has("slices/horizontal")) ? int(p_options["slices/horizontal"]) : 0;
|
|
int vslices = (p_options.has("slices/vertical")) ? int(p_options["slices/vertical"]) : 0;
|
|
int arrangement = (p_options.has("slices/arrangement")) ? int(p_options["slices/arrangement"]) : 0;
|
|
int layout = (p_options.has("slices/layout")) ? int(p_options["slices/layout"]) : 0;
|
|
int amount = (p_options.has("slices/amount")) ? int(p_options["slices/amount"]) : 0;
|
|
|
|
if (mode == MODE_CUBEMAP || mode == MODE_CUBEMAP_ARRAY) {
|
|
switch (arrangement) {
|
|
case CUBEMAP_FORMAT_1X6: {
|
|
hslices = 1;
|
|
vslices = 6;
|
|
} break;
|
|
case CUBEMAP_FORMAT_2X3: {
|
|
hslices = 2;
|
|
vslices = 3;
|
|
} break;
|
|
case CUBEMAP_FORMAT_3X2: {
|
|
hslices = 3;
|
|
vslices = 2;
|
|
} break;
|
|
case CUBEMAP_FORMAT_6X1: {
|
|
hslices = 6;
|
|
vslices = 1;
|
|
} break;
|
|
}
|
|
|
|
if (mode == MODE_CUBEMAP_ARRAY) {
|
|
if (layout == 0) {
|
|
hslices *= amount;
|
|
} else {
|
|
vslices *= amount;
|
|
}
|
|
}
|
|
}
|
|
|
|
Ref<Image> image;
|
|
image.instance();
|
|
Error err = ImageLoader::load_image(p_source_file, image, nullptr, false, 1.0);
|
|
if (err != OK)
|
|
return err;
|
|
|
|
if (compress_mode == COMPRESS_BASIS_UNIVERSAL && image->get_format() >= Image::FORMAT_RF) {
|
|
//basis universal does not support float formats, fall back
|
|
compress_mode = COMPRESS_VRAM_COMPRESSED;
|
|
}
|
|
|
|
if (compress_mode == COMPRESS_VRAM_COMPRESSED) {
|
|
mipmaps = true;
|
|
}
|
|
|
|
//optimize
|
|
if (compress_mode == COMPRESS_VRAM_COMPRESSED) {
|
|
//if using video ram, optimize
|
|
if (channel_pack == 0) {
|
|
//remove alpha if not needed, so compression is more efficient
|
|
if (image->get_format() == Image::FORMAT_RGBA8 && !image->detect_alpha()) {
|
|
image->convert(Image::FORMAT_RGB8);
|
|
}
|
|
} else if (image->get_format() < Image::FORMAT_RGBA8) {
|
|
image->optimize_channels();
|
|
}
|
|
}
|
|
|
|
Image::CompressSource csource = Image::COMPRESS_SOURCE_GENERIC;
|
|
if (channel_pack == 0) {
|
|
csource = Image::COMPRESS_SOURCE_SRGB;
|
|
}
|
|
|
|
Image::UsedChannels used_channels = image->detect_used_channels(csource);
|
|
|
|
Vector<Ref<Image>> slices;
|
|
|
|
int slice_w = image->get_width() / hslices;
|
|
int slice_h = image->get_height() / vslices;
|
|
|
|
for (int i = 0; i < vslices; i++) {
|
|
for (int j = 0; j < hslices; j++) {
|
|
int x = slice_w * j;
|
|
int y = slice_h * i;
|
|
Ref<Image> slice = image->get_rect(Rect2(x, y, slice_w, slice_h));
|
|
ERR_CONTINUE(slice.is_null() || slice->empty());
|
|
if (slice->get_width() != slice_w || slice->get_height() != slice_h) {
|
|
slice->resize(slice_w, slice_h);
|
|
}
|
|
slices.push_back(slice);
|
|
}
|
|
}
|
|
|
|
String extension = get_save_extension();
|
|
Array formats_imported;
|
|
|
|
if (compress_mode == COMPRESS_VRAM_COMPRESSED) {
|
|
//must import in all formats, in order of priority (so platform choses the best supported one. IE, etc2 over etc).
|
|
//Android, GLES 2.x
|
|
|
|
bool ok_on_pc = false;
|
|
bool is_hdr = (image->get_format() >= Image::FORMAT_RF && image->get_format() <= Image::FORMAT_RGBE9995);
|
|
bool is_ldr = (image->get_format() >= Image::FORMAT_L8 && image->get_format() <= Image::FORMAT_RGB565);
|
|
bool can_bptc = ProjectSettings::get_singleton()->get("rendering/vram_compression/import_bptc");
|
|
bool can_s3tc = ProjectSettings::get_singleton()->get("rendering/vram_compression/import_s3tc");
|
|
|
|
if (can_bptc) {
|
|
formats_imported.push_back("bptc"); //needs to be aded anyway
|
|
}
|
|
bool can_compress_hdr = hdr_compression > 0;
|
|
|
|
if (is_hdr && can_compress_hdr) {
|
|
if (used_channels == Image::USED_CHANNELS_LA || used_channels == Image::USED_CHANNELS_RGBA) {
|
|
//can compress hdr, but hdr with alpha is not compressible
|
|
|
|
if (hdr_compression == 2) {
|
|
//but user selected to compress hdr anyway, so force an alpha-less format.
|
|
if (image->get_format() == Image::FORMAT_RGBAF) {
|
|
for (int i = 0; i < slices.size(); i++) {
|
|
slices.write[i]->convert(Image::FORMAT_RGBF);
|
|
}
|
|
|
|
} else if (image->get_format() == Image::FORMAT_RGBAH) {
|
|
for (int i = 0; i < slices.size(); i++) {
|
|
slices.write[i]->convert(Image::FORMAT_RGBH);
|
|
}
|
|
}
|
|
} else {
|
|
can_compress_hdr = false;
|
|
}
|
|
}
|
|
|
|
if (can_compress_hdr) {
|
|
if (!can_bptc) {
|
|
//default to rgbe
|
|
if (image->get_format() != Image::FORMAT_RGBE9995) {
|
|
for (int i = 0; i < slices.size(); i++) {
|
|
slices.write[i]->convert(Image::FORMAT_RGBE9995);
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
can_bptc = false;
|
|
}
|
|
}
|
|
|
|
if (is_ldr && can_bptc) {
|
|
if (bptc_ldr == 0 || (bptc_ldr == 1 && !(used_channels == Image::USED_CHANNELS_LA || used_channels == Image::USED_CHANNELS_RGBA))) {
|
|
can_bptc = false;
|
|
}
|
|
}
|
|
|
|
if (can_bptc || can_s3tc) {
|
|
_save_tex(slices, p_save_path + ".s3tc." + extension, compress_mode, lossy, can_bptc ? Image::COMPRESS_BPTC : Image::COMPRESS_S3TC, csource, used_channels, mipmaps, false);
|
|
r_platform_variants->push_back("s3tc");
|
|
formats_imported.push_back("s3tc");
|
|
ok_on_pc = true;
|
|
}
|
|
|
|
if (ProjectSettings::get_singleton()->get("rendering/vram_compression/import_etc2")) {
|
|
_save_tex(slices, p_save_path + ".etc2." + extension, compress_mode, lossy, Image::COMPRESS_ETC2, csource, used_channels, mipmaps, true);
|
|
r_platform_variants->push_back("etc2");
|
|
formats_imported.push_back("etc2");
|
|
}
|
|
|
|
if (ProjectSettings::get_singleton()->get("rendering/vram_compression/import_pvrtc")) {
|
|
_save_tex(slices, p_save_path + ".etc2." + extension, compress_mode, lossy, Image::COMPRESS_ETC2, csource, used_channels, mipmaps, true);
|
|
r_platform_variants->push_back("pvrtc");
|
|
formats_imported.push_back("pvrtc");
|
|
}
|
|
|
|
if (!ok_on_pc) {
|
|
EditorNode::add_io_error("Warning, no suitable PC VRAM compression enabled in Project Settings. This texture will not display correctly on PC.");
|
|
}
|
|
} else {
|
|
//import normally
|
|
_save_tex(slices, p_save_path + "." + extension, compress_mode, lossy, Image::COMPRESS_S3TC /* IGNORED */, csource, used_channels, mipmaps, false);
|
|
}
|
|
|
|
if (r_metadata) {
|
|
Dictionary metadata;
|
|
metadata["vram_texture"] = compress_mode == COMPRESS_VRAM_COMPRESSED;
|
|
if (formats_imported.size()) {
|
|
metadata["imported_formats"] = formats_imported;
|
|
}
|
|
*r_metadata = metadata;
|
|
}
|
|
|
|
return OK;
|
|
}
|
|
|
|
const char *ResourceImporterLayeredTexture::compression_formats[] = {
|
|
"bptc",
|
|
"s3tc",
|
|
"etc",
|
|
"etc2",
|
|
"pvrtc",
|
|
nullptr
|
|
};
|
|
String ResourceImporterLayeredTexture::get_import_settings_string() const {
|
|
String s;
|
|
|
|
int index = 0;
|
|
while (compression_formats[index]) {
|
|
String setting_path = "rendering/vram_compression/import_" + String(compression_formats[index]);
|
|
bool test = ProjectSettings::get_singleton()->get(setting_path);
|
|
if (test) {
|
|
s += String(compression_formats[index]);
|
|
}
|
|
index++;
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
bool ResourceImporterLayeredTexture::are_import_settings_valid(const String &p_path) const {
|
|
//will become invalid if formats are missing to import
|
|
Dictionary metadata = ResourceFormatImporter::get_singleton()->get_resource_metadata(p_path);
|
|
|
|
if (!metadata.has("vram_texture")) {
|
|
return false;
|
|
}
|
|
|
|
bool vram = metadata["vram_texture"];
|
|
if (!vram) {
|
|
return true; //do not care about non vram
|
|
}
|
|
|
|
Vector<String> formats_imported;
|
|
if (metadata.has("imported_formats")) {
|
|
formats_imported = metadata["imported_formats"];
|
|
}
|
|
|
|
int index = 0;
|
|
bool valid = true;
|
|
while (compression_formats[index]) {
|
|
String setting_path = "rendering/vram_compression/import_" + String(compression_formats[index]);
|
|
bool test = ProjectSettings::get_singleton()->get(setting_path);
|
|
if (test) {
|
|
if (formats_imported.find(compression_formats[index]) == -1) {
|
|
valid = false;
|
|
break;
|
|
}
|
|
}
|
|
index++;
|
|
}
|
|
|
|
return valid;
|
|
}
|
|
|
|
ResourceImporterLayeredTexture *ResourceImporterLayeredTexture::singleton = nullptr;
|
|
|
|
ResourceImporterLayeredTexture::ResourceImporterLayeredTexture() {
|
|
singleton = this;
|
|
mode = MODE_CUBEMAP;
|
|
}
|
|
|
|
ResourceImporterLayeredTexture::~ResourceImporterLayeredTexture() {
|
|
}
|