From cf3f404d312146cf46ae27fd8d220852eac27eb9 Mon Sep 17 00:00:00 2001
From: reduz <reduzio@gmail.com>
Date: Sun, 25 Jul 2021 11:22:55 -0300
Subject: 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.
---
 doc/classes/RDShaderBytecode.xml | 71 ----------------------------------------
 doc/classes/RDShaderFile.xml     |  6 ++--
 doc/classes/RDShaderSPIRV.xml    | 71 ++++++++++++++++++++++++++++++++++++++++
 doc/classes/RenderingDevice.xml  | 24 +++++++++++---
 4 files changed, 94 insertions(+), 78 deletions(-)
 delete mode 100644 doc/classes/RDShaderBytecode.xml
 create mode 100644 doc/classes/RDShaderSPIRV.xml

(limited to 'doc/classes')

diff --git a/doc/classes/RDShaderBytecode.xml b/doc/classes/RDShaderBytecode.xml
deleted file mode 100644
index 20bf9bdd72..0000000000
--- a/doc/classes/RDShaderBytecode.xml
+++ /dev/null
@@ -1,71 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="RDShaderBytecode" inherits="Resource" version="4.0">
-	<brief_description>
-	</brief_description>
-	<description>
-	</description>
-	<tutorials>
-	</tutorials>
-	<methods>
-		<method name="get_stage_bytecode" qualifiers="const">
-			<return type="PackedByteArray">
-			</return>
-			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="get_stage_compile_error" qualifiers="const">
-			<return type="String">
-			</return>
-			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="set_stage_bytecode">
-			<return type="void">
-			</return>
-			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
-			</argument>
-			<argument index="1" name="bytecode" type="PackedByteArray">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="set_stage_compile_error">
-			<return type="void">
-			</return>
-			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
-			</argument>
-			<argument index="1" name="compile_error" type="String">
-			</argument>
-			<description>
-			</description>
-		</method>
-	</methods>
-	<members>
-		<member name="bytecode_compute" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
-		</member>
-		<member name="bytecode_fragment" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
-		</member>
-		<member name="bytecode_tesselation_control" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
-		</member>
-		<member name="bytecode_tesselation_evaluation" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
-		</member>
-		<member name="bytecode_vertex" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
-		</member>
-		<member name="compile_error_compute" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
-		</member>
-		<member name="compile_error_fragment" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
-		</member>
-		<member name="compile_error_tesselation_control" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
-		</member>
-		<member name="compile_error_tesselation_evaluation" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
-		</member>
-		<member name="compile_error_vertex" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
-		</member>
-	</members>
-	<constants>
-	</constants>
-</class>
diff --git a/doc/classes/RDShaderFile.xml b/doc/classes/RDShaderFile.xml
index 346a97a1c0..dab2b9822f 100644
--- a/doc/classes/RDShaderFile.xml
+++ b/doc/classes/RDShaderFile.xml
@@ -7,8 +7,8 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="get_bytecode" qualifiers="const">
-			<return type="RDShaderBytecode">
+		<method name="get_spirv" qualifiers="const">
+			<return type="RDShaderSPIRV">
 			</return>
 			<argument index="0" name="version" type="StringName" default="&amp;&quot;&quot;">
 			</argument>
@@ -24,7 +24,7 @@
 		<method name="set_bytecode">
 			<return type="void">
 			</return>
-			<argument index="0" name="bytecode" type="RDShaderBytecode">
+			<argument index="0" name="bytecode" type="RDShaderSPIRV">
 			</argument>
 			<argument index="1" name="version" type="StringName" default="&amp;&quot;&quot;">
 			</argument>
diff --git a/doc/classes/RDShaderSPIRV.xml b/doc/classes/RDShaderSPIRV.xml
new file mode 100644
index 0000000000..c9aefe31dc
--- /dev/null
+++ b/doc/classes/RDShaderSPIRV.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="RDShaderSPIRV" inherits="Resource" version="4.0">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="get_stage_bytecode" qualifiers="const">
+			<return type="PackedByteArray">
+			</return>
+			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="get_stage_compile_error" qualifiers="const">
+			<return type="String">
+			</return>
+			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="set_stage_bytecode">
+			<return type="void">
+			</return>
+			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
+			</argument>
+			<argument index="1" name="bytecode" type="PackedByteArray">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="set_stage_compile_error">
+			<return type="void">
+			</return>
+			<argument index="0" name="stage" type="int" enum="RenderingDevice.ShaderStage">
+			</argument>
+			<argument index="1" name="compile_error" type="String">
+			</argument>
+			<description>
+			</description>
+		</method>
+	</methods>
+	<members>
+		<member name="bytecode_compute" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
+		</member>
+		<member name="bytecode_fragment" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
+		</member>
+		<member name="bytecode_tesselation_control" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
+		</member>
+		<member name="bytecode_tesselation_evaluation" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
+		</member>
+		<member name="bytecode_vertex" type="PackedByteArray" setter="set_stage_bytecode" getter="get_stage_bytecode" default="PackedByteArray()">
+		</member>
+		<member name="compile_error_compute" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
+		</member>
+		<member name="compile_error_fragment" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
+		</member>
+		<member name="compile_error_tesselation_control" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
+		</member>
+		<member name="compile_error_tesselation_evaluation" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
+		</member>
+		<member name="compile_error_vertex" type="String" setter="set_stage_compile_error" getter="get_stage_compile_error" default="&quot;&quot;">
+		</member>
+	</members>
+	<constants>
+	</constants>
+</class>
diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml
index 901a985961..c73c2ddfd7 100644
--- a/doc/classes/RenderingDevice.xml
+++ b/doc/classes/RenderingDevice.xml
@@ -635,8 +635,16 @@
 			<description>
 			</description>
 		</method>
-		<method name="shader_compile_from_source">
-			<return type="RDShaderBytecode">
+		<method name="shader_compile_binary_from_spirv">
+			<return type="PackedByteArray">
+			</return>
+			<argument index="0" name="spirv_data" type="RDShaderSPIRV">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="shader_compile_spirv_from_source">
+			<return type="RDShaderSPIRV">
 			</return>
 			<argument index="0" name="shader_source" type="RDShaderSource">
 			</argument>
@@ -645,10 +653,18 @@
 			<description>
 			</description>
 		</method>
-		<method name="shader_create">
+		<method name="shader_create_from_bytecode">
 			<return type="RID">
 			</return>
-			<argument index="0" name="shader_data" type="RDShaderBytecode">
+			<argument index="0" name="binary_data" type="PackedByteArray">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="shader_create_from_spirv">
+			<return type="PackedByteArray">
+			</return>
+			<argument index="0" name="spirv_data" type="RDShaderSPIRV">
 			</argument>
 			<description>
 			</description>
-- 
cgit v1.2.3