Add demo showing the use of RenderingEffects to do post processing #942

BastiaanOlij · 2023-08-23T10:57:21Z

Adding a demo to show the use of RenderingEffects to create post processing.
Implements godotengine/godot#80214

This is still a pretty simple example, will work on making this more elaborate at some point.

BastiaanOlij · 2023-09-06T14:20:26Z

Next to the very simple grayscale example I've added a work in progress, and not working correctly yet, Stocastic SSR implementation.

Decided to already push this in as it's a much bigger example on how to create different type of passes, how to create additional buffers, how to obtain state around the rendering, and how to do a raster pass.

Ansraer · 2023-09-15T11:13:36Z

While trying the hooks PR yesterday, I noticed that you use float gray = max(max(color.r, color.b), color.g); in your grayscale shader. However, given that the human eye is far more sensitive when it comes to detecting green colors, the correct way to get luminance should be something along the lines of color.r * 0.2125 + color.g * 0.7154, color.b * 0.0721;

Which reminds me, I need to go through the built-in godot shaders. We use this strange max approximation way too often.

BastiaanOlij · 2023-09-23T11:03:01Z

@Ansraer , changed the grayscale logic :)

RedMser

I've used this demo as a reference point and found parts of it using an outdated API. Here's my findings.

Note that my comments are not exhaustive, so "apply changes" via the GitHub GUI won't find all occurrences.

RedMser · 2024-04-23T09:57:27Z

compute/post_effects/gray_scale/gray_scale.gd

+extends RenderingEffect
+class_name RenderingEffectGrayScale


The API renamed to CompositorEffect, should be changed in multiple files.

Indeed, I need to revisit this

RedMser · 2024-04-23T09:58:14Z

compute/post_effects/gray_scale/gray_scale.gd

+			# Barrier
+			rd.barrier(RenderingDevice.BARRIER_MASK_ALL_BARRIERS, RenderingDevice.BARRIER_MASK_COMPUTE)


Manual barriers are deprecated and should be removed, should be changed in multiple files.

RedMser · 2024-04-23T10:02:06Z

compute/post_effects/main.tscn

+tonemap_mode = 2
+ssr_depth_tolerance = 3.41
+glow_enabled = true
+rendering_effects = Array[RenderingEffect]([SubResource("RenderingEffect_rprpc"), SubResource("RenderingEffect_sm2nk"), SubResource("RenderingEffect_jcxua")])


Must use the new Compositor API.

RedMser · 2024-04-23T10:03:00Z

compute/post_effects/simple_ssr/apply_sssr.gd

+		if nearest_sampler.is_valid():
+			rd.free_rid(nearest_sampler)
+		if linear_sampler.is_valid():
+			rd.free_rid(linear_sampler)
+		if reflection_shader.is_valid():
+			rd.free_rid(reflection_shader)
+		if overlay_shader.is_valid():
+			rd.free_rid(overlay_shader)


Some RIDs are not being cleaned up here, such as the *_pipeline variables

As before, dependent RIDs are automatically freed.

RedMser · 2024-04-23T10:03:22Z

compute/post_effects/simple_ssr/create_depth_mips.gd

+		if shader.is_valid():
+			rd.free_rid(shader)


The pipeline RID is not being freed here.

RedMser · 2024-04-23T10:03:50Z

compute/post_effects/gray_scale/gray_scale.gd

+		if shader.is_valid():
+			rd.free_rid(shader)


The pipeline RID is not being freed here.

When you free a shader, all dependencies of the shader will be freed, including all pipelines related to that shader.

RedMser · 2024-04-23T10:10:56Z

compute/post_effects/simple_ssr/apply_sssr.gd

+				rd.compute_list_bind_uniform_set(compute_list, depth_set, 0)
+				rd.compute_list_bind_uniform_set(compute_list, normal_set, 1)
+				rd.compute_list_bind_uniform_set(compute_list, color_set, 2)
+				rd.compute_list_bind_uniform_set(compute_list, reflect_set, 3)


I'm not nearly as experienced with compute shaders as you are, but I'll still risk asking a potentially stupid question here:

Why create multiple uniform sets, with one binding each? Why not create a single uniform set with multiple bindings? The docs also only ever do it the way that's done here without further elaborating. But in my testing, both seem to work fine.

I've noticed that I can use the same set with different bindings as well, so I've just started looking at the following document:

https://developer.nvidia.com/vulkan-shader-resource-binding

One thing the article notes:

