/**************************************************************************/ /* shader_text_editor.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. */ /**************************************************************************/ #pragma once #include "editor/script/script_editor_base.h" #include "servers/rendering/shader_warnings.h" class MaterialEditor; class Environment; class ShaderMaterial; class Timer; class TextureRect; class StyleBoxFlat; class Shader; class ShaderInclude; class TextShaderPreview : public VBoxContainer { GDCLASS(TextShaderPreview, VBoxContainer); static constexpr int BUTTON_SIZE = 32; private: PanelContainer *panel = nullptr; Ref panel_style; Control *surface_hover = nullptr; Button *goto_button = nullptr; Button *delete_button = nullptr; MarginContainer *surface_container = nullptr; MaterialEditor *surface = nullptr; Ref shader_material; Ref env; MarginContainer *error_container = nullptr; TextureRect *error_icon = nullptr; Label *error_label = nullptr; int line = -1; bool in_comment = false; bool hovered = false; static HashMap spatial_assignments; static HashMap canvas_assignments; static HashMap builtin_spatial_types; static HashMap builtin_canvas_types; String _get_enclosing_function(const PackedStringArray &p_lines, int p_line) const; bool _is_inside_loop(const PackedStringArray &p_lines, int p_line) const; bool _find_statement(const PackedStringArray &p_lines, int p_line, String &r_var_name, int &r_start, int &r_end) const; String _find_var_type(const PackedStringArray &p_lines, const String &p_var_name, int p_line, bool p_mode_3d); bool _match_uniforms(const Ref &p_source, const Ref &p_target) const; void _sync_shader_parameters(const Ref &p_source, Ref &p_target); void _reset_shader_parameters(Ref &p_target); void _show_error(const String &p_error); void _goto_pressed(); void _delete_pressed(); void _on_hover_enter(); void _on_hover_exit(); Ref _get_source_material() const; protected: static void _bind_methods(); void _notification(int p_what); public: void set_shader_code(const String &p_code, int p_line, bool p_in_comment); void show_shader_compile_error(); void recompile(const String &p_code); void sync_shader_parameters(); void update_panel_color(const Color &p_color); PanelContainer *get_panel_container() const; Control *get_hover_control() const; bool is_hovered() const { return hovered; } TextShaderPreview(); }; class TextShaderPreviewLineLayer : public Control { GDCLASS(TextShaderPreviewLineLayer, Control); private: Color line_color; HashMap *previews = nullptr; ScrollContainer *scroll_container = nullptr; CodeEdit *code_editor = nullptr; protected: void _notification(int p_what); public: void set_previews(HashMap &p_previews); void set_code_editor(CodeEdit *p_code_editor); void set_scroll_container(ScrollContainer *p_scroll_container); TextShaderPreviewLineLayer(); }; class ShaderTextEditor : public CodeEditorBase { GDCLASS(ShaderTextEditor, CodeEditorBase); static ScriptEditorBase *create_editor(const Ref &p_resource); HashMap previews; TextShaderPreviewLineLayer *preview_line_layer = nullptr; PanelContainer *preview_panel = nullptr; VBoxContainer *preview_box = nullptr; VBoxContainer *preview_vbox = nullptr; Timer *preview_timer = nullptr; ScrollContainer *preview_sbox = nullptr; Button *update_params_btn = nullptr; Button *remove_all_btn = nullptr; bool pending_update_shader_previews = false; Error last_compile_result = Error::OK; void _check_shader_mode(); virtual bool _edit_option(int p_option) override; void _update_warning_panel(); void _update_warnings(bool p_validate); bool dependencies_changed = true; Color marked_line_color = Color(1, 1, 1); struct WarningsComparator { _ALWAYS_INLINE_ bool operator()(const ShaderWarning &p_a, const ShaderWarning &p_b) const { return (p_a.get_line() < p_b.get_line()); } }; List warnings; String previous_name; bool block_shader_changed = false; void _shader_changed(); void _focus_preview_line(int p_line); void _toggle_shader_preview(int p_line); void _remove_shader_preview(int p_line); void _clear_previews(); void _redraw_preview_lines(); void _recompile_previews(); void _update_parameters(); TextShaderPreviewLineLayer *_get_preview_line_layer() const; TextShaderPreview *_get_preview(int p_line) const; protected: class EditMenusShTE : public EditMenusCEB { GDCLASS(EditMenusShTE, EditMenusCEB); protected: void _update_breakpoint_list() override; public: virtual bool handles(ScriptEditorBase *p_seb) override { return Object::cast_to(p_seb); } EditMenusShTE(ScriptEditor *p_se) : EditMenusCEB(p_se, "Shader Previews") {} }; void _notification(int p_what); virtual void _validate_script() override; virtual void _load_theme_settings() override; virtual void _code_complete_script(const String &p_code, List *r_options, bool &r_force) override; virtual void _breakpoint_toggled(int p_row) override; void _update_shader_previews(); public: virtual String get_doc_url_path() override { return "/tutorials/shaders/shader_reference/index.html"; } virtual bool show_members_overview() override { return false; } virtual void set_edited_resource(const Ref &p_res) override; virtual void goto_line_centered(int p_line, int p_column = 0) override; void set_code_block_changed(const String &p_code); virtual void apply_code() override; virtual EditMenusBase *create_edit_menu(ScriptEditor *p_se) override { return memnew(EditMenusShTE(p_se)); } static void register_editor(); ShaderTextEditor(); };