Add a little documentation

libodm/build.rs

@@ -1,8 +1,21 @@
 fn main() {
-
     // Compile the LeapMotion wrapper (and Leap itself)
-    cc::Build::new().file("cpp/wrapper.cc").flag("-Wno-deprecated").flag("-Wno-deprecated-copy").flag("-L dist").flag("-lLeap").flag("-lstdc++").compile("foo");
-    // pkg_config::Config::new().probe("Leap").unwrap();
+    cc::Build::new()
+        .file("cpp/wrapper.cc")
+
+        // Handle LeapMotion errors
+        .flag("-Wno-deprecated")
+        .flag("-Wno-deprecated-copy")
+
+        // Tell the compiler where leap is
+        .flag("-L dist")
+        .flag("-lLeap")
+
+        // Link with stdc++
+        .flag("-lstdc++")
+
+        // Compile into a proper library
+        .compile("leapwrapper");
 
     // Set up the linker to include Leap
     println!("cargo:rustc-link-search=native=libodm/dist");

libodm/cpp/wrapper.cc

@@ -1,8 +1,6 @@
 #include <iostream>
 #include "../dist/Leap.h"
 
-using namespace Leap;
-
 //---- Start Public Functions ----//
 extern "C" void beginEventLoop();
 extern "C" bool isControllerCreated();
@@ -17,8 +15,8 @@ extern "C" const unsigned char *getImageRight();
 //---- End Public Functions ----//
 
 //---- Start Globals ----//
-Controller *controller = nullptr;
-Frame *frame = nullptr;
+Leap::Controller *controller = nullptr;
+Leap::Frame *frame = nullptr;
 //---- End Globals ----//
 
 //---- Start Public Function Impls ----//
@@ -28,11 +26,11 @@ void beginEventLoop()
     if (controller == nullptr)
     {
         // Create a controller
-        controller = new Controller();
+        controller = new Leap::Controller();
 
         // Set device policy
-        controller->setPolicy(Controller::POLICY_IMAGES);
-        controller->setPolicy(Controller::POLICY_OPTIMIZE_HMD);
+        controller->setPolicy(Leap::Controller::POLICY_IMAGES);
+        controller->setPolicy(Leap::Controller::POLICY_OPTIMIZE_HMD);
 
     }
 }
@@ -47,10 +45,7 @@ void endEventLoop()
 
 void updateFrame()
 {
-    // free(frame);
-    // Frame f = controller->frame();
-    // frame = (Frame*) malloc(sizeof(f));
-    // memccpy(frame, f);
+    // This is currently unused, but may be needed for data caching in the future
 }
 
 bool isControllerCreated() { return controller != nullptr; }

libodm/src/image.rs

@@ -1,7 +1,15 @@
+//! A simple image representation system using raw data from C code
 
+/// A raw image representation
 pub struct Image<'a> {
+
+    /// Image width
     width: u32,
+
+    /// Image height
     height: u32,
+
+    /// Raw image data
     buffer: &'a [u8],
 }
 

libodm/src/leapmotion/ffi.rs

@@ -1,13 +1,34 @@
+//! FFI definitions for LeapMotion wrapper code
 
 extern {
+
+    /// Begin the device event loops, init the device, and push policy changes
     pub fn beginEventLoop();
+
+    /// Check if the controller object has been created
     pub fn isControllerCreated() -> bool;
+
+    /// End everything and clean up
     pub fn endEventLoop();
+
+    /// Poll for new data
     pub fn updateFrame();
+
+    /// Check if the device has a pair of camera images to work with
     pub fn imageExists() -> bool;
+
+    /// Get the camera image height
     pub fn getImageHeight() -> libc::c_int;
+
+    /// Get the camera image width
     pub fn getImageWidth()-> libc::c_int;
+
+    /// Get the number of bytes used to represent a single pixel (should always be 1)
     pub fn getImageBPP() -> libc::c_int;
+
+    /// Get a pointer to the left image pixel data
     pub fn getImageLeft() -> *const u8;
+
+    /// Get a pointer to the right image pixel data
     pub fn getImageRight()  -> *const u8;
 }

libodm/src/leapmotion/mod.rs

@@ -1,2 +1,4 @@
+//! LeapMotion-specific interface code
+
 pub(self) mod ffi;
 pub mod device; 

libodm/src/lib.rs

@@ -1,3 +1,5 @@
+//! This crate contains the driver code for OpenDepthMap
+
 #![feature(static_nobundle)]
 
 pub mod leapmotion;