UIComponent Class

    Namespace: Stride.Engine
    Assembly: Stride.UI.dll

    Add an UIPage to an Entity.

    System.Object → EntityComponent → ActivableEntityComponent → UIComponent
    Derived from UIComponent: 

    [DataContract("UIComponent")]
[Display("UI", null, Expand = ExpandRule.Once)]
[DefaultEntityComponentRenderer(typeof(UIRenderProcessor))]
[ComponentOrder(9800)]
[ComponentCategory("UI")]
public sealed class UIComponent : ActivableEntityComponent, IIdentifiable
    Name Description
    Constructors
    UIComponent()
    Fields
    DefaultDepth
    DefaultHeight
    DefaultWidth
    FixedSizeVerticalUnit

    A fixed size UI component with height of 1 will be this much of the vertical resolution on screen
    Properties
    IsBillboard

    Gets or sets the value indicating whether the UI should be displayed as billboard.
    IsFixedSize

    Gets or sets the value indicating whether the UI should be always a fixed size on the screen.
    IsFullScreen

    Gets or sets the value indicating whether the UI should be full screen.
    Page

    Gets or sets the UI page.
    RenderGroup

    The render group for this component.
    Resolution

    Gets or sets the virtual resolution of the UI in virtual pixels.
    ResolutionStretch

    Gets or sets the camera.
    Size

    Gets or sets the actual size of the UI component in world units. This value is ignored in fullscreen mode.
    SnapText

    Gets or sets the value indicating of the UI texts should be snapped to closest pixel.
    | Improve this Doc View Source

    Constructors

    UIComponent()

    public UIComponent()
    | Improve this Doc View Source

    Fields

    DefaultDepth

    public static readonly float DefaultDepth
    Field Value
    Type Description
    System.Single

    DefaultHeight

    public static readonly float DefaultHeight
    Field Value
    Type Description
    System.Single

    DefaultWidth

    public static readonly float DefaultWidth
    Field Value
    Type Description
    System.Single

    FixedSizeVerticalUnit

    A fixed size UI component with height of 1 will be this much of the vertical resolution on screen

    public const float FixedSizeVerticalUnit = 1F
    Field Value
    Type Description
    System.Single
    | Improve this Doc View Source

    Properties

    IsBillboard

    Gets or sets the value indicating whether the UI should be displayed as billboard.

    [DataMember(50)]
[Display("Billboard", null)]
public bool IsBillboard { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsFixedSize

    Gets or sets the value indicating whether the UI should be always a fixed size on the screen.

    [DataMember(70)]
[Display("Fixed Size", null)]
public bool IsFixedSize { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsFullScreen

    Gets or sets the value indicating whether the UI should be full screen.

    [DataMember(20)]
[Display("Full Screen", null)]
public bool IsFullScreen { get; set; }
    Property Value
    Type Description
    System.Boolean

    Page

    Gets or sets the UI page.

    [DataMember(10)]
[Display("Page", null)]
public UIPage Page { get; set; }
    Property Value
    Type Description
    UIPage

    RenderGroup

    The render group for this component.

    [DataMember(80)]
[Display("Render group", null)]
public RenderGroup RenderGroup { get; set; }
    Property Value
    Type Description
    RenderGroup

    Resolution

    Gets or sets the virtual resolution of the UI in virtual pixels.

    [DataMember(30)]
[Display("Resolution", null)]
public Vector3 Resolution { get; set; }
    Property Value
    Type Description
    Vector3

    ResolutionStretch

    Gets or sets the camera.

    [DataMember(40)]
[Display("Resolution Stretch", null)]
public ResolutionStretch ResolutionStretch { get; set; }
    Property Value
    Type Description
    ResolutionStretch

    The camera.

    Size

    Gets or sets the actual size of the UI component in world units. This value is ignored in fullscreen mode.

    [DataMember(35)]
[Display("Size", null)]
public Vector3 Size { get; set; }
    Property Value
    Type Description
    Vector3

    SnapText

    Gets or sets the value indicating of the UI texts should be snapped to closest pixel.

    [DataMember(60)]
[Display("Snap Text", null)]
public bool SnapText { get; set; }
    Property Value
    Type Description
    System.Boolean

    Inherited Members

    Extension Methods