Render Priority Documentation has example values reversed of how it actually behaves

[michaelharmonart]

Your Godot version:
4.4 Beta

Issue description:

In actuallity, setting a render priority of -1 will be rendered before all objects of priority 0. This gave me a headache when I first started messing with these values and they weren't behaving properly. (see: godotengine/godot#98344 )

URL to the documentation page:

https://docs.godotengine.org/en/latest/classes/class_material.html#class-material-property-render-priority

[Calinou]

I'm not sure if this is actually the case.

In both Forward+ and Compatibility, I can clearly see that materials with a higher render priority value are rendered in front of those with a lower render priority value (including 0). I don't think the value 0 has special treatment either.

Testing project: new_game_project.zip

[michaelharmonart]

weird... at least for me in compatibility I've had to use -1 as the render priority for objects/materials I need rendered first. Although I've only tested compatibility. Used renderdoc to check draw call order on both a quest 3 and my workstation. Same results.

I'll give your test project a look for sure

[michaelharmonart]

@Calinou I figured out the point of confusion. A lower render priority number is rendered first meaning it will not appear in front of objects with a higher render priority. (eg. The default label3d node settings make the text outline a -1 render priority so that the outline is drawn first, followed by the actual text)

So you're right: higher render priority = drawn in front
my confusion was that the docs say

Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with render_priority 1 will render before all objects with render_priority 0.

The first half is correct.

Higher priority objects will be sorted in front of lower priority objects

The second sentence is what tripped me up

In other words, all objects with render_priority 1 will render before all objects with render_priority 0.

(confusion here since I assumed "before" meant render order, not in-front)

[michaelharmonart]

fixed by godotengine/godot#105133
i believe