Merge pull request #94547 from clayjohn/DOCS-shadow_mesh

Add note to `shadow_mesh` docs to warn about improper usage
This commit is contained in:
Rémi Verschelde 2024-07-20 16:07:43 +02:00
commit e3b852559f
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -206,7 +206,8 @@
Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices.
</member>
<member name="shadow_mesh" type="ArrayMesh" setter="set_shadow_mesh" getter="get_shadow_mesh">
An optional mesh which is used for rendering shadows and can be used for the depth prepass. Can be used to increase performance of shadow rendering by using a mesh that only contains vertex position data (without normals, UVs, colors, etc.).
An optional mesh which can be used for rendering shadows and the depth prepass. Can be used to increase performance by supplying a mesh with fused vertices and only vertex position data (without normals, UVs, colors, etc.).
[b]Note:[/b] This mesh must have exactly the same vertex positions as the source mesh (including the source mesh's LODs, if present). If vertex positions differ, then the mesh will not draw correctly.
</member>
</members>
</class>