Document the BaseMaterial3D billboard mode not being suited for VR

See #41567.
This commit is contained in:
Hugo Locurcio 2020-08-28 14:23:22 +02:00
parent a258180723
commit ecc47ce235
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C

View file

@ -122,6 +122,7 @@
</member> </member>
<member name="billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="BaseMaterial3D.BillboardMode" default="0"> <member name="billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="BaseMaterial3D.BillboardMode" default="0">
Controls how the object faces the camera. See [enum BillboardMode]. 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>
<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="BaseMaterial3D.BlendMode" default="0"> <member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="BaseMaterial3D.BlendMode" default="0">
The material's blend mode. The material's blend mode.