Support for terrain custom shader (#106)

spimort · May 28, 2024 · 093ee08 · 093ee08
1 parent b1ec61a
commit 093ee08
Show file tree

Hide file tree

Showing 6 changed files with 225 additions and 166 deletions.
diff --git a/README.md b/README.md
@@ -118,6 +118,7 @@ For example, if you add a new texture, add foliage, add an object, add a water d
 |Data Path|In order to work, TerraBrush needs to have somewhere to store some files. Make sure the option for "Data Path" is filled. If possible, the tool will fill in information by itself.|
 |Collision Only|This option is useful for running for example a Game Server. This will only create the collisions of the terrain (the packed scenes will also be created since they could have a collision shape)|
 |Visual Instance Layers|The godot layer on which the terrain will be displayed.|
+|Custom Shader|Allow you to use a custom shader for the terrain.|
 |Create Terrain|Create the terrain with the current settings (everything that has been done will be cleared).|
 |Update Terrain|Update the terrain with the current settings (it will keep everything that has been painted). This option is useful if you modify something that has a direct impact on the map (ex. Add a new texture, foliage, packed scenes, etc.).|
 |Remove Terrain|Remove the current terrain (everything that has been done will be cleared).|

diff --git a/addons/terrabrush/Resources/Shaders/heightmap_clipmap_shader.gdshader b/addons/terrabrush/Resources/Shaders/heightmap_clipmap_shader.gdshader
@@ -1,177 +1,22 @@
 shader_type spatial;
 render_mode cull_back,blend_mix,depth_draw_opaque,diffuse_burley,specular_schlick_ggx;
 
-#include "clipmap_shader_include.gdshaderinc"
-
-uniform sampler2DArray WaterTextures : hint_default_transparent, repeat_disable;
-uniform float WaterFactor = 1;
-uniform sampler2DArray Textures : source_color, filter_linear_mipmap;
-uniform sampler2DArray TexturesNearest : source_color, filter_nearest_mipmap;
-uniform sampler2DArray Splatmaps : repeat_disable;
-uniform int[100] TexturesDetail;
-uniform int NumberOfTextures;
-uniform sampler2DArray Normals : filter_linear_mipmap;
-uniform sampler2DArray NormalsNearest : filter_nearest_mipmap;
-uniform bool HasNormalTextures;
-uniform sampler2DArray RoughnessTextures : filter_linear_mipmap;
-uniform sampler2DArray RoughnessTexturesNearest : filter_nearest_mipmap;
-uniform bool HasRoughnessTextures;
-uniform sampler2DArray HeightTextures : filter_linear_mipmap;
-uniform sampler2DArray HeightTexturesNearest : filter_nearest_mipmap;
-uniform bool HasHeightTextures;
-uniform bool UseAntitile = true;
-uniform float BlendFactor;
-uniform bool NearestFilter = false;
+#include "res://addons/terrabrush/Resources/Shaders/heightmap_clipmap_shader_include.gdshaderinc"
 
 varying vec3 _worldVertex;
 
-vec2 rotate(vec2 v, float cosa, float sina) {
-	return vec2(cosa * v.x - sina * v.y, sina * v.x + cosa * v.y);
-}
-
-vec4 depth_blend2(vec4 a_value, float a_bump, vec4 b_value, float b_bump, float t) {
-	// https://www.gamasutra.com
-	// /blogs/AndreyMishkinis/20130716/196339/Advanced_Terrain_Texture_Splatting.php
-	float d = 0.1;
-	float ma = max(a_bump + (1.0 - t), b_bump + t) - d;
-	float ba = max(a_bump + (1.0 - t) - ma, 0.0);
-	float bb = max(b_bump + t - ma, 0.0);
-	return (a_value * ba + b_value * bb) / (ba + bb);
-}
-
-// Antitile from zylann's shader
-vec4 texture_array_antitile(sampler2DArray texLinear, sampler2DArray texNearest, vec3 uv) {
-	float frequency = 2.0;
-	float scale = 1.3;
-	float sharpness = 0.7;
-
-	// Rotate and scale UV
-	float rot = 3.14 * 0.6;
-	float cosa = cos(rot);
-	float sina = sin(rot);
-	vec3 uv2 = vec3(rotate(uv.xy, cosa, sina) * scale, uv.z);
-
-	vec4 col0 = vec4(0);
-	vec4 col1 = vec4(0);
-
-	if (NearestFilter) {
-		col0 = texture(texNearest, uv);
-		col1 = texture(texNearest, uv2);
-	} else {
-		col0 = texture(texLinear, uv);
-		col1 = texture(texLinear, uv2);
-	}
-
-	// Periodically alternate between the two versions using a warped checker pattern
-	float t = 1.1 + 0.5
-		* sin(uv2.x * frequency + sin(uv.x) * 2.0)
-		* cos(uv2.y * frequency + sin(uv.y) * 2.0);
-	t = smoothstep(sharpness, 2.0 - sharpness, t);
-
-	return depth_blend2(col0, col0.a, col1, col1.a, t);
-}
-
 void vertex() {
 	_worldVertex = vec3(0);
-	calculateVertex(MODEL_MATRIX, COLOR, VERTEX, _worldVertex);
-
-	vec3 zoneUV = calculateZoneUV(_worldVertex);
-
-	const vec3 off = vec3(1.0, 1.0, 0.0);
-	float hL = calculateVertexHeight(COLOR, VERTEX, _worldVertex, -off.xz);
-	float hR = calculateVertexHeight(COLOR, VERTEX, _worldVertex, off.xz);
-	float hB = calculateVertexHeight(COLOR, VERTEX, _worldVertex, -off.zy);
-	float hF = calculateVertexHeight(COLOR, VERTEX, _worldVertex, off.zy);
-	NORMAL = normalize(vec3(hL - hR, 2.0, hB - hF));
-
-	vec4 waterTexture = texture(WaterTextures, zoneUV);
-	VERTEX.y -= waterTexture.r * WaterFactor;
-}
-
-float getChannelValue(int currentChannel, vec4 currentSplatmap) {
-	return currentSplatmap[currentChannel];
-}
-
-float contrast(float factor, float v) {
-	return max(0.0, min(1.0, factor * (v - 0.5) + 0.5));
-}
-
-void fillVec4WithFilterTexture(vec3 textureUV, sampler2DArray linearTextures, sampler2DArray nearestTextures, out vec4 resultTexture) {
-	if (NearestFilter) {
-		resultTexture = UseAntitile ? texture_array_antitile(linearTextures, nearestTextures, textureUV) : texture(nearestTextures, textureUV);		
-	} else {
-		resultTexture = UseAntitile ? texture_array_antitile(linearTextures, nearestTextures, textureUV) : texture(linearTextures, textureUV);				
-	}
+	calculateHeightmapVertex(MODEL_MATRIX, COLOR, VERTEX, NORMAL, _worldVertex);	
 }
 
 void fragment() {
-	vec4 resultTexture = vec4(0.0);
-	vec4 resultNormal = vec4(0.0);
-	vec4 resultRoughness = vec4(0.0);	
-
-	vec3 zoneUV = calculateZoneUV(_worldVertex);		
-
-	int currentChannel = 0;
-	for (int i = 0; i < NumberOfTextures; i++) {
-		int textureDetail = TexturesDetail[i];
-		vec2 worldVertexUV = _worldVertex.xz * (float(textureDetail) * (1.0 / ZonesSize));
-		vec3 textureUV = vec3(worldVertexUV.x, worldVertexUV.y, float(i));		
-		vec3 splatmapUV = vec3(zoneUV.x, zoneUV.y, floor(float(i/4)) + (zoneUV.z * ceil(float(NumberOfTextures) / 4.0)));	
-
-		vec4 currentTexture = vec4(0);
-		vec4 currentNormal = vec4(0);
-		vec4 currentRoughness = vec4(0);
-		vec4 currentHeight = vec4(0);
-
-		fillVec4WithFilterTexture(textureUV, Textures, TexturesNearest, currentTexture);
-		if (HasNormalTextures) {
-			fillVec4WithFilterTexture(textureUV, Normals, NormalsNearest, currentNormal);		
-		}
-		if (HasRoughnessTextures) {
-			fillVec4WithFilterTexture(textureUV, RoughnessTextures, RoughnessTexturesNearest, currentRoughness);					
-		}
-		if (HasHeightTextures) {
-			fillVec4WithFilterTexture(textureUV, HeightTextures, HeightTexturesNearest, currentHeight);					
-		}		
-
-		vec4 currentSplatmap = texture(Splatmaps, splatmapUV);
-		float channelValue = getChannelValue(currentChannel, currentSplatmap);
-
-		float heightBlendedChannelValue = channelValue;
-		if (HasHeightTextures) {
-			heightBlendedChannelValue = min(contrast(BlendFactor, currentHeight.x) + channelValue, 1.0) * sqrt(channelValue);
-		}
-
-		resultTexture += currentTexture * heightBlendedChannelValue;
-		resultNormal += currentNormal * channelValue;
-		resultRoughness += currentRoughness * heightBlendedChannelValue;
-
-		if (currentChannel == 3) {
-			currentChannel = 0;
-		} else {
-			currentChannel++;
-		}
-	}
-
-	ALBEDO = resultTexture.xyz;
-
-	if (HasRoughnessTextures) {
-		ROUGHNESS = resultRoughness.x;		
-	}
-
-	if (HasNormalTextures) {
-		NORMAL_MAP = resultNormal.xyz;	
-	}
-
-	ALPHA = 1.0;
-	ALPHA_SCISSOR_THRESHOLD = 1.0;
-
-	if (zoneUV.z < 0.0) {
-		ALPHA = 0.0;
-	} else {
-		float hole = texture(HeightmapTextures, zoneUV).g;
-		if (hole > 0.0) {
-			ALPHA = 0.0;
-		}
-	}
+	calculateHeightmapFragment(
+		_worldVertex,
+		ALBEDO,
+		NORMAL_MAP,
+		ROUGHNESS,
+		ALPHA,
+		ALPHA_SCISSOR_THRESHOLD
+	);
 }
diff --git a/addons/terrabrush/Resources/Shaders/heightmap_clipmap_shader_include.gdshaderinc b/addons/terrabrush/Resources/Shaders/heightmap_clipmap_shader_include.gdshaderinc
@@ -0,0 +1,184 @@
+#include "clipmap_shader_include.gdshaderinc"
+
+uniform sampler2DArray WaterTextures : hint_default_transparent, repeat_disable;
+uniform float WaterFactor = 1;
+uniform sampler2DArray Textures : source_color, filter_linear_mipmap;
+uniform sampler2DArray TexturesNearest : source_color, filter_nearest_mipmap;
+uniform sampler2DArray Splatmaps : repeat_disable;
+uniform int[100] TexturesDetail;
+uniform int NumberOfTextures;
+uniform sampler2DArray Normals : filter_linear_mipmap;
+uniform sampler2DArray NormalsNearest : filter_nearest_mipmap;
+uniform bool HasNormalTextures;
+uniform sampler2DArray RoughnessTextures : filter_linear_mipmap;
+uniform sampler2DArray RoughnessTexturesNearest : filter_nearest_mipmap;
+uniform bool HasRoughnessTextures;
+uniform sampler2DArray HeightTextures : filter_linear_mipmap;
+uniform sampler2DArray HeightTexturesNearest : filter_nearest_mipmap;
+uniform bool HasHeightTextures;
+uniform bool UseAntitile = true;
+uniform float BlendFactor;
+uniform bool NearestFilter = false;
+
+vec2 rotate(vec2 v, float cosa, float sina) {
+	return vec2(cosa * v.x - sina * v.y, sina * v.x + cosa * v.y);
+}
+
+vec4 depth_blend2(vec4 a_value, float a_bump, vec4 b_value, float b_bump, float t) {
+	// https://www.gamasutra.com
+	// /blogs/AndreyMishkinis/20130716/196339/Advanced_Terrain_Texture_Splatting.php
+	float d = 0.1;
+	float ma = max(a_bump + (1.0 - t), b_bump + t) - d;
+	float ba = max(a_bump + (1.0 - t) - ma, 0.0);
+	float bb = max(b_bump + t - ma, 0.0);
+	return (a_value * ba + b_value * bb) / (ba + bb);
+}
+
+// Antitile from zylann's shader
+vec4 texture_array_antitile(sampler2DArray texLinear, sampler2DArray texNearest, vec3 uv) {
+	float frequency = 2.0;
+	float scale = 1.3;
+	float sharpness = 0.7;
+
+	// Rotate and scale UV
+	float rot = 3.14 * 0.6;
+	float cosa = cos(rot);
+	float sina = sin(rot);
+	vec3 uv2 = vec3(rotate(uv.xy, cosa, sina) * scale, uv.z);
+
+	vec4 col0 = vec4(0);
+	vec4 col1 = vec4(0);
+
+	if (NearestFilter) {
+		col0 = texture(texNearest, uv);
+		col1 = texture(texNearest, uv2);
+	} else {
+		col0 = texture(texLinear, uv);
+		col1 = texture(texLinear, uv2);
+	}
+
+	// Periodically alternate between the two versions using a warped checker pattern
+	float t = 1.1 + 0.5
+		* sin(uv2.x * frequency + sin(uv.x) * 2.0)
+		* cos(uv2.y * frequency + sin(uv.y) * 2.0);
+	t = smoothstep(sharpness, 2.0 - sharpness, t);
+
+	return depth_blend2(col0, col0.a, col1, col1.a, t);
+}
+
+void calculateHeightmapVertex(
+	mat4 modelMatrix,
+	inout vec4 color,
+	inout vec3 vertex,
+	inout vec3 normal,
+	inout vec3 worldVertex
+) {
+	calculateVertex(modelMatrix, color, vertex, worldVertex);
+
+	vec3 zoneUV = calculateZoneUV(worldVertex);
+
+	const vec3 off = vec3(1.0, 1.0, 0.0);
+	float hL = calculateVertexHeight(color, vertex, worldVertex, -off.xz);
+	float hR = calculateVertexHeight(color, vertex, worldVertex, off.xz);
+	float hB = calculateVertexHeight(color, vertex, worldVertex, -off.zy);
+	float hF = calculateVertexHeight(color, vertex, worldVertex, off.zy);
+	normal = normalize(vec3(hL - hR, 2.0, hB - hF));
+
+	vec4 waterTexture = texture(WaterTextures, zoneUV);
+	vertex.y -= waterTexture.r * WaterFactor;
+}
+
+float getChannelValue(int currentChannel, vec4 currentSplatmap) {
+	return currentSplatmap[currentChannel];
+}
+
+float contrast(float factor, float v) {
+	return max(0.0, min(1.0, factor * (v - 0.5) + 0.5));
+}
+
+void fillVec4WithFilterTexture(vec3 textureUV, sampler2DArray linearTextures, sampler2DArray nearestTextures, out vec4 resultTexture) {
+	if (NearestFilter) {
+		resultTexture = UseAntitile ? texture_array_antitile(linearTextures, nearestTextures, textureUV) : texture(nearestTextures, textureUV);		
+	} else {
+		resultTexture = UseAntitile ? texture_array_antitile(linearTextures, nearestTextures, textureUV) : texture(linearTextures, textureUV);				
+	}
+}
+
+void calculateHeightmapFragment(
+	vec3 worldVertex,	
+	inout vec3 albedo,
+	inout vec3 normalMap,
+	inout float roughness,
+	inout float alpha,
+	inout float alphaScissorThreshold
+) {
+	vec4 resultTexture = vec4(0.0);
+	vec4 resultNormal = vec4(0.0);
+	vec4 resultRoughness = vec4(0.0);	
+
+	vec3 zoneUV = calculateZoneUV(worldVertex);		
+
+	int currentChannel = 0;
+	for (int i = 0; i < NumberOfTextures; i++) {
+		int textureDetail = TexturesDetail[i];
+		vec2 worldVertexUV = worldVertex.xz * (float(textureDetail) * (1.0 / ZonesSize));
+		vec3 textureUV = vec3(worldVertexUV.x, worldVertexUV.y, float(i));		
+		vec3 splatmapUV = vec3(zoneUV.x, zoneUV.y, floor(float(i/4)) + (zoneUV.z * ceil(float(NumberOfTextures) / 4.0)));	
+
+		vec4 currentTexture = vec4(0);
+		vec4 currentNormal = vec4(0);
+		vec4 currentRoughness = vec4(0);
+		vec4 currentHeight = vec4(0);
+
+		fillVec4WithFilterTexture(textureUV, Textures, TexturesNearest, currentTexture);
+		if (HasNormalTextures) {
+			fillVec4WithFilterTexture(textureUV, Normals, NormalsNearest, currentNormal);		
+		}
+		if (HasRoughnessTextures) {
+			fillVec4WithFilterTexture(textureUV, RoughnessTextures, RoughnessTexturesNearest, currentRoughness);					
+		}
+		if (HasHeightTextures) {
+			fillVec4WithFilterTexture(textureUV, HeightTextures, HeightTexturesNearest, currentHeight);					
+		}		
+
+		vec4 currentSplatmap = texture(Splatmaps, splatmapUV);
+		float channelValue = getChannelValue(currentChannel, currentSplatmap);
+
+		float heightBlendedChannelValue = channelValue;
+		if (HasHeightTextures) {
+			heightBlendedChannelValue = min(contrast(BlendFactor, currentHeight.x) + channelValue, 1.0) * sqrt(channelValue);
+		}
+
+		resultTexture += currentTexture * heightBlendedChannelValue;
+		resultNormal += currentNormal * channelValue;
+		resultRoughness += currentRoughness * heightBlendedChannelValue;
+
+		if (currentChannel == 3) {
+			currentChannel = 0;
+		} else {
+			currentChannel++;
+		}
+	}
+
+	albedo = resultTexture.xyz;
+
+	if (HasRoughnessTextures) {
+		roughness = resultRoughness.x;		
+	}
+
+	if (HasNormalTextures) {
+		normalMap = resultNormal.xyz;	
+	}
+
+	alpha = 1.0;
+	alphaScissorThreshold = 1.0;
+
+	if (zoneUV.z < 0.0) {
+		alpha = 0.0;
+	} else {
+		float hole = texture(HeightmapTextures, zoneUV).g;
+		if (hole > 0.0) {
+			alpha = 0.0;
+		}
+	}
+}