Class UISystem

Namespace

Stride.UI

Assembly

Stride.UI.dll

Interface of the UI system.

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

Inheritance

object

DisposeBase

ComponentBase

GameSystemBase

UISystem

Implements

IDisposable

ICollectorHolder

IGameSystemBase

IComponent

IReferencable

IUpdateable

IDrawable

IContentable

IService

Inherited Members

GameSystemBase.Game

GameSystemBase.Services

GameSystemBase.Content

GameSystemBase.GraphicsDevice

GameSystemBase.DrawOrderChanged

GameSystemBase.VisibleChanged

GameSystemBase.BeginDraw()

GameSystemBase.Draw(GameTime)

GameSystemBase.EndDraw()

GameSystemBase.Visible

GameSystemBase.DrawOrder

GameSystemBase.InitializeGraphicsDeviceService()

GameSystemBase.EnabledChanged

GameSystemBase.UpdateOrderChanged

GameSystemBase.Enabled

GameSystemBase.UpdateOrder

GameSystemBase.OnDrawOrderChanged(object, EventArgs)

GameSystemBase.OnUpdateOrderChanged(object, EventArgs)

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

UISystem(IServiceRegistry)

public UISystem(IServiceRegistry registry)

Parameters

registry IServiceRegistry

Properties

FocusedElement

The UIElement that currently has the focus.

public UIElement FocusedElement { get; }

Property Value

UIElement

UIElementUnderMouseCursor

Represents the UI-element currently under the mouse cursor. Only elements with CanBeHitByUser == true are taken into account. Last processed element_state / ?UIComponent? with a valid element will be used.

public UIElement UIElementUnderMouseCursor { get; }

Property Value

UIElement

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.

Initialize()

Initializes the Game System.

public override void Initialize()

Remarks

This method is called when the component is added to the Game. This can be used for tasks like querying for services the component needs and setting up non-graphics resources (as here the Graphics Device may have not been initialized yet).

LoadContent()

protected override void LoadContent()

NewInstance(IServiceRegistry)

public static IService NewInstance(IServiceRegistry services)

Parameters

services IServiceRegistry

Returns

IService

Update(GameTime)

This method is called when this game component is updated.

public override void Update(GameTime gameTime)

Parameters

gameTime GameTime

The current timing.