egg samples

Author: tjhorner

OVRSharp/Overlay.cs

@@ -238,7 +238,7 @@ public Overlay(string key, string name, bool dashboardOverlay = false)
             if (OpenVR.Overlay == null)
                 throw new NullReferenceException("OpenVR has not been initialized. Please initialize it by instantiating a new Application.");
 
-            var err = EVROverlayError.None;
+            EVROverlayError err;
 
             if (dashboardOverlay)
                 err = OpenVR.Overlay.CreateDashboardOverlay(key, name, ref overlayHandle, ref thumbnailHandle);

README.md

@@ -6,6 +6,73 @@ Right now, our main goal with this is to make working with the overlay API easie
 
 Later on, we plan on supporting basically the entirety of the OpenVR API, so you don't need to deal with pointers and stuff. Just write C# as you would expect.
 
+So you can do this:
+
+```csharp
+Application app;
+
+try {
+  app = new Application(Application.ApplicationType.Overlay);
+} catch(OpenVRSystemException e) {
+  // Errors are exceptions!
+}
+
+var overlay = new Overlay("cool_overlay", "Cool Overlay", true) {
+  WidthInMeters = 3.8f
+};
+
+overlay.SetTextureFromFile(@"C:\path\to\file.png");
+overlay.SetThumbnailTextureFromFile(@"C:\path\to\thumb.png");
+```
+
+Instead of this:
+
+```csharp
+var err = EVRInitError.None;
+var vrSystem = OpenVR.Init(ref err, EVRApplicationType.VRApplication_Overlay);
+
+if (err != EVRInitError.None)
+{
+  // whatever error handling
+}
+
+// Create a dashboard overlay
+var overlayErr = EVROverlayError.None;
+
+ulong overlayHandle;
+ulong thumbnailHandle;
+
+overlayErr = OpenVR.Overlay.CreateDashboardOverlay("cool_overlay", "Cool Overlay", ref overlayHandle, ref thumbnailHandle);
+
+if (overlayErr != EVROverlayError.None)
+{
+  // whatever error handling
+}
+
+overlayErr = OpenVR.Overlay.SetOverlayWidthInMeters(overlayHandle, 3.8f);
+
+if (overlayErr != EVROverlayError.None)
+{
+  // whatever error handling
+}
+
+// Set the dashboard overlay up. First, the main overlay's texture
+overlayErr = OpenVR.Overlay.SetOverlayFromFile(overlayHandle, @"C:\path\to\file.png");
+
+if (overlayErr != EVROverlayError.None)
+{
+  // whatever error handling
+}
+
+// Then the thumbnail.
+overlayErr = OpenVR.Overlay.SetOverlayFromFile(thumbnailHandle, @"C:\path\to\thumb.png");
+
+if (overlayErr != EVROverlayError.None)
+{
+  // whatever error handling
+}
+```
+
 Docs coming Soon™️.
 
 ## Examples