Godot: Bug Fixing

in #utopian-io5 years ago



Here is an array of bug fixes/improvements that I have made to the Godot engine in the last two weeks.

Bug Fixes

1. Culling: PR -- Issue

This issue arose in our GLES2 (lower end) backend. When a user gave an object a negative scale, the object was rendered inside out.

The fix required doing two things. One was tracking whether the scale was negative or positive. Which is done here.

And the other was updating the culling code to accurately flip when needed. Which is done here.

A bonus is that now the culling state only changes when necessary. This should result in slightly improved rendering times especially on complex scenes.

2. Radiance Map PR -- Issue1, Issue2

The next bug came from the way that reflection maps were calculated from the environment map. For some reason, when using HDR environment maps, reflections on objects would look like fireworks were going off (see below).

It look a lot of searching and experimentation to realize that the issue was with the quality setting. The code for determining quality was accidentally using the mobile setting in place of the desktop setting. For many rendering features Godot defaults to a low-quality version for mobile unless you specify to force high-quality on mobile. In this case, unless you specified to force high-quality on mobile, you would get low-quality even on a desktop that had high-quality enabled.

With the improved quality I was able to reduce the default size of the reflection maps (increase rendering speed while decreasing memory usage), while maintaining improved visual quality.

3. Fog PR -- Issue

In the GLES2 backend the environmental fog was affecting materials that were set to be "unshaded" including in-editor gizmos. "Unshaded" specifies that environment effects (and light) should not affect the object.

The issue here turned out to be that a compile-time define using #ifdef ... #endif was misplaced and was accidentally including fog code when it should not have.

4. No Depth test + render priority PR -- Depth Issue, Priority Issue

This one is actually two bugs combined into one.

Bug 1 resulted in objects with a particular setting (no depth test) being drawn behind the background unless they were in front of another object.

The solution was to specify that objects drawn without depth testing be drawn after all other opaque objects are drawn (e.g. with the transparent objects). This way they would always be drawn over things like the sky (which is what you expect when you select "no depth test").

Bug 2 resulted from the sorting algorithm not correcting taking into account the user set priority of objects. Priority is used to specify the order in which transparent objects are drawn. The solution was just to sort by depth and priority instead of just by depth

New Features

PR: https://github.com/godotengine/godot/pull/29411
Related Issues: related bug, enhancement suggestion

The MultiMeshInstance2D takes advantage of hardware instancing to draw thousands of objects using one draw call. Instead of drawing each mesh one for every instance you can specify all instances in a large array and submit it to the GPU all at once. This significantly speeds up rendering by reducing the amount of CPU time spent on draw calls and reducing the amount of memory transfer between CPU and GPU.

The implementation required that I add a new node entirely that can be accessed when using the 2D renderer. The implementation is very similar to the way that the MultiMeshInstance works in 3D and the way MeshInstance2D works in 2D.

In order to get it to work I had to fix a couple related bug. One (linked to above), resulted when users compiled without 3D support but still used a MeshInstance2D. In order to fix this, I had to ensure that the Mesh class was included when compiling without 3D.

The second related bug was in the shader code. In the shader code there was a variable that did not get properly initialized under some compile conditions. It would have caused the shaders to crash when the program started.

attribute highp vec4 instance_custom_data;
        // if USE_INSTANCE_CUSTOM is false, then the following line would cause the shader to crash
    vec4 instance_custom = instance_custom_data;
// therefore, replace with the following as "instance_custom" still needs to be used
    vec4 instance_custom = instance_custom_data;
    vec4 instance_custom = vec4(0.0);

The last bug was caused by colors for MultiMeshes not initialized in GLES2 leading objects to be rendered completely black. This was fixed by properly initializing the instance colors using a call to glVertexAttrib

glVertexAttrib4f(INSTANCE_ATTRIB_BASE + 3, 1.0, 1.0, 1.0, 1.0);

GitHub Account


  • Great post with images, code samples and awesome explanation of coding choices.
  • I'm a big fan of Godot and game engines, don't hesitate to include more images (before and after?), animated gifs or even videos. This type of project lends itself to good visuals.
  • Great commit messages. The code could use inline comments, it would make it more contribution friendly.
  • Keep up the great work and please share this post on Godot's forums!

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.

Need help? Chat with us on Discord.


Thank you for your review, @helo! Keep up the good work!

Hey, @clayjohn!

Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Hi @clayjohn!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

Congratulations @clayjohn! You received a personal award!

Happy Steem Birthday! - You are on the Steem blockchain for 2 years!

You can view your badges on your Steem Board and compare to others on the Steem Ranking

Do not miss the last post from @steemitboard:

Downvote challenge - Add up to 3 funny badges to your board
Vote for @Steemitboard as a witness to get one more award and increased upvotes!

Coin Marketplace

STEEM 0.25
TRX 0.11
JST 0.033
BTC 63915.49
ETH 3094.05
USDT 1.00
SBD 3.82