Class EntityDebugSceneRenderer

Namespace

Stride.CommunityToolkit.Renderers

Assembly

Stride.CommunityToolkit.dll

Scene renderer that draws per-entity debug information - the entity's name and/or position - as screen-space text over the 3D scene.

public class EntityDebugSceneRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

SceneRendererBase

EntityDebugSceneRenderer

Implements

IComponent

IReferencable

ICollectorHolder

ISceneRenderer

IRenderCollector

IGraphicsRenderer

IGraphicsRendererBase

IGraphicsRendererCore

IDisposable

Inherited Members

SceneRendererBase.Collect(RenderContext)

SceneRendererBase.Draw(RenderDrawContext)

SceneRendererBase.CollectCore(RenderContext)

SceneRendererBase.Id

RendererCoreBase.Initialize(RenderContext)

RendererCoreBase.Unload()

RendererCoreBase.PreDrawCore(RenderDrawContext)

RendererCoreBase.PostDrawCore(RenderDrawContext)

RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat)

RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage)

RendererCoreBase.PushScopedResource<T>(T)

RendererCoreBase.CheckIsInDrawCore()

RendererCoreBase.ToLoadAndUnload<T>(T)

RendererCoreBase.PreDrawCoreInternal(RenderDrawContext)

RendererCoreBase.EnsureContext(RenderContext)

RendererCoreBase.PostDrawCoreInternal(RenderDrawContext)

RendererCoreBase.Enabled

RendererCoreBase.Profiling

RendererCoreBase.GPUProfilingKey

RendererCoreBase.CPUProfilingKey

RendererCoreBase.Context

RendererCoreBase.Services

RendererCoreBase.Content

RendererCoreBase.GraphicsDevice

RendererCoreBase.EffectSystem

RendererCoreBase.Initialized

ComponentBase.Tags

ComponentBase.OnNameChanged()

ComponentBase.ToString()

ComponentBase.Name

DisposeBase.Dispose()

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

DisposeBase.IsDisposed

Remarks

Appearance is controlled through EntityDebugSceneRendererOptions. Unlike EntityTextRenderer, which draws text that entities opt into by carrying an EntityTextComponent, this labels entities automatically and styles them all the same way - it is a debugging overlay to switch on, not authored content.

The two share their drawing through Stride.CommunityToolkit.Renderers.ScreenTextDrawer, so anchoring, backgrounds, shadows and projection behave identically in both.

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

Options to customize debug text appearance. If null, defaults are used.

Methods

Destroy()

protected override void Destroy()

DrawCore(RenderContext, RenderDrawContext)

protected override void DrawCore(RenderContext context, RenderDrawContext drawContext)

Parameters

context RenderContext

drawContext RenderDrawContext

InitializeCore()

protected override void InitializeCore()