We recommend making use of the different set numbers, to avoid redundant bindings. Putting many bindings that have very different frequencies in the same DescriptorSet can be bad for overall performance. Imagine a DescriptorSet with several textures and uniform buffer binding of which only one changes, that’s potentially a lot of data being sent to the GPU that effectively doesn’t do anything.

☝️ I'm not entirely sure I understand comprehensively yet, but it seems to me that separating different uniforms into sets can help with optimizing GPU usage. That said, it's hard for me to understand what would be ideal for a typical game project in Godot.

Thanks for the article, it's hard to find resources on this topic! On that note, most post processing shaders will be run every single frame and always update all of their bound uniforms, so I'm not sure if there's any benefit or drawback to doing it one way over the other here.

There is no one size fits all answer here. As a general rule it is best to combine uniforms into a single set but there can be optimisations in splitting this out if certain uniforms remain unchanged over multiple frames while others change every frame.

Other than that its really personal preference, in this case I'm splitting them out to keep the code straight forward and easy to read.

AThousandShips · 2023-09-15T11:25:32Z

compute/post_effects/gray_scale/gray_scale.gd

+	effect_callback_type = RenderingEffect.EFFECT_CALLBACK_TYPE_POST_TRANSPARENT
+	RenderingServer.call_on_render_thread(_initialize_compute)
+
+func _notification(what):


Suggested change

func _notification(what):

func _notification(what):

AThousandShips · 2023-09-15T11:25:37Z

compute/post_effects/gray_scale/gray_scale.gd

+var shader : RID
+var pipeline : RID
+
+func _initialize_compute():


Suggested change

func _initialize_compute():

func _initialize_compute():

AThousandShips · 2023-09-15T11:25:45Z

compute/post_effects/gray_scale/gray_scale.gd

+	shader = rd.shader_create_from_spirv(shader_spirv)
+	pipeline = rd.compute_pipeline_create(shader)
+
+func _render_callback(p_effect_callback_type, p_render_data):


Suggested change

func _render_callback(p_effect_callback_type, p_render_data):

func _render_callback(effect_callback_type, render_data):

AThousandShips · 2023-09-15T11:25:59Z

compute/post_effects/main.gd

+var apply_sssr_effect : RenderingEffectApplySSSR
+var gray_scale_effect : RenderingEffectGrayScale
+
+# Called when the node enters the scene tree for the first time.


Suggested change

# Called when the node enters the scene tree for the first time.

# Called when the node enters the scene tree for the first time.

AThousandShips · 2023-09-15T11:26:02Z

compute/post_effects/main.gd

+var cam_x = 0.0
+var cam_y = 0.0
+
+func _input(event):


Suggested change

func _input(event):

func _input(event):

AThousandShips · 2023-09-15T11:27:27Z

compute/post_effects/gray_scale/gray_scale.gd

+				uniform.add_id(input_image)
+				var uniform_set = UniformSetCacheRD.get_cache(shader, 0, [ uniform ])
+
+				# Run our compute shader


Suggested change

# Run our compute shader

# Run our compute shader.

AThousandShips · 2023-09-15T11:27:35Z

compute/post_effects/gray_scale/gray_scale.gd

+			if size.x == 0 and size.y == 0:
+				return
+
+			# We can use a compute shader here 


Suggested change

# We can use a compute shader here

# We can use a compute shader here .

AThousandShips · 2023-09-15T11:27:38Z

compute/post_effects/gray_scale/gray_scale.gd

+			var x_groups = (size.x - 1) / 8 + 1
+			var y_groups = (size.y - 1) / 8 + 1
+
+			# Barrier


Suggested change

# Barrier

# Barrier.

AThousandShips · 2023-09-15T11:27:54Z

compute/post_effects/gray_scale/gray_scale.gd

+	if !rd:
+		return
+
+	# Create our shader


Suggested change

# Create our shader

# Create our shader.

AThousandShips · 2023-09-15T11:28:02Z

compute/post_effects/gray_scale/gray_scale.gd

+
+func _initialize_compute():
+	rd = RenderingServer.get_rendering_device()
+	if !rd:


Suggested change

if !rd:

if not rd:

Calinou · 2024-05-22T16:35:24Z

I've updated the demo for 4.3.dev6 by pushing an additional commit, which incorporates @AThousandShips' suggestions. The demo works out of the box now.

