GameProfilingSystem Class

    Namespace: Stride.Profiling
    Assembly: Stride.Engine.dll
    System.Object → DisposeBase → ComponentBase → GameSystemBase → GameProfilingSystem
    Derived from GameProfilingSystem: 

    public class GameProfilingSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable
    Name Description
    Constructors
    GameProfilingSystem(IServiceRegistry)

    Initializes a new instance of the GameProfilingSystem class.
    Properties
    CurrentResultPage

    Sets or gets the profiling result page to display.
    FilteringMode

    Sets or gets which data should be displayed on screen.
    RefreshTime

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

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

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

    Sets or gets the color to use when drawing the profiling system fonts.
    Methods
    Destroy()

    Disposes of object resources.
    DisableProfiling()

    Disables the profiling system drawing.
    Draw(GameTime)
    EnableProfiling(Boolean, ProfilingKey[])

    Enables the profiling system drawing.
    Update(GameTime)
    | Improve this Doc View Source

    Constructors

    GameProfilingSystem(IServiceRegistry)

    Initializes a new instance of the GameProfilingSystem class.

    public GameProfilingSystem(IServiceRegistry registry)
    Parameters
    Type Name Description
    IServiceRegistry registry

    The service registry.
    | Improve this Doc View Source

    Properties

    CurrentResultPage

    Sets or gets the profiling result page to display.

    public uint CurrentResultPage { get; set; }
    Property Value
    Type Description
    System.UInt32

    FilteringMode

    Sets or gets which data should be displayed on screen.

    public GameProfilingResults FilteringMode { get; set; }
    Property Value
    Type Description
    GameProfilingResults

    RefreshTime

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

    public double RefreshTime { get; set; }
    Property Value
    Type Description
    System.Double

    RenderTarget

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

    public Texture RenderTarget { get; set; }
    Property Value
    Type Description
    Texture

    SortingMode

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

    public GameProfilingSorting SortingMode { get; set; }
    Property Value
    Type Description
    GameProfilingSorting

    TextColor

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

    public Color4 TextColor { get; set; }
    Property Value
    Type Description
    Color4
    | Improve this Doc View Source

    Methods

    Destroy()

    Disposes of object resources.

    protected override void Destroy()
    Overrides

    DisableProfiling()

    Disables the profiling system drawing.

    public void DisableProfiling()

    Draw(GameTime)

    public override void Draw(GameTime gameTime)
    Parameters
    Type Name Description
    GameTime gameTime
    Overrides

    EnableProfiling(Boolean, ProfilingKey[])

    Enables the profiling system drawing.

    public void EnableProfiling(bool excludeKeys = false, params ProfilingKey[] keys)
    Parameters
    Type Name Description
    System.Boolean excludeKeys

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

    The keys to exclude or include.

    Update(GameTime)

    public override void Update(GameTime gameTime)
    Parameters
    Type Name Description
    GameTime gameTime
    Overrides

    Inherited Members

    Extension Methods