Document the BaseMaterial3D billboard mode not being suited for VR

See #41567.

(cherry picked from commit ecc47ce235)
This commit is contained in:
Hugo Locurcio 2020-08-28 14:23:22 +02:00 committed by Rémi Verschelde
parent 0b2913086f
commit 00e4be1926
No known key found for this signature in database
GPG Key ID: C3336907360768E1

View File

@ -252,6 +252,7 @@
</member>
<member name="params_billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode" default="0">
Controls how the object faces the camera. See [enum BillboardMode].
[b]Note:[/b] Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See [url=https://github.com/godotengine/godot/issues/41567]GitHub issue #41567[/url] for details.
</member>
<member name="params_blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="SpatialMaterial.BlendMode" default="0">
The material's blend mode.