godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.91k stars 3.2k forks source link

Standardize names for the rendering methods / renderers #10139

Open tetrapod00 opened 2 hours ago

tetrapod00 commented 2 hours ago

Your Godot version: 4.4 dev Issue description: This issue mostly affects the docs, but there may be a few in-engine error and description also affected. Note that this is not proposing changes to any engine code, only docs and potentially some user-facing engine strings.

The naming of the rendering methods / renderers is currently nonstandardized in two ways:

These two nonstandard terms are multiplicative. There are instances of "Forward+ renderer", "Forward+ rendering method", and "Forward Plus rendering backend".

Proposal: Standardize on the following:

"Renderer" is used over the alternatives because it is shorter. The names for the renderers are used over the alternatives because those are the names always visible in the editor in the upper-right corner.

URL to the documentation page (if already existing): Many places in the manual and class ref.

clayjohn commented 2 hours ago

Fully agree.

Also, rendering backend should be reserved for talking about Vulkan, D3D12, or Metal

Renderer and rendering method are interchangable. Renderer is the more friendly term, but wasn't a good fit for internal stuff. For docs, "renderer" should be preferred.

Calinou commented 2 hours ago

Also, rendering backend should be reserved for talking about Vulkan, D3D12, or Metal

The engine calls it "rendering driver" so I would stick to that instead, and avoid "backend" for this purpose entirely. However, "backend" is suitable in the expression "RenderingDevice backend", e.g. "Compatibility does not run on the RenderingDevice backend".

tetrapod00 commented 2 hours ago

Does this sound right: Renderers/rendering methods: Forward+, Mobile, Compatibility Rendering backends: RenderingDevice (does compatibility have an equivalent?) Rendering drivers: OpenGL, Vulkan, Metal, Direct3D 12 The Forward+ renderer runs on the RenderingDevice backend using the Vulkan rendering driver.

The Renderers page (which will likely eventually become a section, not a single page) should perhaps have a short paragraph with the differences between "renderer/rendering method", "rendering driver", and maybe "rendering backend".