From c4112ecddcf152ffe815257e82de8914a597bfff Mon Sep 17 00:00:00 2001
From: Tom Gowan <s3549186@student.rmit.edu.au>
Date: Tue, 30 Apr 2019 09:45:38 +1000
Subject: [PATCH] fixes #14

---
 src/lib.rs   | 2 ++
 src/watch.rs | 8 ++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index 16909fc..2dc6863 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -20,6 +20,7 @@ pub struct CompiledShaders {
     pub fragment: Vec<u32>,
 }
 
+/// Loads and compiles the vertex and fragment GLSL shaders from files
 pub fn load<T>(vertex: T, fragment: T) -> Result<CompiledShaders, Error>
 where
     T: AsRef<Path>,
@@ -29,6 +30,7 @@ where
     Ok(CompiledShaders{ vertex, fragment })
 }
 
+/// Parses the shaders and gives an entry point
 pub fn parse(code: &CompiledShaders) -> Result<Entry, Error> {
     reflection::create_entry(code)
 }
diff --git a/src/watch.rs b/src/watch.rs
index 9d52c0d..ef92ebf 100644
--- a/src/watch.rs
+++ b/src/watch.rs
@@ -25,13 +25,16 @@ pub struct Message {
 }
 
 impl Watch {
-    pub fn create<T>(vertex: T, fragment: T) -> Result<Self, Error>
+    /// Paths to the vertex and fragment shaders.
+    /// Frequency is how often the watcher will check the directory.
+    pub fn create<T>(vertex: T, fragment: T, frequency: Duration) -> Result<Self, Error>
     where
         T: AsRef<Path>,
     {
         let (handler, rx) = create_watch(
             vertex.as_ref().to_path_buf(),
             fragment.as_ref().to_path_buf(),
+            frequency,
         )?;
         Ok(Watch {
             _handler: handler,
@@ -82,11 +85,12 @@ impl Drop for Handler {
 fn create_watch(
     vert_path: PathBuf,
     frag_path: PathBuf,
+    frequency: Duration
 ) -> Result<(Handler, mpsc::Receiver<Result<Message, Error>>), Error> {
     let (notify_tx, notify_rx) = mpsc::channel();
     let (thread_tx, thread_rx) = mpsc::channel();
     let mut watcher: RecommendedWatcher =
-        Watcher::new(notify_tx, Duration::from_millis(50)).map_err(Error::FileWatch)?;
+        Watcher::new(notify_tx, frequency).map_err(Error::FileWatch)?;
 
     let mut vp = vert_path.clone();
     let mut fp = frag_path.clone();