Added a pass system to shaders (#544)

Author: adriengivry

Resources/Engine/Shaders/Atmosphere.ovfx

@@ -1,5 +1,6 @@
-#feature OUTLINE_PASS
-#feature PICKING_PASS
+#pass OUTLINE_PASS
+#pass PICKING_PASS
+
 #feature DISABLE_TRACKING
 
 #shader vertex

Resources/Engine/Shaders/Skysphere.ovfx

@@ -1,5 +1,5 @@
-#feature OUTLINE_PASS
-#feature PICKING_PASS
+#pass OUTLINE_PASS
+#pass PICKING_PASS
 
 #shader vertex
 #version 450 core

Resources/Engine/Shaders/Standard.ovfx

@@ -1,4 +1,5 @@
-#feature SHADOW_PASS
+#pass SHADOW_PASS
+
 #feature PARALLAX_MAPPING
 #feature ALPHA_CLIPPING
 #feature ALPHA_DITHERING

Resources/Engine/Shaders/Unlit.ovfx

@@ -1,4 +1,5 @@
-#feature SHADOW_PASS
+#pass SHADOW_PASS
+
 #feature ALPHA_CLIPPING
 
 #shader vertex

Sources/Overload/OvCore/src/OvCore/Rendering/ShadowRenderPass.cpp

@@ -112,7 +112,7 @@ void OvCore::Rendering::ShadowRenderPass::DrawShadows(
 
 							// If the material has shadow pass, use it, otherwise use the shadow fallback material
 							auto& targetMaterial =
-								material->SupportsFeature(shadowPassName) ?
+								material->HasPass(shadowPassName) ?
 								*material :
 								m_shadowMaterial;
 
@@ -133,7 +133,7 @@ void OvCore::Rendering::ShadowRenderPass::DrawShadows(
 							drawable.stateMask.frontfaceCulling = false;
 							drawable.stateMask.backfaceCulling = false;
 
-							drawable.featureSetOverride = targetMaterial.GetFeatures() + shadowPassName;
+							drawable.pass = shadowPassName;
 
 							drawable.AddDescriptor<EngineDrawableDescriptor>({
 								modelMatrix,

Sources/Overload/OvCore/src/OvCore/Resources/Material.cpp

@@ -38,7 +38,7 @@ void OvCore::Resources::Material::OnSerialize(tinyxml2::XMLDocument& p_doc, tiny
 	tinyxml2::XMLNode* uniformsNode = p_doc.NewElement("uniforms");
 	p_node->InsertEndChild(uniformsNode);
 
-	const auto program = GetProgram();
+	const auto program = GetVariant();
 
 	// If the material has no valid program for the current feature set, we skip serialization of properties.
 	if (!program)

Sources/Overload/OvEditor/src/OvEditor/Panels/MaterialEditor.cpp

@@ -4,8 +4,6 @@
 * @licence: MIT
 */
 
-
-
 #include <OvCore/Helpers/GUIDrawer.h>
 #include <OvCore/Resources/Loaders/MaterialLoader.h>
 
@@ -382,6 +380,11 @@ void OvEditor::Panels::MaterialEditor::GenerateMaterialPropertiesContent()
 
 	m_materialPropertiesColumns->RemoveAllWidgets(); // Ensure that the m_shaderSettingsColumns is empty
 
+	if (!m_target->HasShader())
+	{
+		return;
+	}
+
 	std::multimap<
 		int,
 		std::pair<
@@ -390,6 +393,8 @@ void OvEditor::Panels::MaterialEditor::GenerateMaterialPropertiesContent()
 		>
 	> sortedProperties;
 
+	std::unordered_set<std::string> usedProperties;
+
 	auto typeIndexVisitor = [&](auto& arg) -> uint32_t {
 		using T = std::decay_t<decltype(arg)>;
 
@@ -405,25 +410,36 @@ void OvEditor::Panels::MaterialEditor::GenerateMaterialPropertiesContent()
 
 	for (auto& [name, prop] : m_target->GetProperties())
 	{
-		if (auto program = m_target->GetProgram(); !program || !program->GetUniformInfo(name))
+		for (const auto& pass : m_target->GetShader()->GetPasses())
 		{
-			// This property isn't used in the shader program, so skip it
-			continue;
-		}
+			if (auto variant = m_target->GetVariant(pass); !variant || !variant->GetUniformInfo(name))
+			{
+				// This property isn't used in the shader program, so skip it
+				continue;
+			}
 
-		// Uniforms starting with '_' are internal (private), so not exposed
-		if (name.length() == 0 || name[0] == '_')
-		{
-			continue;
-		}
+			// Uniforms starting with '_' are internal (private), so not exposed
+			if (name.length() == 0 || name[0] == '_')
+			{
+				continue;
+			}
 
-		sortedProperties.emplace(
-			std::visit(typeIndexVisitor, prop.value),
-			std::pair<std::string, std::reference_wrapper<OvRendering::Data::MaterialPropertyType>>{
-				name,
-				std::ref(prop.value)
+			// Skip properties that already got added (e.g. if they are used in multiple passes)
+			if (usedProperties.contains(name))
+			{
+				continue;
 			}
-		);
+
+			usedProperties.insert(name);
+
+			sortedProperties.emplace(
+				std::visit(typeIndexVisitor, prop.value),
+				std::pair<std::string, std::reference_wrapper<OvRendering::Data::MaterialPropertyType>>{
+					name,
+					std::ref(prop.value)
+				}
+			);
+		}
 	}
 
 	for (auto& [index, propInfo] : sortedProperties)

Sources/Overload/OvEditor/src/OvEditor/Rendering/OutlineRenderFeature.cpp

@@ -156,7 +156,7 @@ void OvEditor::Rendering::OutlineRenderFeature::DrawModelToStencil(
 	{
 		auto getStencilMaterial = [&]() -> OvCore::Resources::Material& {
 			auto material = p_materials.has_value() ? p_materials->at(mesh->GetMaterialIndex()) : nullptr;
-			if (material && material->IsValid() && material->SupportsFeature(outlinePassName))
+			if (material && material->IsValid() && material->HasPass(outlinePassName))
 			{
 				return *material;
 			}
@@ -178,7 +178,7 @@ void OvEditor::Rendering::OutlineRenderFeature::DrawModelToStencil(
 		element.stateMask = stateMask;
 		element.stateMask.depthTest = false;
 		element.stateMask.colorWriting = false;
-		element.featureSetOverride = targetMaterial.GetFeatures() + outlinePassName;
+		element.pass = outlinePassName;
 
 		element.AddDescriptor(engineDrawableDescriptor);
 
@@ -200,7 +200,7 @@ void OvEditor::Rendering::OutlineRenderFeature::DrawModelOutline(
 	{
 		auto getStencilMaterial = [&]() -> OvCore::Resources::Material& {
 			auto material = p_materials.has_value() ? p_materials->at(mesh->GetMaterialIndex()) : nullptr;
-			if (material && material->IsValid() && material->SupportsFeature(outlinePassName))
+			if (material && material->IsValid() && material->HasPass(outlinePassName))
 			{
 				return *material;
 			}
@@ -227,7 +227,7 @@ void OvEditor::Rendering::OutlineRenderFeature::DrawModelOutline(
 		drawable.material = targetMaterial;
 		drawable.stateMask = stateMask;
 		drawable.stateMask.depthTest = false;
-		drawable.featureSetOverride = targetMaterial.GetFeatures() + outlinePassName;
+		drawable.pass = outlinePassName;
 
 		drawable.AddDescriptor(engineDrawableDescriptor);
 

Sources/Overload/OvEditor/src/OvEditor/Rendering/PickingRenderPass.cpp

@@ -172,7 +172,7 @@ void OvEditor::Rendering::PickingRenderPass::DrawPickableModels(
 
 						// If the material has picking pass, use it, otherwise use the picking fallback material
 						auto& targetMaterial =
-							(customMaterial && customMaterial->IsValid() && customMaterial->SupportsFeature(pickingPassName)) ?
+							(customMaterial && customMaterial->IsValid() && customMaterial->HasPass(pickingPassName)) ?
 							*customMaterial :
 							m_actorPickingFallbackMaterial;
 
@@ -190,7 +190,7 @@ void OvEditor::Rendering::PickingRenderPass::DrawPickableModels(
 						drawable.stateMask = stateMask;
 						drawable.stateMask.frontfaceCulling = false;
 						drawable.stateMask.backfaceCulling = false;
-						drawable.featureSetOverride = targetMaterial.GetFeatures() + pickingPassName;
+						drawable.pass = pickingPassName;
 
 						drawable.AddDescriptor<OvCore::Rendering::EngineDrawableDescriptor>({
 							modelMatrix

Sources/Overload/OvRendering/include/OvRendering/Data/Material.h

@@ -62,10 +62,12 @@ namespace OvRendering::Data
 		void SetShader(OvRendering::Resources::Shader* p_shader);
 
 		/**
-		* Returns the shader program (variant) given the current feature set
+		* Returns the variant (shader program) given a pass and the current feature set (or an override)
+		* @param p_pass
 		* @param p_override
 		*/
-		OvTools::Utils::OptRef<OvRendering::HAL::ShaderProgram> GetProgram(
+		OvTools::Utils::OptRef<OvRendering::HAL::ShaderProgram> GetVariant(
+			std::optional<const std::string_view> p_pass = std::nullopt,
 			OvTools::Utils::OptRef<const Data::FeatureSet> p_override = std::nullopt
 		) const;
 
@@ -77,10 +79,12 @@ namespace OvRendering::Data
 		/**
 		* Bind the material and send its uniform data to the GPU
 		* @param p_emptyTexture (The texture to use if a texture uniform is null)
+		* @param p_pass
 		* @param p_featureSetOverride
 		*/
 		void Bind(
 			HAL::Texture* p_emptyTexture = nullptr,
+			std::optional<const std::string_view> p_pass = std::nullopt,
 			OvTools::Utils::OptRef<const Data::FeatureSet> p_featureSetOverride = std::nullopt
 		);
 
@@ -305,6 +309,12 @@ namespace OvRendering::Data
 		*/
 		bool SupportsFeature(const std::string& p_feature) const;
 
+		/**
+		* Returns true if the material has a pass
+		* @param p_pass
+		*/
+		bool HasPass(const std::string& p_pass) const;
+
 		/**
 		* Returns true if the material supports orthopgraphic projection
 		*/