Rename module

src/render/mod.rs

@@ -2,8 +2,8 @@ mod buffer_pool;
 
 mod piplines;
 mod shaders;
-mod stencil_pattern;
 mod texture;
+mod tile_mask_pattern;
 
 pub mod camera;
 pub mod options;

src/render/render_state.rs

@@ -9,7 +9,7 @@ use winit::window::Window;
 use crate::io::worker_loop::WorkerLoop;
 use crate::platform::{COLOR_TEXTURE_FORMAT, MIN_BUFFER_SIZE};
 use crate::render::buffer_pool::{BackingBufferDescriptor, BufferPool};
-use crate::render::stencil_pattern::TileMaskPattern;
+use crate::render::tile_mask_pattern::TileMaskPattern;
 use crate::render::{camera, shaders};
 use crate::tesselation::IndexDataType;
 use crate::util::FPSMeter;

src/render/tile_mask_pattern.rs

@@ -50,6 +50,9 @@ pub struct TileMaskPattern {
     pattern: Vec<MaskInstanceUniform>,
 }
 
+/// Implementation of a masking algorithm using a stencil buffer. The layout of the
+/// buffer can be reviewed [here](https://maxammann.org/mapr/docs/stencil-masking.html).
+///
 impl TileMaskPattern {
     pub fn new() -> Self {
         Self {