godotengine / godot-website

The code for the official Godot Engine website. A static site built using Jekyll.
https://godotengine.org
MIT License
292 stars 148 forks source link

Add blog post about reverse z breaking changes #834

Closed clayjohn closed 5 months ago

clayjohn commented 5 months ago

Partially addresses: https://github.com/godotengine/godot/issues/90443

This post highlights the compatibility breakage from reversing the depth buffer. It also goes into detail about situations that will/won't break and how to fix breakages as they appear. By nature, this post cannot be comprehensive, but I think it should be enough for 99% of the common cases.

I changed the title right before pushing to be a bit more whimsical. I'd like to have a bit lighter tone in the title since the content is very dry and clinical. But please let me know if it is too much or if it sounds like we are not taking compatibility breakage seriously enough.

~TODO, still needs a cover image. I'll push with one soon~ Done. Ready for review

JohnVeness commented 5 months ago

Also, should the Z be capitalised, in things like "reverse Z buffer"?

Calinou commented 5 months ago

Also, should the Z be capitalised, in things like "reverse Z buffer"?

I'd say yes, as Z refers to the Z coordinate.

clayjohn commented 5 months ago

Thank you for taking a look! @JohnVeness I've applied all your suggestions including capitalizing the "Z" in "reverse Z"

clayjohn commented 5 months ago

Thanks John! Applied your new changes

fire commented 5 months ago

Please note the typo "reserve" -> "reverse".

clayjohn commented 5 months ago

Please note the typo "reserve" -> "reverse".

Fixed haha, thanks for the catch. Seems it was just in the PR title and nowhere else

clayjohn commented 5 months ago

Should be good to merge after applying suggestions.

Thank you! I applied most of your suggestions and then did a pass removing the rest of the double backticks and updating the date to next Monday

akien-mga commented 5 months ago

The cover image seems to be this:

image

Is that intended? It doesn't really convey much IMO.

We should also include the usual overlay generated by https://yurisizov.github.io/godot-website-cover-generator/ (it's hardcoded in the webp, not done at build or display time).

akien-mga commented 5 months ago

If we don't have fancy graphics to illustrate reverse Z, here's a couple options (with and without gradient+blur) just taken from the PR diff itself (PNG because GH doesn't seem to support WEBP):

progress-report-reverse-z

progress-report-reverse-z-1

Or assuming Clay's blurred screenshot was meant to get the overlay applied automatically, here's a version with it included:

progress-report-reverse-z-2

akien-mga commented 5 months ago

Updated to use Clay's cover image (screenshot of shader editor) with the overlay applied.

akien-mga commented 5 months ago

Thanks!

Calinou commented 5 months ago

(PNG because GH doesn't seem to support WEBP):

If you rename the file extension to .png, GitHub (and most other websites) will let you upload the file and it'll show up correctly in all browsers.