2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* shader.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2022-01-03 21:27:34 +01:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef SHADER_H
|
|
|
|
#define SHADER_H
|
|
|
|
|
2020-11-07 23:33:38 +01:00
|
|
|
#include "core/io/resource.h"
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/io/resource_loader.h"
|
|
|
|
#include "core/io/resource_saver.h"
|
2014-12-21 15:42:44 +01:00
|
|
|
#include "scene/resources/texture.h"
|
2022-03-08 11:39:16 +01:00
|
|
|
#include "shader_include.h"
|
2016-10-03 21:33:42 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
class Shader : public Resource {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(Shader, Resource);
|
|
|
|
OBJ_SAVE_TYPE(Shader);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-06-07 03:06:58 +02:00
|
|
|
public:
|
|
|
|
enum Mode {
|
2016-10-07 16:31:18 +02:00
|
|
|
MODE_SPATIAL,
|
2015-06-07 03:06:58 +02:00
|
|
|
MODE_CANVAS_ITEM,
|
2017-01-02 02:16:52 +01:00
|
|
|
MODE_PARTICLES,
|
2019-09-15 11:58:38 +02:00
|
|
|
MODE_SKY,
|
2021-10-03 13:28:55 +02:00
|
|
|
MODE_FOG,
|
2015-06-07 03:06:58 +02:00
|
|
|
MODE_MAX
|
|
|
|
};
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2015-06-07 03:06:58 +02:00
|
|
|
private:
|
|
|
|
RID shader;
|
2021-02-09 18:24:36 +01:00
|
|
|
Mode mode = MODE_SPATIAL;
|
2022-03-08 11:39:16 +01:00
|
|
|
HashSet<Ref<ShaderInclude>> include_dependencies;
|
2022-06-29 11:31:18 +02:00
|
|
|
String code;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
// hack the name of performance
|
2020-03-27 19:21:27 +01:00
|
|
|
// shaders keep a list of ShaderMaterial -> RenderingServer name translations, to make
|
2017-03-24 21:45:31 +01:00
|
|
|
// conversion fast and save memory.
|
2021-02-09 18:24:36 +01:00
|
|
|
mutable bool params_cache_dirty = true;
|
2022-05-13 15:04:37 +02:00
|
|
|
mutable HashMap<StringName, StringName> params_cache; //map a shader param to a material param..
|
|
|
|
HashMap<StringName, HashMap<int, Ref<Texture2D>>> default_textures;
|
2015-01-03 20:52:37 +01:00
|
|
|
|
2022-03-08 11:39:16 +01:00
|
|
|
void _dependency_changed();
|
2018-07-14 23:15:42 +02:00
|
|
|
virtual void _update_shader() const; //used for visual shader
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2015-01-03 20:52:37 +01:00
|
|
|
//void set_mode(Mode p_mode);
|
2018-07-14 23:15:42 +02:00
|
|
|
virtual Mode get_mode() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-06-29 11:31:18 +02:00
|
|
|
virtual void set_path(const String &p_path, bool p_take_over = false) override;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_code(const String &p_code);
|
2016-10-03 21:33:42 +02:00
|
|
|
String get_code() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-04-03 19:09:09 +02:00
|
|
|
void get_shader_uniform_list(List<PropertyInfo> *p_params, bool p_get_groups = false) const;
|
2022-08-27 11:22:43 +02:00
|
|
|
bool has_parameter(const StringName &p_name) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-08-27 11:22:43 +02:00
|
|
|
void set_default_texture_parameter(const StringName &p_name, const Ref<Texture2D> &p_texture, int p_index = 0);
|
|
|
|
Ref<Texture2D> get_default_texture_parameter(const StringName &p_name, int p_index = 0) const;
|
|
|
|
void get_default_texture_parameter_list(List<StringName> *r_textures) const;
|
2014-12-21 15:42:44 +01:00
|
|
|
|
2018-09-15 03:54:59 +02:00
|
|
|
virtual bool is_text_shader() const;
|
|
|
|
|
2022-08-08 08:57:08 +02:00
|
|
|
// Finds the shader parameter name for the given property name, which should start with "shader_parameter/".
|
|
|
|
_FORCE_INLINE_ StringName remap_parameter(const StringName &p_property) const {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (params_cache_dirty) {
|
2022-04-03 19:09:09 +02:00
|
|
|
get_shader_uniform_list(nullptr);
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2015-01-11 15:43:31 +01:00
|
|
|
|
2022-08-08 08:57:08 +02:00
|
|
|
String n = p_property;
|
|
|
|
|
|
|
|
// Backwards compatibility with old shader parameter names.
|
|
|
|
// Note: The if statements are important to make sure we are only replacing text exactly at index 0.
|
|
|
|
if (n.find("param/") == 0) {
|
|
|
|
n = n.replace_first("param/", "shader_parameter/");
|
|
|
|
}
|
|
|
|
if (n.find("shader_param/") == 0) {
|
|
|
|
n = n.replace_first("shader_param/", "shader_parameter/");
|
|
|
|
}
|
|
|
|
if (n.find("shader_uniform/") == 0) {
|
|
|
|
n = n.replace_first("shader_uniform/", "shader_parameter/");
|
|
|
|
}
|
|
|
|
|
|
|
|
{
|
|
|
|
// Additional backwards compatibility for projects between #62972 and #64092 (about a month of v4.0 development).
|
|
|
|
// These projects did not have any prefix for shader uniforms due to a bug.
|
|
|
|
// This code should be removed during beta or rc of 4.0.
|
|
|
|
const HashMap<StringName, StringName>::Iterator E = params_cache.find(n);
|
|
|
|
if (E) {
|
|
|
|
return E->value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (n.begins_with("shader_parameter/")) {
|
|
|
|
n = n.replace_first("shader_parameter/", "");
|
|
|
|
const HashMap<StringName, StringName>::Iterator E = params_cache.find(n);
|
|
|
|
if (E) {
|
|
|
|
return E->value;
|
|
|
|
}
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2022-08-08 08:57:08 +02:00
|
|
|
|
2015-01-11 15:43:31 +01:00
|
|
|
return StringName();
|
|
|
|
}
|
|
|
|
|
2020-07-10 12:34:39 +02:00
|
|
|
virtual RID get_rid() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-04-07 04:36:37 +02:00
|
|
|
Shader();
|
2014-02-10 02:10:30 +01:00
|
|
|
~Shader();
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
VARIANT_ENUM_CAST(Shader::Mode);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-12-26 17:52:09 +01:00
|
|
|
class ResourceFormatLoaderShader : public ResourceFormatLoader {
|
|
|
|
public:
|
2022-05-03 01:43:50 +02:00
|
|
|
virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE);
|
2017-12-26 17:52:09 +01:00
|
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const;
|
|
|
|
virtual bool handles_type(const String &p_type) const;
|
|
|
|
virtual String get_resource_type(const String &p_path) const;
|
|
|
|
};
|
|
|
|
|
|
|
|
class ResourceFormatSaverShader : public ResourceFormatSaver {
|
|
|
|
public:
|
2022-06-03 01:33:42 +02:00
|
|
|
virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0);
|
2022-05-03 01:43:50 +02:00
|
|
|
virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
|
|
|
|
virtual bool recognize(const Ref<Resource> &p_resource) const;
|
2017-12-26 17:52:09 +01:00
|
|
|
};
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#endif // SHADER_H
|