1/**************************************************************************/
2/* resource_importer_texture.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef RESOURCE_IMPORTER_TEXTURE_H
32#define RESOURCE_IMPORTER_TEXTURE_H
33
34#include "core/io/file_access.h"
35#include "core/io/image.h"
36#include "core/io/resource_importer.h"
37#include "scene/resources/texture.h"
38#include "servers/rendering_server.h"
39
40class CompressedTexture2D;
41
42class ResourceImporterTexture : public ResourceImporter {
43 GDCLASS(ResourceImporterTexture, ResourceImporter);
44
45public:
46 enum CompressMode {
47 COMPRESS_LOSSLESS,
48 COMPRESS_LOSSY,
49 COMPRESS_VRAM_COMPRESSED,
50 COMPRESS_VRAM_UNCOMPRESSED,
51 COMPRESS_BASIS_UNIVERSAL
52 };
53
54protected:
55 enum {
56 MAKE_3D_FLAG = 1,
57 MAKE_ROUGHNESS_FLAG = 2,
58 MAKE_NORMAL_FLAG = 4
59 };
60
61 Mutex mutex;
62 struct MakeInfo {
63 int flags = 0;
64 String normal_path_for_roughness;
65 RS::TextureDetectRoughnessChannel channel_for_roughness = RS::TEXTURE_DETECT_ROUGHNESS_R;
66 };
67
68 HashMap<StringName, MakeInfo> make_flags;
69
70 static void _texture_reimport_roughness(const Ref<CompressedTexture2D> &p_tex, const String &p_normal_path, RenderingServer::TextureDetectRoughnessChannel p_channel);
71 static void _texture_reimport_3d(const Ref<CompressedTexture2D> &p_tex);
72 static void _texture_reimport_normal(const Ref<CompressedTexture2D> &p_tex);
73
74 static ResourceImporterTexture *singleton;
75 static const char *compression_formats[];
76
77 void _save_ctex(const Ref<Image> &p_image, const String &p_to_path, CompressMode p_compress_mode, float p_lossy_quality, Image::CompressMode p_vram_compression, bool p_mipmaps, bool p_streamable, bool p_detect_3d, bool p_detect_srgb, bool p_detect_normal, bool p_force_normal, bool p_srgb_friendly, bool p_force_po2_for_compressed, uint32_t p_limit_mipmap, const Ref<Image> &p_normal, Image::RoughnessChannel p_roughness_channel);
78 void _save_editor_meta(const Dictionary &p_metadata, const String &p_to_path);
79 Dictionary _load_editor_meta(const String &p_to_path) const;
80
81public:
82 static void save_to_ctex_format(Ref<FileAccess> f, const Ref<Image> &p_image, CompressMode p_compress_mode, Image::UsedChannels p_channels, Image::CompressMode p_compress_format, float p_lossy_quality);
83
84 static ResourceImporterTexture *get_singleton() { return singleton; }
85 virtual String get_importer_name() const override;
86 virtual String get_visible_name() const override;
87 virtual void get_recognized_extensions(List<String> *p_extensions) const override;
88 virtual String get_save_extension() const override;
89 virtual String get_resource_type() const override;
90
91 enum Preset {
92 PRESET_DETECT,
93 PRESET_2D,
94 PRESET_3D,
95 };
96
97 virtual int get_preset_count() const override;
98 virtual String get_preset_name(int p_idx) const override;
99
100 virtual void get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset = 0) const override;
101 virtual bool get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const override;
102
103 virtual Error import(const String &p_source_file, const String &p_save_path, const HashMap<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files = nullptr, Variant *r_metadata = nullptr) override;
104
105 void update_imports();
106
107 virtual bool are_import_settings_valid(const String &p_path) const override;
108 virtual String get_import_settings_string() const override;
109
110 ResourceImporterTexture(bool p_singleton = false);
111 ~ResourceImporterTexture();
112};
113
114#endif // RESOURCE_IMPORTER_TEXTURE_H
115