Class DebugTextSystem

Namespace

Stride.Profiling

Assembly

Stride.Engine.dll

public class DebugTextSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable

Inheritance

object

DisposeBase

ComponentBase

GameSystemBase

DebugTextSystem

Implements

IDisposable

ICollectorHolder

IGameSystemBase

IComponent

IReferencable

IUpdateable

IDrawable

IContentable

Inherited Members

GameSystemBase.Game

GameSystemBase.Services

GameSystemBase.Content

GameSystemBase.GraphicsDevice

GameSystemBase.DrawOrderChanged

GameSystemBase.VisibleChanged

GameSystemBase.BeginDraw()

GameSystemBase.EndDraw()

GameSystemBase.Visible

GameSystemBase.DrawOrder

GameSystemBase.Initialize()

GameSystemBase.InitGraphicsDeviceService()

GameSystemBase.EnabledChanged

GameSystemBase.UpdateOrderChanged

GameSystemBase.Enabled

GameSystemBase.UpdateOrder

GameSystemBase.OnDrawOrderChanged(object, EventArgs)

GameSystemBase.OnUpdateOrderChanged(object, EventArgs)

GameSystemBase.LoadContent()

GameSystemBase.UnloadContent()

ComponentBase.Tags

ComponentBase.Name

ComponentBase.Destroy()

ComponentBase.OnNameChanged()

ComponentBase.ToString()

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

DebugTextSystem(IServiceRegistry)

public DebugTextSystem(IServiceRegistry registry)

Parameters

registry IServiceRegistry

Properties

DefaultOnScreenTime

Sets or gets the time that messages will stay on screen by default.

public TimeSpan DefaultOnScreenTime { get; set; }

Property Value

TimeSpan

TailSize

Sets or gets the size of the messages queue, older messages will be discarded if the size is greater.

public int TailSize { get; set; }

Property Value

int

TextColor

Sets or gets the color to use when drawing the profiling system fonts.

public Color4 TextColor { get; set; }

Property Value

Color4

Methods

Draw(GameTime)

Draws this instance.

public override void Draw(GameTime gameTime)

Parameters

gameTime GameTime

The current timing.

Print(string, Int2, Color4?, TimeSpan?)

Print a custom overlay message

public void Print(string message, Int2 position, Color4? color = null, TimeSpan? timeOnScreen = null)

Parameters

message string

position Int2

color Color4?

timeOnScreen TimeSpan?

Update(GameTime)

This method is called when this game component is updated.

public override void Update(GameTime gameTime)

Parameters

gameTime GameTime

The current timing.