godotengine / godotengine/godot-docs

Document mapping between godot types and godot shader language types

Open
#11,953 0 comments 0 reactions 0 assignees View on GitHub
area:manual enhancement topic:shaders
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
4.6

**Issue description:**

`ShaderMaterial` has two public methods `get_shader_parameter()` and `set_shader_parameter()` that each return or accept values of type `Variant`.

These function act as an interface between the general purpose Godot scripting languages and godot shader language. These two domains have different types and it is unclear which godot types map to which godot shader language types.

A table documenting these type mappings would help the docs stand alone. As it is I am left inferring type compatibility by reviewing the Editor UI e.g. these can be assigned to a `sampler2D` via the GUI, but are they all compatible with the getter/setter methods?

Image


**URL to the documentation page (if already existing):**

https://docs.godotengine.org/en/stable/classes/class_shadermaterial.html
https://docs.godotengine.org/en/stable/tutorials/shaders/index.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.