Add new documentation manuals

Author: adamgraham

.docfx/manual/benchmarking.md

@@ -0,0 +1,25 @@
+# Benchmarking
+
+The Debug Tools package comes with a static class to perform function benchmark tests. The [Benchmark](xref:Zigurous.Debug.Benchmark) class can be used to measure the execution time of a single function or the comparison between multiple functions.
+
+```csharp
+// Measures the execution time of Foo over 1000 iterations.
+float time = Benchmark.Measure(Foo, 1000);
+
+// Compares the difference in execution time between Foo and Bar over 1000 iterations.
+float difference = Benchmark.Compare(Foo, Bar, 1000);
+
+// Performs a benchmark the executes each function 1000 times.
+// The time of each function will be logged individually.
+// You can pass as many functions as you want.
+Benchmark.Run(1000, Foo, Bar, Baz);
+```
+
+### Compare Equality
+
+Alternatively, sometimes it is useful to test if the results of two functions are equal. The Debug Tools package comes with another static class [Compare](xref:Zigurous.Debug.Compare`1) to handle these tests. The class uses generics to know the type of value you are looking to compare, and it returns the percentage of results that are equal.
+
+```csharp
+Compare<bool>.Test(Foo, Bar, 1000);
+Compare<float>.Test(Foo, Bar, 1000);
+```

.docfx/manual/framerate.md

@@ -0,0 +1,11 @@
+# Framerate Display
+
+The Debug Tools package comes with a script and prefab to display the framerate of the game in realtime. This can be useful if you need to know the framerate outside of the Unity editor.
+
+### Prefab
+
+Simply drag the `FPSDisplay.prefab` into your scene, and you are done! It already comes pre-formatted and is contained within its own UI canvas. You can further customize the display to your liking. By default it is displayed in the top-right corner with zero decimal digits.
+
+### Custom
+
+You can also create your own display if you prefer and add the [FPSDisplay](xref:Zigurous.Debug.FPSDisplay) script to it manually. The script allows you to customize the number of decimal digits to display and how often you want it to refresh. At the minimum, you must pass a reference to a UI Text component that displays the framerate.

.docfx/manual/index.md

@@ -1,3 +1,8 @@
 # Debug Tools
 
-The Debug Tools package contains assets and scripts for debugging Unity projects. Included in the package are scripts for enhanced console logging, comparing performance, displaying framerate, and more.
+The Debug Tools package contains assets and scripts for debugging Unity projects. Included in the package are scripts for enhanced console logging, benchmarking, displaying framerate, and more. The package also comes with shaders to visualize different vertex data.
+
+- [Logging](logging.md)
+- [Benchmarking](benchmarking.md)
+- [Framerate Display](framerate.md)
+- [Debug Shaders](shaders.md)

.docfx/manual/logging.md

@@ -0,0 +1,36 @@
+# Logging
+
+The Debug Tools package provides a static class with more robust logging functions compared to `UnityEngine.Debug`. The [Log](xref:Zigurous.Debug.Log) class can log messages, warnings, and errors to the console. One primary difference is you can log multiple messages through a single function call.
+
+```csharp
+Log.Message(a, b, c);
+Log.Warning(a, b, c);
+Log.Error(a, b, c);
+```
+
+You can also provide a custom prefix to display for the message as well as a given context.
+
+```csharp
+Log.Message(foo, "[Zigurous]:");
+Log.Warning(foo, "[Zigurous]:");
+Log.Error(foo, "[Zigurous]:");
+
+Log.Message(foo, context);
+Log.Warning(foo, context);
+Log.Error(foo, context);
+```
+
+### Customization
+
+You can customize the delimiter used when logging multiple messages, and you can set a global prefix that is displayed before each message in order to separate them from others.
+
+```csharp
+Log.delimiter = ",";
+Log.prefix = "[Zigurous]:";
+```
+
+The class also handles null checking to not cause any errors if you log an invalid object. You can even set the string that is displayed when a null reference is logged.
+
+```csharp
+Log.nullReference = "Null";
+```

.docfx/manual/shaders.md

@@ -0,0 +1,76 @@
+# Debug Shaders
+
+The Debug Tools package comes with several shaders to visualize different vertex data. These shaders are located under `Zigurous > Debug` within the shader selection menu.
+
+### UV
+
+```hlsl
+v2f vert (appdata v)
+{
+    v2f o;
+    o.pos = UnityObjectToClipPos(v.vertex);
+    o.uv = float4(v.texcoord.xy, 0, 0);
+    return o;
+}
+```
+
+![](https://docs.unity3d.com/uploads/Main/SL-DebugUV1.png)
+
+### Normals
+
+```hlsl
+v2f vert (appdata v)
+{
+    v2f o;
+    o.pos = UnityObjectToClipPos(v.vertex);
+    o.color.xyz = v.normal * 0.5 + 0.5;
+    o.color.w = 1.0;
+    return o;
+}
+```
+
+![](https://docs.unity3d.com/uploads/Main/SL-DebugNormals.png)
+
+### Tangents
+
+```hlsl
+v2f vert (appdata v)
+{
+    v2f o;
+    o.pos = UnityObjectToClipPos(v.vertex);
+    o.color = v.tangent * 0.5 + 0.5;
+    return o;
+}
+```
+
+![](https://docs.unity3d.com/uploads/Main/SL-DebugTangents.png)
+
+### Bitangents
+
+```hlsl
+v2f vert (appdata v)
+{
+    v2f o;
+    o.pos = UnityObjectToClipPos(v.vertex);
+    float3 bitangent = cross(v.normal, v.tangent.xyz) * v.tangent.w;
+    o.color.xyz = bitangent * 0.5 + 0.5;
+    o.color.w = 1.0;
+    return o;
+}
+```
+
+![](https://docs.unity3d.com/uploads/Main/SL-DebugBinormals.png)
+
+### Vertex Color
+
+```hlsl
+v2f vert (appdata v)
+{
+    v2f o;
+    o.pos = UnityObjectToClipPos(v.vertex);
+    o.color = v.color;
+    return o;
+}
+```
+
+![](https://docs.unity3d.com/uploads/Main/SL-DebugColors.png)

.docfx/manual/toc.yml

@@ -2,3 +2,13 @@
   href: index.md
 - name: Installation
   href: installation.md
+- name: Reference
+  items:
+  - name: Logging
+    href: logging.md
+  - name: Benchmarking
+    href: benchmarking.md
+  - name: Framerate Display
+    href: framerate.md
+  - name: Debug Shaders
+    href: shaders.md

README.md

@@ -1,6 +1,6 @@
 # Debug Tools
 
-The Debug Tools package contains assets and scripts for debugging Unity projects. Included in the package are scripts for enhanced console logging, comparing performance, displaying framerate, and more.
+The Debug Tools package contains assets and scripts for debugging Unity projects. Included in the package are scripts for enhanced console logging, benchmarking, displaying framerate, and more. The package also comes with shaders to visualize different vertex data.
 
 ## Installation
 
@@ -29,3 +29,10 @@ Import the package namespace in each script or file you want to use it.
 ```csharp
 using Zigurous.Debug;
 ```
+
+## Reference
+
+- [Logging](https://docs.zigurous.com/com.zigurous.debug/manual/logging.html)
+- [Benchmarking](https://docs.zigurous.com/com.zigurous.debug/manual/benchmarking.html)
+- [Framerate Display](https://docs.zigurous.com/com.zigurous.debug/manual/framerate.html)
+- [Debug Shaders](https://docs.zigurous.com/com.zigurous.debug/manual/shaders.html)

package.json

@@ -2,7 +2,7 @@
   "name": "com.zigurous.debug",
   "version": "1.1.0",
   "displayName": "Zigurous Debug Tools",
-  "description": "The Debug Tools package contains assets and scripts for debugging Unity projects. Included in the package are scripts for enhanced console logging, comparing performance, displaying framerate, and more.",
+  "description": "The Debug Tools package contains assets and scripts for debugging Unity projects. Included in the package are scripts for enhanced console logging, benchmarking, displaying framerate, and more. The package also comes with shaders to visualize different vertex data.",
   "unity": "2019.4",
   "keywords": [
     "debug",