godotengine / godotengine/godot-docs

Potentially misleading documentation for Camera3D.get_camera_projection()

Open
#10,726 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
4.3

**Issue description:**
The documentation for `Camera3D.get_camera_projection()` states that the returned projection is the one "this camera uses to render to its associated viewport". This is not entirely accurate, though, since the returned projection does not include the depth correction applied in the Vulkan backend. This behavior might confuse some users when trying to use said projection, as the produced depth-values will be in [-1, 1] instead of the otherwise expected [1, 0] range.

I already added a comment on the documentation page noting this issue, but would propose to include a similar note into the documentation to make this more clear.

**URL to the documentation page:**

https://docs.godotengine.org/en/4.3/classes/class_camera3d.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.