Debug renderer

The debug renderer is a placeholder renderer you can use with scripts to print debug information. By default, the debug renderer is included in the graphics compositor as a child of the game entry point.

Debug renderer

Create a debug renderer

To create a debug renderer, right-click the graphics compositor editor and select Debug renderer.

Create debug renderer

Connect a debug renderer to an entry point

In most cases, you want the debug renderer to share an entry point with one or more forward renderers. To do this, use a scene renderer collection and select the debug renderer and forward renderer(s) as children, as in the screenshot below:

Debug renderer Property Grid

Use a debug renderer

To use the debug renderer, reference it in your script and add debug render stages.

For example, the Debug physics shapes script included in Xenko uses the debug renderer to display collider shapes at runtime.

  1. using System.Linq;
  2. using System.Threading.Tasks;
  3. using Xenko.Input;
  4. using Xenko.Engine;
  5. using Xenko.Physics;
  6. using Xenko.Rendering;
  7. using Xenko.Rendering.Compositing;
  9. namespace MyGame
  10. {
  11.     public class DebugPhysicsShapes : AsyncScript
  12.     {
  13.         public RenderGroup RenderGroup = RenderGroup.Group7;
  15.         public override async Task Execute()
  16.         {
  17.         //set up rendering in the debug entry point if we have it
  18.         var compositor = SceneSystem.GraphicsCompositor;
  19.         var debugRenderer =
  20.             ((compositor.Game as SceneCameraRenderer)?.Child as SceneRendererCollection)?.Children.Where(
  21.                 x => x is DebugRenderer).Cast<DebugRenderer>().FirstOrDefault();
  22.         if (debugRenderer == null)
  23.             return;
  25.         var shapesRenderState = new RenderStage("PhysicsDebugShapes", "Main");
  26.             compositor.RenderStages.Add(shapesRenderState);
  27.             var meshRenderFeature = compositor.RenderFeatures.OfType<MeshRenderFeature>().First();
  28.             meshRenderFeature.RenderStageSelectors.Add(new SimpleGroupToRenderStageSelector
  29.             {
  30.                 EffectName = "XenkoForwardShadingEffect",
  31.                 RenderGroup = (RenderGroupMask)(1 << (int)RenderGroup),
  32.                 RenderStage = shapesRenderState,
  33.             });
  34.             meshRenderFeature.PipelineProcessors.Add(new WireframePipelineProcessor { RenderStage = shapesRenderState });
  35.             debugRenderer.DebugRenderStages.Add(shapesRenderState);
  37.             var simulation = this.GetSimulation();
  38.             if (simulation != null)
  39.                 simulation.ColliderShapesRenderGroup = RenderGroup;
  41.             var enabled = false;
  42.             while (Game.IsRunning)
  43.             {
  44.                 if (Input.IsKeyDown(Keys.LeftShift) && Input.IsKeyDown(Keys.LeftCtrl) && Input.IsKeyReleased(Keys.P))
  45.                 {
  46.                     if (simulation != null)
  47.                     {
  48.                         if (enabled)
  49.                         {
  50.                             simulation.ColliderShapesRendering = false;
  51.                             enabled = false;
  52.                         }
  53.                         else
  54.                         {
  55.                             simulation.ColliderShapesRendering = true;
  56.                             enabled = true;
  57.                         }
  58.                     }
  59.                 }
  61.                 await Script.NextFrame();
  62.             }
  63.         }
  64.     }
  65. }

For information about how to use this script, see Colliders.

See also