Add docs for y_sort.

Co-authored-by: Rob Parrett <robparrett@gmail.com>
StarArawn · Mar 28, 2023 · 0f5da8d · 0f5da8d
1 parent 31358dd
commit 0f5da8d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/map/mod.rs b/src/map/mod.rs
@@ -30,6 +30,12 @@ pub struct TilemapRenderSettings {
     ///
     /// Smaller chunk sizes will benefit tilemaps which change frequently.
     pub render_chunk_size: UVec2,
+    /// If true, uses the chunk's `z` and `y` values when sorting during rendering.
+    ///
+    /// When using this option with layered tilemaps, `z` values for layers should be separated by
+    /// at least `1.0` units.
+    ///
+    /// `render_chunk_size`'s `z` value should be `1` when using this for 3d isometric tilemaps.
     pub y_sort: bool,
 }