Skip to content

Commit

Permalink
Add info about buffer padding
Browse files Browse the repository at this point in the history
  • Loading branch information
Zylann committed May 26, 2024
1 parent 22e6dc9 commit 63b6009
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/classes/VoxelMesher.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
<param index="1" name="materials" type="Material[]" />
<param index="2" name="additional_data" type="Dictionary" default="{}" />
<description>
Builds a mesh from the provided voxels. Materials will be attached to each surface based on the provided array. The way materials are used can depend on the type of mesher.
Builds a mesh from the provided voxels. Materials will be attached to each surface based on the provided array. The way materials are used can depend on the type of mesher.
Meshers are initially meant to work on chunks, so voxels within an outer margin of the buffer will not be part of the result. They are considered "neighbors" and may eventually affect face culling. If you want to use a mesher to make a standalone voxel mesh, make sure it is padded by air. The size of that margin is determined by [method get_minimum_padding] and [method get_maximum_padding].
</description>
</method>
<method name="get_maximum_padding" qualifiers="const">
Expand Down

0 comments on commit 63b6009

Please sign in to comment.