godot-demo-projects/misc/compute_shader_heightmap
Hugo Locurcio bac1e69164
Use static typing in all demos (#1063)
This leads to code that is easier to understand and runs
faster thanks to GDScript's typed instructions.

The untyped declaration warning is now enabled on all projects
where type hints were added. All projects currently run without
any untyped declration warnings.

Dodge the Creeps and Squash the Creeps demos intentionally don't
use type hints to match the documentation, where type hints haven't
been adopted yet (given its beginner focus).
2024-06-01 12:12:18 +02:00
..
screenshots
README.md Remove old and unused project settings, update various demos for 4.2 (#1024) 2024-03-26 18:01:58 +01:00
compute_shader.glsl
compute_shader.glsl.import
icon.webp Add icons for several projects (#886) 2023-04-13 16:51:05 +02:00
icon.webp.import Add icons for several projects (#886) 2023-04-13 16:51:05 +02:00
main.gd Use static typing in all demos (#1063) 2024-06-01 12:12:18 +02:00
main.tscn Add icons for several projects (#886) 2023-04-13 16:51:05 +02:00
project.godot Use static typing in all demos (#1063) 2024-06-01 12:12:18 +02:00

README.md

Compute Shader Heightmap

This demo project gives an example of how to use compute shaders in Godot. A compute shader is a piece of code that runs on the GPU and is written in GLSL (as opposed to the Godot shader language).

A compute shader can be used to take advantage of the GPU's ability to perform massively parallel operations faster than a CPU. This demo can generate the heightmap of an island from a noise texture, both on the CPU and the GPU. You can try both options to compare the time it takes to generate the heightmap on the CPU and GPU respectively.

For smaller noise textures, the CPU will often be faster, but the larger the gains are by using the GPU. On a PC with a NVIDIA GeForce RTX 3060 and 11th-generation Intel Core i7 processor, the compute shader was tested to be faster for textures 1024×1024 and larger.

The dimensions of the image can be set on the exported Dimensions property on the main scene. By default, it's set to 2048, which creates a 2048×2048 heightmap.

Note

The shader code has been structured to be followed step-by-step by the user, and may not necessarily represent best practices. The CPU code is also less optimized than it could be. This is to reflect the GPU code as much as possible. Besides the use of the GPU, no multithreading is used.

Languages: GDScript, GLSL

Renderer: Mobile

Compute Shader Heightmap