Table of Contents

Class EntityDebugSceneRenderer

Namespace
Stride.CommunityToolkit.Rendering.Compositing
Assembly
Stride.CommunityToolkit.dll

Renders debug information (such as entity names and positions) for all entities in a scene.

public class EntityDebugSceneRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
Inheritance
EntityDebugSceneRenderer
Implements
Inherited Members

Remarks

This class is designed to display debug information such as entity names and positions on the screen using 2D text rendering over the 3D scene. It also allows optional customization, such as font size, color, and background.

Constructors

EntityDebugSceneRenderer()

Initializes a new instance of the EntityDebugSceneRenderer class with default rendering options.

public EntityDebugSceneRenderer()

EntityDebugSceneRenderer(EntityDebugSceneRendererOptions?)

Initializes a new instance of the EntityDebugSceneRenderer class with the specified rendering options.

public EntityDebugSceneRenderer(EntityDebugSceneRendererOptions? options = null)

Parameters

options EntityDebugSceneRendererOptions

The options to customize the appearance of the debug text. If null, default options are used.

Methods

DrawCore(RenderContext, RenderDrawContext)

Draws debug information (such as entity names and positions) for all entities in the current scene.

protected override void DrawCore(RenderContext context, RenderDrawContext drawContext)

Parameters

context RenderContext

The current rendering context, which provides information such as the scene and camera.

drawContext RenderDrawContext

The context used to draw graphical elements.

InitializeCore()

Initializes core resources needed by the renderer, such as the font and sprite batch.

protected override void InitializeCore()
Edit this page