Class GameProfilingSystem

Namespace

Stride.Profiling

Assembly

Stride.Engine.dll

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

Inheritance

object

DisposeBase

ComponentBase

GameSystemBase

GameProfilingSystem

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.InitializeGraphicsDeviceService()

GameSystemBase.EnabledChanged

GameSystemBase.UpdateOrderChanged

GameSystemBase.Update(GameTime)

GameSystemBase.Enabled

GameSystemBase.UpdateOrder

GameSystemBase.OnDrawOrderChanged(object, EventArgs)

GameSystemBase.OnUpdateOrderChanged(object, EventArgs)

GameSystemBase.LoadContent()

GameSystemBase.UnloadContent()

ComponentBase.Tags

ComponentBase.Name

ComponentBase.OnNameChanged()

ComponentBase.ToString()

DisposeBase.IsDisposed

DisposeBase.Dispose()

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

UnsafeUtilities.As<T>(object?)

Constructors

GameProfilingSystem(IServiceRegistry)

Initializes a new instance of the GameProfilingSystem class.

public GameProfilingSystem(IServiceRegistry registry)

Parameters

registry IServiceRegistry

The service registry.

Properties

CurrentResultPage

Sets or gets the profiling result page to display.

public uint CurrentResultPage { get; set; }

Property Value

uint

FilteringMode

Sets or gets which data should be displayed on screen.

public GameProfilingResults FilteringMode { get; set; }

Property Value

GameProfilingResults

RefreshTime

Sets or gets the refreshing time of the profiling information in milliseconds.

public double RefreshTime { get; set; }

Property Value

double

RenderTarget

The render target where the profiling results should be rendered into. If null, the BackBuffer is used.

public Texture RenderTarget { get; set; }

Property Value

Texture

SortingMode

Sets or gets the way the printed information will be sorted.

public GameProfilingSorting SortingMode { get; set; }

Property Value

GameProfilingSorting

TextColor

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

public Color4 TextColor { get; set; }

Property Value

Color4

Methods

Destroy()

Disposes the object's resources.

protected override void Destroy()

Remarks

Override in a derived class to implement disposal logic specific to it.

This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released.

DisableProfiling()

Disables the profiling system drawing.

public void DisableProfiling()

Draw(GameTime)

Draws the Game Component.

public override void Draw(GameTime gameTime)

Parameters

gameTime GameTime

The current timing information.

EnableProfiling(bool, params ProfilingKey[])

Enables the profiling system drawing.

public void EnableProfiling(bool excludeKeys = false, params ProfilingKey[] keys)

Parameters

excludeKeys bool

If true the keys specified after are excluded from rendering, if false they will be exclusively included.

keys ProfilingKey[]

The keys to exclude or include.