UIRenderProcessor Class

Namespace: Stride.Rendering.UI
Assembly: Stride.UI.dll

The processor in charge of updating and drawing the entities having UI components.

System.Object → EntityProcessor → EntityProcessor<UIComponent, RenderUIElement> → UIRenderProcessor

Derived from UIRenderProcessor:

public class UIRenderProcessor : EntityProcessor<UIComponent, RenderUIElement>, IEntityComponentRenderProcessor

Name		Description
Constructors
	UIRenderProcessor()	Initializes a new instance of the UIRenderProcessor class.
Properties
	UIRoots
	VisibilityGroup
Methods
	Draw(RenderContext)
	GenerateComponentData(Entity, UIComponent)
	IsAssociatedDataValid(Entity, UIComponent, RenderUIElement)
	OnEntityComponentAdding(Entity, UIComponent, RenderUIElement)
	OnEntityComponentRemoved(Entity, UIComponent, RenderUIElement)

| Improve this Doc View Source

Constructors

UIRenderProcessor()

Initializes a new instance of the UIRenderProcessor class.

public UIRenderProcessor()

| Improve this Doc View Source

Properties

UIRoots

public List<RenderUIElement> UIRoots { get; }

Property Value

Type	Description
System.Collections.Generic.List<RenderUIElement>

VisibilityGroup

public VisibilityGroup VisibilityGroup { get; set; }

Property Value

Type	Description
VisibilityGroup

| Improve this Doc View Source

Methods

Draw(RenderContext)

public override void Draw(RenderContext gameTime)

Parameters

Type	Name	Description
RenderContext	gameTime

Overrides

EntityProcessor.Draw(RenderContext)

GenerateComponentData(Entity, UIComponent)

protected override RenderUIElement GenerateComponentData(Entity entity, UIComponent component)

Parameters

Type	Name	Description
Entity	entity
UIComponent	component

Returns

Type	Description
RenderUIElement

Overrides

Stride.Engine.EntityProcessor<Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement>.GenerateComponentData(Stride.Engine.Entity, Stride.Engine.UIComponent)

IsAssociatedDataValid(Entity, UIComponent, RenderUIElement)

protected override bool IsAssociatedDataValid(Entity entity, UIComponent component, RenderUIElement associatedData)

Parameters

Type	Name	Description
Entity	entity
UIComponent	component
RenderUIElement	associatedData

Returns

Type	Description
System.Boolean

Overrides

Stride.Engine.EntityProcessor<Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement>.IsAssociatedDataValid(Stride.Engine.Entity, Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement)

OnEntityComponentAdding(Entity, UIComponent, RenderUIElement)

protected override void OnEntityComponentAdding(Entity entity, UIComponent uiComponent, RenderUIElement renderUIElement)

Parameters

Type	Name	Description
Entity	entity
UIComponent	uiComponent
RenderUIElement	renderUIElement

Overrides

Stride.Engine.EntityProcessor<Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement>.OnEntityComponentAdding(Stride.Engine.Entity, Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement)

OnEntityComponentRemoved(Entity, UIComponent, RenderUIElement)

protected override void OnEntityComponentRemoved(Entity entity, UIComponent uiComponent, RenderUIElement renderUIElement)

Parameters

Type	Name	Description
Entity	entity
UIComponent	uiComponent
RenderUIElement	renderUIElement

Overrides

Stride.Engine.EntityProcessor<Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement>.OnEntityComponentRemoved(Stride.Engine.Entity, Stride.Engine.UIComponent, Stride.Rendering.UI.RenderUIElement)