However, I get error spam when MSAA 3D is disabled in the project settings (despite the scene rendering correctly):

 Image (binding: 0, index 0) needs the TEXTURE_USAGE_STORAGE_BIT usage flag set in order to be used as uniform.
  servers/rendering/renderer_rd/uniform_set_cache_rd.h:130 - Condition "rid.is_null()" is true. Returning: rid
  servers/rendering/rendering_device.cpp:4092 - Parameter "uniform_set" is null.
  Uniforms were never supplied for set (0) at the time of drawing, which are required by the pipeline.
  Image (binding: 0, index 0) needs the TEXTURE_USAGE_STORAGE_BIT usage flag set in order to be used as uniform.
  servers/rendering/renderer_rd/uniform_set_cache_rd.h:130 - Condition "rid.is_null()" is true. Returning: rid
  servers/rendering/rendering_device.cpp:4092 - Parameter "uniform_set" is null.
  Uniforms were never supplied for set (0) at the time of drawing, which are required by the pipeline.

PS: Is there a way to prevent the reflection from showing up on the sky? I've tried decreasing Max Distance in the SSSR effect but I need to decrease it to a very low value to prevent this, which breaks the reflection on other objects.

BastiaanOlij · 2024-05-23T08:18:23Z

This has been replaced by #1058

BastiaanOlij added enhancement topic:shaders labels Aug 23, 2023

BastiaanOlij mentioned this pull request Aug 23, 2023

Implement hooks into renderer godotengine/godot#80214

Merged

BastiaanOlij force-pushed the add_rendering_effects branch 3 times, most recently from 3d8d84c to d6d0fd8 Compare September 6, 2023 14:17

Add demo showing the use of RenderingEffects to do post processing

87b88e9

BastiaanOlij force-pushed the add_rendering_effects branch from d6d0fd8 to 87b88e9 Compare September 23, 2023 11:02

scgm0 mentioned this pull request Mar 1, 2024

Can't add a CompositorEffect to a Compositor godotengine/godot#89030

Closed

RedMser reviewed Apr 23, 2024

View reviewed changes

AThousandShips reviewed May 22, 2024

View reviewed changes

Use static typing, enable anisotropic filtering on materials, tweak UI

adb296c

Calinou force-pushed the add_rendering_effects branch from db81367 to adb296c Compare May 22, 2024 16:44

BastiaanOlij mentioned this pull request May 23, 2024

Add Compositor Effects (Post-Processing) demo #1058

Merged

BastiaanOlij closed this May 23, 2024

AThousandShips added the archived label May 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add demo showing the use of RenderingEffects to do post processing #942

Add demo showing the use of RenderingEffects to do post processing #942

BastiaanOlij commented Aug 23, 2023 •

edited

Loading

BastiaanOlij commented Sep 6, 2023

Ansraer commented Sep 15, 2023

BastiaanOlij commented Sep 23, 2023

RedMser left a comment

RedMser Apr 23, 2024

BastiaanOlij May 22, 2024

RedMser Apr 23, 2024

RedMser Apr 23, 2024

RedMser Apr 23, 2024

BastiaanOlij May 22, 2024

RedMser Apr 23, 2024

RedMser Apr 23, 2024

BastiaanOlij May 22, 2024

RedMser Apr 23, 2024

danbolt May 2, 2024

RedMser May 2, 2024

BastiaanOlij May 22, 2024

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

AThousandShips Sep 15, 2023

Calinou commented May 22, 2024 •

edited

Loading

BastiaanOlij commented May 23, 2024

		# Barrier
		rd.barrier(RenderingDevice.BARRIER_MASK_ALL_BARRIERS, RenderingDevice.BARRIER_MASK_COMPUTE)

	func _render_callback(p_effect_callback_type, p_render_data):

	func _render_callback(effect_callback_type, render_data):

	# Called when the node enters the scene tree for the first time.

	# Called when the node enters the scene tree for the first time.

	# We can use a compute shader here
	# We can use a compute shader here .

		extends RenderingEffect
		class_name RenderingEffectGrayScale

Add demo showing the use of RenderingEffects to do post processing #942

Add demo showing the use of RenderingEffects to do post processing #942

Conversation

BastiaanOlij commented Aug 23, 2023 • edited Loading

BastiaanOlij commented Sep 6, 2023

Ansraer commented Sep 15, 2023

BastiaanOlij commented Sep 23, 2023

RedMser left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Calinou commented May 22, 2024 • edited Loading

BastiaanOlij commented May 23, 2024

BastiaanOlij commented Aug 23, 2023 •

edited

Loading

Calinou commented May 22, 2024 •

edited

Loading