Class UIComponent

Namespace

Stride.Engine

Assembly

Stride.UI.dll

Add an UIPage to an Entity.

[DataContract("UIComponent")]
[Display("UI", null, Expand = ExpandRule.Once)]
[DefaultEntityComponentRenderer(typeof(UIRenderProcessor))]
[ComponentOrder(9800)]
[ComponentCategory("UI")]
public sealed class UIComponent : ActivableEntityComponent, IIdentifiable

Inheritance

object

EntityComponent

ActivableEntityComponent

UIComponent

Implements

IIdentifiable

Inherited Members

ActivableEntityComponent.Enabled

EntityComponent.Entity

EntityComponent.Id

Constructors

UIComponent()

public UIComponent()

Fields

DefaultDepth

public static readonly float DefaultDepth

Field Value

float

DefaultHeight

public static readonly float DefaultHeight

Field Value

float

DefaultWidth

public static readonly float DefaultWidth

Field Value

float

FixedSizeVerticalUnit

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

public const float FixedSizeVerticalUnit = 1

Field Value

float

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

bool

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

bool

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

bool

Page

Gets or sets the UI page.

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

Property Value

UIPage

RenderGroup

The render group for this component.

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

Property Value

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

Vector3

ResolutionStretch

Gets or sets the camera.

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

Property Value

ResolutionStretch

The camera.

Sampler

Specifies the sampling method to be used for this component

[DataMember(15)]
[Display("Sampler", null)]
public UIElementSampler Sampler { get; set; }

Property Value

UIElementSampler

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

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

bool