godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9579dc6313
godot/editor/shader_globals_editor.cpp

486 lines
15 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* shader_globals_editor.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. */
/**************************************************************************/
Style: Add missing copyright headers
2020-05-10 10:53:46 +00:00
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
#include "shader_globals_editor.h"
Improve compilation speed (forward declarations/includes cleanup)
2022-02-12 01:46:22 +00:00
#include "core/config/project_settings.h"
#include "editor/editor_node.h"
Add per-scene UndoRedo
2022-03-25 17:06:46 +00:00
#include "editor/editor_undo_redo_manager.h"
Optimize include files to improve `shader_language.h` compilation speed
2022-01-10 18:46:41 +00:00
#include "servers/rendering/shader_language.h"
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
static const char *global_var_type_names[RS::GLOBAL_VAR_TYPE_MAX] = {
"bool",
"bvec2",
"bvec3",
"bvec4",
"int",
"ivec2",
"ivec3",
"ivec4",
"rect2i",
"uint",
"uvec2",
"uvec3",
"uvec4",
"float",
"vec2",
"vec3",
"vec4",
"color",
"rect2",
"mat2",
"mat3",
"mat4",
"transform_2d",
"transform",
"sampler2D",
"sampler2DArray",
"sampler3D",
"samplerCube",
};
class ShaderGlobalsEditorInterface : public Object {
GDCLASS(ShaderGlobalsEditorInterface, Object)
Fix setting a global shader variable in the project settings
2022-12-05 10:46:16 +00:00
void _set_var(const StringName &p_name, const Variant &p_value, const Variant &p_prev_value) {
Add EditorUndoRedoManager singleton
2022-12-23 22:53:16 +00:00
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Make various strings translatable
2021-07-19 19:10:05 +00:00
undo_redo->create_action(TTR("Set Shader Global Variable"));
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
undo_redo->add_do_method(RS::get_singleton(), "global_shader_parameter_set", p_name, p_value);
Fix setting a global shader variable in the project settings
2022-12-05 10:46:16 +00:00
undo_redo->add_undo_method(RS::get_singleton(), "global_shader_parameter_set", p_name, p_prev_value);
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
RS::GlobalShaderParameterType type = RS::get_singleton()->global_shader_parameter_get_type(p_name);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Dictionary gv;
gv["type"] = global_var_type_names[type];
if (type >= RS::GLOBAL_VAR_TYPE_SAMPLER2D) {
Remove `RES` and `REF` typedefs in favor of spelled out `Ref<>` These typedefs don't save much typing compared to the full `Ref<Resource>` and `Ref<RefCounted>`, yet they sometimes introduce confusion among new contributors.
2022-05-02 23:43:50 +00:00
Ref<Resource> res = p_value;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
if (res.is_valid()) {
gv["value"] = res->get_path();
} else {
gv["value"] = "";
}
} else {
gv["value"] = p_value;
}
String path = "shader_globals/" + String(p_name);
undo_redo->add_do_property(ProjectSettings::get_singleton(), path, gv);
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
undo_redo->add_undo_property(ProjectSettings::get_singleton(), path, GLOBAL_GET(path));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
undo_redo->add_do_method(this, "_var_changed");
undo_redo->add_undo_method(this, "_var_changed");
block_update = true;
Fix setting a global shader variable in the project settings
2022-12-05 10:46:16 +00:00
undo_redo->commit_action();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
block_update = false;
Fix setting a global shader variable in the project settings
2022-12-05 10:46:16 +00:00
}
void _var_changed() {
emit_signal(SNAME("var_changed"));
}
protected:
static void _bind_methods() {
ClassDB::bind_method("_var_changed", &ShaderGlobalsEditorInterface::_var_changed);
ADD_SIGNAL(MethodInfo("var_changed"));
}
bool _set(const StringName &p_name, const Variant &p_value) {
Variant existing = RS::get_singleton()->global_shader_parameter_get(p_name);
if (existing.get_type() == Variant::NIL) {
return false;
}
Update deferred calls to use Callables
2023-12-18 14:46:56 +00:00
callable_mp(this, &ShaderGlobalsEditorInterface::_set_var).call_deferred(p_name, p_value, existing);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
return true;
}
bool _get(const StringName &p_name, Variant &r_ret) const {
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
r_ret = RS::get_singleton()->global_shader_parameter_get(p_name);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
return r_ret.get_type() != Variant::NIL;
}
void _get_property_list(List<PropertyInfo> *p_list) const {
Vector<StringName> variables;
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
variables = RS::get_singleton()->global_shader_parameter_get_list();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
for (int i = 0; i < variables.size(); i++) {
PropertyInfo pinfo;
pinfo.name = variables[i];
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
switch (RS::get_singleton()->global_shader_parameter_get_type(variables[i])) {
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
case RS::GLOBAL_VAR_TYPE_BOOL: {
pinfo.type = Variant::BOOL;
} break;
case RS::GLOBAL_VAR_TYPE_BVEC2: {
pinfo.type = Variant::INT;
pinfo.hint = PROPERTY_HINT_FLAGS;
pinfo.hint_string = "x,y";
} break;
case RS::GLOBAL_VAR_TYPE_BVEC3: {
pinfo.type = Variant::INT;
pinfo.hint = PROPERTY_HINT_FLAGS;
pinfo.hint_string = "x,y,z";
} break;
case RS::GLOBAL_VAR_TYPE_BVEC4: {
pinfo.type = Variant::INT;
pinfo.hint = PROPERTY_HINT_FLAGS;
pinfo.hint_string = "x,y,z,w";
} break;
case RS::GLOBAL_VAR_TYPE_INT: {
pinfo.type = Variant::INT;
} break;
case RS::GLOBAL_VAR_TYPE_IVEC2: {
pinfo.type = Variant::VECTOR2I;
} break;
case RS::GLOBAL_VAR_TYPE_IVEC3: {
pinfo.type = Variant::VECTOR3I;
} break;
case RS::GLOBAL_VAR_TYPE_IVEC4: {
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
pinfo.type = Variant::VECTOR4I;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
} break;
case RS::GLOBAL_VAR_TYPE_RECT2I: {
pinfo.type = Variant::RECT2I;
} break;
case RS::GLOBAL_VAR_TYPE_UINT: {
pinfo.type = Variant::INT;
} break;
case RS::GLOBAL_VAR_TYPE_UVEC2: {
pinfo.type = Variant::VECTOR2I;
} break;
case RS::GLOBAL_VAR_TYPE_UVEC3: {
pinfo.type = Variant::VECTOR3I;
} break;
case RS::GLOBAL_VAR_TYPE_UVEC4: {
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
pinfo.type = Variant::VECTOR4I;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
} break;
case RS::GLOBAL_VAR_TYPE_FLOAT: {
pinfo.type = Variant::FLOAT;
} break;
case RS::GLOBAL_VAR_TYPE_VEC2: {
pinfo.type = Variant::VECTOR2;
} break;
case RS::GLOBAL_VAR_TYPE_VEC3: {
pinfo.type = Variant::VECTOR3;
} break;
case RS::GLOBAL_VAR_TYPE_VEC4: {
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
pinfo.type = Variant::VECTOR4;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
} break;
case RS::GLOBAL_VAR_TYPE_RECT2: {
pinfo.type = Variant::RECT2;
} break;
case RS::GLOBAL_VAR_TYPE_COLOR: {
pinfo.type = Variant::COLOR;
} break;
case RS::GLOBAL_VAR_TYPE_MAT2: {
Fix shader uniform storage conversions and crash
2023-03-15 06:40:06 +00:00
pinfo.type = Variant::PACKED_FLOAT32_ARRAY;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
} break;
case RS::GLOBAL_VAR_TYPE_MAT3: {
pinfo.type = Variant::BASIS;
} break;
case RS::GLOBAL_VAR_TYPE_TRANSFORM_2D: {
pinfo.type = Variant::TRANSFORM2D;
} break;
case RS::GLOBAL_VAR_TYPE_TRANSFORM: {
Rename Variant TRANSFORM to TRANSFORM3D Also _transform to _transform3d
2021-04-28 07:36:08 +00:00
pinfo.type = Variant::TRANSFORM3D;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
} break;
case RS::GLOBAL_VAR_TYPE_MAT4: {
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
pinfo.type = Variant::PROJECTION;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
} break;
case RS::GLOBAL_VAR_TYPE_SAMPLER2D: {
pinfo.type = Variant::OBJECT;
pinfo.hint = PROPERTY_HINT_RESOURCE_TYPE;
pinfo.hint_string = "Texture2D";
} break;
case RS::GLOBAL_VAR_TYPE_SAMPLER2DARRAY: {
pinfo.type = Variant::OBJECT;
pinfo.hint = PROPERTY_HINT_RESOURCE_TYPE;
pinfo.hint_string = "Texture2DArray";
} break;
case RS::GLOBAL_VAR_TYPE_SAMPLER3D: {
pinfo.type = Variant::OBJECT;
pinfo.hint = PROPERTY_HINT_RESOURCE_TYPE;
pinfo.hint_string = "Texture3D";
} break;
case RS::GLOBAL_VAR_TYPE_SAMPLERCUBE: {
pinfo.type = Variant::OBJECT;
pinfo.hint = PROPERTY_HINT_RESOURCE_TYPE;
pinfo.hint_string = "Cubemap";
} break;
default: {
} break;
}
p_list->push_back(pinfo);
}
}
public:
bool block_update = false;
ShaderGlobalsEditorInterface() {
}
};
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
static Variant create_var(RS::GlobalShaderParameterType p_type) {
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
switch (p_type) {
case RS::GLOBAL_VAR_TYPE_BOOL: {
return false;
}
case RS::GLOBAL_VAR_TYPE_BVEC2: {
return 0; //bits
}
case RS::GLOBAL_VAR_TYPE_BVEC3: {
return 0; //bits
}
case RS::GLOBAL_VAR_TYPE_BVEC4: {
return 0; //bits
}
case RS::GLOBAL_VAR_TYPE_INT: {
return 0; //bits
}
case RS::GLOBAL_VAR_TYPE_IVEC2: {
return Vector2i();
}
case RS::GLOBAL_VAR_TYPE_IVEC3: {
return Vector3i();
}
case RS::GLOBAL_VAR_TYPE_IVEC4: {
Fix shader uniform storage conversions and crash
2023-03-15 06:40:06 +00:00
return Vector4i();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
case RS::GLOBAL_VAR_TYPE_RECT2I: {
return Rect2i();
}
case RS::GLOBAL_VAR_TYPE_UINT: {
return 0;
}
case RS::GLOBAL_VAR_TYPE_UVEC2: {
return Vector2i();
}
case RS::GLOBAL_VAR_TYPE_UVEC3: {
return Vector3i();
}
case RS::GLOBAL_VAR_TYPE_UVEC4: {
Fix shader uniform storage conversions and crash
2023-03-15 06:40:06 +00:00
return Vector4i();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
case RS::GLOBAL_VAR_TYPE_FLOAT: {
return 0.0;
}
case RS::GLOBAL_VAR_TYPE_VEC2: {
return Vector2();
}
case RS::GLOBAL_VAR_TYPE_VEC3: {
return Vector3();
}
case RS::GLOBAL_VAR_TYPE_VEC4: {
Fix shader uniform storage conversions and crash
2023-03-15 06:40:06 +00:00
return Vector4();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
case RS::GLOBAL_VAR_TYPE_RECT2: {
return Rect2();
}
case RS::GLOBAL_VAR_TYPE_COLOR: {
return Color();
}
case RS::GLOBAL_VAR_TYPE_MAT2: {
Fix shader uniform storage conversions and crash
2023-03-15 06:40:06 +00:00
Vector<float> xform;
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
xform.resize(4);
xform.write[0] = 1;
xform.write[1] = 0;
xform.write[2] = 0;
xform.write[3] = 1;
return xform;
}
case RS::GLOBAL_VAR_TYPE_MAT3: {
return Basis();
}
case RS::GLOBAL_VAR_TYPE_TRANSFORM_2D: {
return Transform2D();
}
case RS::GLOBAL_VAR_TYPE_TRANSFORM: {
Rename Transform to Transform3D in core
2020-10-17 05:08:21 +00:00
return Transform3D();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
case RS::GLOBAL_VAR_TYPE_MAT4: {
Fix shader uniform storage conversions and crash
2023-03-15 06:40:06 +00:00
return Projection();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
case RS::GLOBAL_VAR_TYPE_SAMPLER2D: {
return "";
}
case RS::GLOBAL_VAR_TYPE_SAMPLER2DARRAY: {
return "";
}
case RS::GLOBAL_VAR_TYPE_SAMPLER3D: {
return "";
}
case RS::GLOBAL_VAR_TYPE_SAMPLERCUBE: {
return "";
}
default: {
return Variant();
}
}
}
Improve "Add" button consistency in Project Settings * Adds an icon to all the input-adjacent add/remove buttons * Adds a separator next to the action map "add" button * Changes the Shader Globals editor to be consistent with the others * Adds a clear button to the shader global name input
2024-01-11 20:13:23 +00:00
String ShaderGlobalsEditor::_check_new_variable_name(const String &p_variable_name) {
if (p_variable_name.is_empty()) {
return TTR("Name cannot be empty.");
}
if (!p_variable_name.is_valid_identifier()) {
return TTR("Name must be a valid identifier.");
}
return "";
}
void ShaderGlobalsEditor::_variable_name_text_changed(const String &p_variable_name) {
const String &warning = _check_new_variable_name(p_variable_name.strip_edges());
variable_add->set_tooltip_text(warning);
variable_add->set_disabled(!warning.is_empty());
}
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
void ShaderGlobalsEditor::_variable_added() {
String var = variable_name->get_text().strip_edges();
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
if (RenderingServer::get_singleton()->global_shader_parameter_get(var).get_type() != Variant::NIL) {
Improve "Add" button consistency in Project Settings * Adds an icon to all the input-adjacent add/remove buttons * Adds a separator next to the action map "add" button * Changes the Shader Globals editor to be consistent with the others * Adds a clear button to the shader global name input
2024-01-11 20:13:23 +00:00
EditorNode::get_singleton()->show_warning(vformat(TTR("Global shader parameter '%s' already exists."), var));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
return;
}
List<String> keywords;
ShaderLanguage::get_keyword_list(&keywords);
if (keywords.find(var) != nullptr || var == "script") {
EditorNode::get_singleton()->show_warning(vformat(TTR("Name '%s' is a reserved shader language keyword."), var));
return;
}
Add EditorUndoRedoManager singleton
2022-12-23 22:53:16 +00:00
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
Variant value = create_var(RS::GlobalShaderParameterType(variable_type->get_selected()));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
undo_redo->create_action(TTR("Add Shader Global Parameter"));
undo_redo->add_do_method(RS::get_singleton(), "global_shader_parameter_add", var, RS::GlobalShaderParameterType(variable_type->get_selected()), value);
undo_redo->add_undo_method(RS::get_singleton(), "global_shader_parameter_remove", var);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Dictionary gv;
gv["type"] = global_var_type_names[variable_type->get_selected()];
gv["value"] = value;
undo_redo->add_do_property(ProjectSettings::get_singleton(), "shader_globals/" + var, gv);
undo_redo->add_undo_property(ProjectSettings::get_singleton(), "shader_globals/" + var, Variant());
undo_redo->add_do_method(this, "_changed");
undo_redo->add_undo_method(this, "_changed");
undo_redo->commit_action();
}
void ShaderGlobalsEditor::_variable_deleted(const String &p_variable) {
Add EditorUndoRedoManager singleton
2022-12-23 22:53:16 +00:00
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
undo_redo->create_action(TTR("Add Shader Global Parameter"));
undo_redo->add_do_method(RS::get_singleton(), "global_shader_parameter_remove", p_variable);
undo_redo->add_undo_method(RS::get_singleton(), "global_shader_parameter_add", p_variable, RS::get_singleton()->global_shader_parameter_get_type(p_variable), RS::get_singleton()->global_shader_parameter_get(p_variable));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
undo_redo->add_do_property(ProjectSettings::get_singleton(), "shader_globals/" + p_variable, Variant());
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
undo_redo->add_undo_property(ProjectSettings::get_singleton(), "shader_globals/" + p_variable, GLOBAL_GET("shader_globals/" + p_variable));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
undo_redo->add_do_method(this, "_changed");
undo_redo->add_undo_method(this, "_changed");
undo_redo->commit_action();
}
void ShaderGlobalsEditor::_changed() {
Optimize StringName usage * Added a new macro SNAME() that constructs and caches a local stringname. * Subsequent usages use the cached version. * Since these use a global static variable, a second refcounter of static usages need to be kept for cleanup time. * Replaced all theme usages by this new macro. * Replace all signal emission usages by this new macro. * Replace all call_deferred usages by this new macro. This is part of ongoing work to optimize GUI and the editor.
2021-07-17 21:22:52 +00:00
emit_signal(SNAME("globals_changed"));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
if (!interface->block_update) {
Removed _change_notify -For inspector refresh, the inspector now detects if a property change by polling a few times per second and then does update the control if so. This process is very cheap. -For property list refresh, a new signal (property_list_changed) was added to Object. _change_notify() is replaced by notify_property_list_changed() -Changed all objects using the old method to the signal, or just deleted the calls to _change_notify(<property>) since they are unnecesary now.
2021-02-10 20:18:45 +00:00
interface->notify_property_list_changed();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
}
void ShaderGlobalsEditor::_bind_methods() {
ClassDB::bind_method("_changed", &ShaderGlobalsEditor::_changed);
ADD_SIGNAL(MethodInfo("globals_changed"));
}
void ShaderGlobalsEditor::_notification(int p_what) {
Convert _notification methods to switch - Chunk C
2022-02-16 14:17:55 +00:00
switch (p_what) {
case NOTIFICATION_VISIBILITY_CHANGED: {
if (is_visible_in_tree()) {
inspector->edit(interface);
}
} break;
Improve "Add" button consistency in Project Settings * Adds an icon to all the input-adjacent add/remove buttons * Adds a separator next to the action map "add" button * Changes the Shader Globals editor to be consistent with the others * Adds a clear button to the shader global name input
2024-01-11 20:13:23 +00:00
case NOTIFICATION_THEME_CHANGED: {
variable_add->set_icon(get_editor_theme_icon(SNAME("Add")));
} break;
Convert _notification methods to switch - Chunk C
2022-02-16 14:17:55 +00:00
case NOTIFICATION_PREDELETE: {
inspector->edit(nullptr);
} break;
Don't try to compare freed object to nullptr
2020-10-13 08:27:49 +00:00
}
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
ShaderGlobalsEditor::ShaderGlobalsEditor() {
Made hidden ProjectSettings groups more explicit
2022-06-08 15:52:19 +00:00
ProjectSettings::get_singleton()->add_hidden_prefix("shader_globals/");
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
HBoxContainer *add_menu_hb = memnew(HBoxContainer);
add_child(add_menu_hb);
add_menu_hb->add_child(memnew(Label(TTR("Name:"))));
variable_name = memnew(LineEdit);
variable_name->set_h_size_flags(SIZE_EXPAND_FILL);
Improve "Add" button consistency in Project Settings * Adds an icon to all the input-adjacent add/remove buttons * Adds a separator next to the action map "add" button * Changes the Shader Globals editor to be consistent with the others * Adds a clear button to the shader global name input
2024-01-11 20:13:23 +00:00
variable_name->set_clear_button_enabled(true);
variable_name->connect("text_changed", callable_mp(this, &ShaderGlobalsEditor::_variable_name_text_changed));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
add_menu_hb->add_child(variable_name);
add_menu_hb->add_child(memnew(Label(TTR("Type:"))));
variable_type = memnew(OptionButton);
variable_type->set_h_size_flags(SIZE_EXPAND_FILL);
add_menu_hb->add_child(variable_type);
for (int i = 0; i < RS::GLOBAL_VAR_TYPE_MAX; i++) {
variable_type->add_item(global_var_type_names[i]);
}
variable_add = memnew(Button(TTR("Add")));
Improve "Add" button consistency in Project Settings * Adds an icon to all the input-adjacent add/remove buttons * Adds a separator next to the action map "add" button * Changes the Shader Globals editor to be consistent with the others * Adds a clear button to the shader global name input
2024-01-11 20:13:23 +00:00
variable_add->set_disabled(true);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
add_menu_hb->add_child(variable_add);
variable_add->connect("pressed", callable_mp(this, &ShaderGlobalsEditor::_variable_added));
inspector = memnew(EditorInspector);
inspector->set_v_size_flags(SIZE_EXPAND_FILL);
add_child(inspector);
inspector->set_use_wide_editors(true);
Add property name style toggle to Inspector
2022-03-23 01:46:59 +00:00
inspector->set_property_name_style(EditorPropertyNameProcessor::STYLE_RAW);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
inspector->set_use_deletable_properties(true);
Remove Signal connect binds Remove the optional argument p_binds from `Object::connect` since it was deprecated by Callable.bind(). Changed all uses of it to Callable.bind()
2022-07-28 20:56:41 +00:00
inspector->connect("property_deleted", callable_mp(this, &ShaderGlobalsEditor::_variable_deleted), CONNECT_DEFERRED);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
interface = memnew(ShaderGlobalsEditorInterface);
Port remaining connections to callable_mp
2020-12-06 15:09:18 +00:00
interface->connect("var_changed", callable_mp(this, &ShaderGlobalsEditor::_changed));
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
Style: Enforce separation line between function definitions I couldn't find a tool that enforces it, so I went the manual route: ``` find -name "thirdparty" -prune \ -o -name "*.cpp" -o -name "*.h" -o -name "*.m" -o -name "*.mm" \ -o -name "*.glsl" > files perl -0777 -pi -e 's/\n}\n([^#])/\n}\n\n\1/g' $(cat files) misc/scripts/fix_style.sh -c ``` This adds a newline after all `}` on the first column, unless they are followed by `#` (typically `#endif`). This leads to having lots of places with two lines between function/class definitions, but clang-format then fixes it as we enforce max one line of separation. This doesn't fix potential occurrences of function definitions which are indented (e.g. for a helper class defined in a .cpp), but it's better than nothing. Also can't be made to run easily on CI/hooks so we'll have to be careful with new code. Part of #33027.
2020-05-14 12:29:06 +00:00
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
ShaderGlobalsEditor::~ShaderGlobalsEditor() {
memdelete(interface);
}
Reference in New Issue Copy Permalink