Merge pull request #111456 from jumeder/user/jumeder/debugRenderingAPI

Adding DebugRenderingSettings documentation.

Author: PMEds28

articles/remote-rendering/overview/features/debug-rendering.md

@@ -0,0 +1,59 @@
+---
+title: Debug Rendering
+description: Overview of server-side debugging rendering effects
+author: jumeder
+ms.author: jumeder
+ms.date: 04/09/2020
+ms.topic: article
+---
+
+# Debug Rendering
+
+The debug rendering API provides a range of global options to alter server-side rendering with different debugging effects.
+
+## Available debug rendering effects
+
+|Setting                          | Effect                               |
+|---------------------------------|:-------------------------------------|
+|Frame counter                    | Renders a text overlay into the top-left corner of the frame. The text shows the current server-side frame ID, which is continuously incremented as rendering proceeds. |
+|Polygon count                    | Renders a text overlay into the top-left corner of the frame. The text shows the currently rendered amount of polygons, the same value as queried by [Server-side performance queries](performance-queries.md)| 
+|Wireframe                        | If enabled, all object geometry loaded on the server will be rendered in wireframe mode. Only the edges of polygons will be rasterized n this mode. |
+
+The following code enables these debugging effects:
+
+``` cs
+void EnableDebugRenderingEffects(AzureSession session, bool highlight)
+{
+    DebugRenderingSettings settings = session.Actions.DebugRenderingSettings;
+
+    // Enable frame counter text overlay on the server side rendering
+    settings.RenderFrameCount = true;
+
+    // Enable polygon count text overlay on the server side rendering
+    settings.RenderPolygonCount = true;
+
+    // Enable wireframe rendering of object geometry on the server
+    settings.RenderWireframe = true;
+}
+```
+
+![Debug rendering](./media/debug-rendering.png)
+
+> [!NOTE]
+> All debug rendering effects are global settings that affect the whole frame.
+
+## Use cases
+
+The debug rendering API is intended for simple debugging tasks, like verifying the service connection is actually up and running correctly. The text rendering options directly affect the down-streamed video frames. Enabling them verifies if new frames are received and video-decoded correctly.
+
+However, the provided effects do no give any detailed introspection into service health. The [Server-side performance queries](performance-queries.md) are recommended for this use case.
+
+## Performance considerations
+
+* Enabling the text overlays incurs little to no performance overhead.
+* Additionally enabling the overlay does incur a non-trivial performance overhead, though it may vary depending on the scene. For complex scenes, this mode can cause the framerate to drop below the 60-Hz target.
+
+## Next steps
+
+* [Rendering modes](../../concepts/rendering-modes.md)
+* [Server-side performance queries](performance-queries.md)

articles/remote-rendering/overview/features/media/debug-rendering.png

@@ -1,5 +1,7 @@
 - name: Cut planes
   href: cut-planes.md
+- name: Debug Rendering
+  href: debug-rendering.md
 - name: Hierarchical state override
   href: override-hierarchical-state.md
 - name: Late stage reprojection