2019-06-16 10:45:24 +08:00
|
|
|
/*************************************************************************/
|
|
|
|
/* shader_rd.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/*************************************************************************/
|
2021-01-02 03:13:46 +08:00
|
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
2019-06-16 10:45:24 +08: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. */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
|
|
#ifndef SHADER_RD_H
|
|
|
|
#define SHADER_RD_H
|
|
|
|
|
2020-02-26 18:28:13 +08:00
|
|
|
#include "core/os/mutex.h"
|
2021-04-14 04:01:43 +08:00
|
|
|
#include "core/string/string_builder.h"
|
2020-11-08 06:33:38 +08:00
|
|
|
#include "core/templates/hash_map.h"
|
2021-04-14 04:01:43 +08:00
|
|
|
#include "core/templates/local_vector.h"
|
2020-11-08 06:33:38 +08:00
|
|
|
#include "core/templates/map.h"
|
|
|
|
#include "core/templates/rid_owner.h"
|
|
|
|
#include "core/variant/variant.h"
|
2021-01-06 07:01:50 +08:00
|
|
|
#include "servers/rendering_server.h"
|
2020-02-18 21:57:11 +08:00
|
|
|
|
2019-06-16 10:45:24 +08:00
|
|
|
#include <stdio.h>
|
|
|
|
/**
|
|
|
|
@author Juan Linietsky <reduzio@gmail.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
class ShaderRD {
|
|
|
|
//versions
|
2019-07-11 04:44:55 +08:00
|
|
|
CharString general_defines;
|
2019-06-16 10:45:24 +08:00
|
|
|
Vector<CharString> variant_defines;
|
2020-12-08 05:27:38 +08:00
|
|
|
Vector<bool> variants_enabled;
|
2019-06-16 10:45:24 +08:00
|
|
|
|
|
|
|
struct Version {
|
|
|
|
CharString uniforms;
|
|
|
|
CharString vertex_globals;
|
2019-09-26 03:44:44 +08:00
|
|
|
CharString compute_globals;
|
2019-06-16 10:45:24 +08:00
|
|
|
CharString fragment_globals;
|
2021-04-14 04:01:43 +08:00
|
|
|
Map<StringName, CharString> code_sections;
|
2019-06-16 10:45:24 +08:00
|
|
|
Vector<CharString> custom_defines;
|
|
|
|
|
Implement Binary Shader Compilation
* Added an extra stage before compiling shader, which is generating a binary blob.
* On Vulkan, this allows caching the SPIRV reflection information, which is expensive to parse.
* On other (future) RenderingDevices, it allows caching converted binary data, such as DXIL or MSL.
This PR makes the shader cache include the reflection information, hence editor startup times are significantly improved.
I tested this well and it appears to work, and I added a lot of consistency checks, but because it includes writing and reading binary information, rare bugs may pop up, so be aware.
There was not much of a choice for storing the reflection information, given shaders can be a lot, take a lot of space and take time to parse.
2021-07-25 22:22:55 +08:00
|
|
|
Vector<uint8_t> *variant_data = nullptr;
|
2021-05-25 08:25:11 +08:00
|
|
|
RID *variants = nullptr; //same size as version defines
|
2019-06-16 10:45:24 +08:00
|
|
|
|
|
|
|
bool valid;
|
|
|
|
bool dirty;
|
|
|
|
bool initialize_needed;
|
|
|
|
};
|
|
|
|
|
2020-02-26 18:28:13 +08:00
|
|
|
Mutex variant_set_mutex;
|
2019-07-29 23:59:18 +08:00
|
|
|
|
|
|
|
void _compile_variant(uint32_t p_variant, Version *p_version);
|
|
|
|
|
2019-06-16 10:45:24 +08:00
|
|
|
void _clear_version(Version *p_version);
|
|
|
|
void _compile_version(Version *p_version);
|
|
|
|
|
|
|
|
RID_Owner<Version> version_owner;
|
|
|
|
|
2021-04-14 04:01:43 +08:00
|
|
|
struct StageTemplate {
|
|
|
|
struct Chunk {
|
|
|
|
enum Type {
|
|
|
|
TYPE_VERSION_DEFINES,
|
|
|
|
TYPE_MATERIAL_UNIFORMS,
|
|
|
|
TYPE_VERTEX_GLOBALS,
|
|
|
|
TYPE_FRAGMENT_GLOBALS,
|
|
|
|
TYPE_COMPUTE_GLOBALS,
|
|
|
|
TYPE_CODE,
|
|
|
|
TYPE_TEXT
|
|
|
|
};
|
|
|
|
|
|
|
|
Type type;
|
|
|
|
StringName code;
|
|
|
|
CharString text;
|
|
|
|
};
|
|
|
|
LocalVector<Chunk> chunks;
|
|
|
|
};
|
2019-06-16 10:45:24 +08:00
|
|
|
|
2019-09-26 03:44:44 +08:00
|
|
|
bool is_compute = false;
|
|
|
|
|
2021-05-25 08:25:11 +08:00
|
|
|
String name;
|
2019-06-16 10:45:24 +08:00
|
|
|
|
2021-02-03 03:51:36 +08:00
|
|
|
CharString base_compute_defines;
|
|
|
|
|
2021-05-25 08:25:11 +08:00
|
|
|
String base_sha256;
|
|
|
|
|
|
|
|
static String shader_cache_dir;
|
|
|
|
static bool shader_cache_cleanup_on_start;
|
|
|
|
static bool shader_cache_save_compressed;
|
|
|
|
static bool shader_cache_save_compressed_zstd;
|
|
|
|
static bool shader_cache_save_debug;
|
|
|
|
bool shader_cache_dir_valid = false;
|
|
|
|
|
2021-04-14 04:01:43 +08:00
|
|
|
enum StageType {
|
|
|
|
STAGE_TYPE_VERTEX,
|
|
|
|
STAGE_TYPE_FRAGMENT,
|
|
|
|
STAGE_TYPE_COMPUTE,
|
|
|
|
STAGE_TYPE_MAX,
|
|
|
|
};
|
|
|
|
|
|
|
|
StageTemplate stage_templates[STAGE_TYPE_MAX];
|
|
|
|
|
|
|
|
void _build_variant_code(StringBuilder &p_builder, uint32_t p_variant, const Version *p_version, const StageTemplate &p_template);
|
|
|
|
|
|
|
|
void _add_stage(const char *p_code, StageType p_stage_type);
|
|
|
|
|
2021-05-25 08:25:11 +08:00
|
|
|
String _version_get_sha1(Version *p_version) const;
|
|
|
|
bool _load_from_cache(Version *p_version);
|
|
|
|
void _save_to_cache(Version *p_version);
|
|
|
|
|
2019-06-16 10:45:24 +08:00
|
|
|
protected:
|
2021-02-03 03:51:36 +08:00
|
|
|
ShaderRD();
|
2019-09-26 03:44:44 +08:00
|
|
|
void setup(const char *p_vertex_code, const char *p_fragment_code, const char *p_compute_code, const char *p_name);
|
2019-06-16 10:45:24 +08:00
|
|
|
|
|
|
|
public:
|
|
|
|
RID version_create();
|
|
|
|
|
2021-04-14 04:01:43 +08:00
|
|
|
void version_set_code(RID p_version, const Map<String, String> &p_code, const String &p_uniforms, const String &p_vertex_globals, const String &p_fragment_globals, const Vector<String> &p_custom_defines);
|
|
|
|
void version_set_compute_code(RID p_version, const Map<String, String> &p_code, const String &p_uniforms, const String &p_compute_globals, const Vector<String> &p_custom_defines);
|
2019-06-16 10:45:24 +08:00
|
|
|
|
|
|
|
_FORCE_INLINE_ RID version_get_shader(RID p_version, int p_variant) {
|
|
|
|
ERR_FAIL_INDEX_V(p_variant, variant_defines.size(), RID());
|
2020-12-08 05:27:38 +08:00
|
|
|
ERR_FAIL_COND_V(!variants_enabled[p_variant], RID());
|
2019-06-16 10:45:24 +08:00
|
|
|
|
|
|
|
Version *version = version_owner.getornull(p_version);
|
2021-08-16 16:25:20 +08:00
|
|
|
ERR_FAIL_COND_V(!version, RID());
|
2019-06-16 10:45:24 +08:00
|
|
|
|
|
|
|
if (version->dirty) {
|
|
|
|
_compile_version(version);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!version->valid) {
|
|
|
|
return RID();
|
|
|
|
}
|
|
|
|
|
|
|
|
return version->variants[p_variant];
|
|
|
|
}
|
|
|
|
|
2019-07-27 21:23:24 +08:00
|
|
|
bool version_is_valid(RID p_version);
|
|
|
|
|
2019-06-16 10:45:24 +08:00
|
|
|
bool version_free(RID p_version);
|
|
|
|
|
2020-12-08 05:27:38 +08:00
|
|
|
void set_variant_enabled(int p_variant, bool p_enabled);
|
|
|
|
bool is_variant_enabled(int p_variant) const;
|
|
|
|
|
2021-05-25 08:25:11 +08:00
|
|
|
static void set_shader_cache_dir(const String &p_dir);
|
|
|
|
static void set_shader_cache_save_compressed(bool p_enable);
|
|
|
|
static void set_shader_cache_save_compressed_zstd(bool p_enable);
|
|
|
|
static void set_shader_cache_save_debug(bool p_enable);
|
|
|
|
|
2021-01-06 07:01:50 +08:00
|
|
|
RS::ShaderNativeSourceCode version_get_native_source_code(RID p_version);
|
|
|
|
|
2019-07-11 04:44:55 +08:00
|
|
|
void initialize(const Vector<String> &p_variant_defines, const String &p_general_defines = "");
|
2019-06-16 10:45:24 +08:00
|
|
|
virtual ~ShaderRD();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|