浏览代码

Merge pull request #94547 from clayjohn/DOCS-shadow_mesh

Add note to `shadow_mesh` docs to warn about improper usage
Rémi Verschelde 1 年之前
父节点
当前提交
e3b852559f
共有 1 个文件被更改,包括 2 次插入1 次删除
  1. 2 1
      doc/classes/ArrayMesh.xml

+ 2 - 1
doc/classes/ArrayMesh.xml

@@ -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>