godotengine / godotengine/godot-docs

Godot Image::normal_map_to_xy Unclear Description

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

Description

**Your Godot version:**
Godot 4.3

**Issue description:**
The description for the `Image` class's `normal_map_to_xy` adds absolutely no clarity as to what it does:

> Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normal map. A normal map can add lots of detail to a 3D surface without increasing the polygon count.

Having read this description, I still have literally no clue what this does. Seems like it could be useful, but it describes no use cases; only that it's somehow related to normal maps. It appears the only way to find out what it actually does would be to test it, meaning the documentation has not done its job.

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_image.html#class-image-method-normal-map-to-xy

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.