Class UIRenderProcessor

Namespace

Stride.Rendering.UI

Assembly

Stride.UI.dll

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

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

Inheritance

object

EntityProcessor

EntityProcessor<UIComponent, RenderUIElement>

UIRenderProcessor

Implements

IEntityComponentRenderProcessor

Inherited Members

EntityProcessor<UIComponent, RenderUIElement>.ComponentDatas

EntityProcessor<UIComponent, RenderUIElement>.OnSystemAdd()

EntityProcessor<UIComponent, RenderUIElement>.OnSystemRemove()

EntityProcessor<UIComponent, RenderUIElement>.RemoveAllEntities()

EntityProcessor<UIComponent, RenderUIElement>.ProcessEntityComponent(Entity, EntityComponent, bool)

EntityProcessor<UIComponent, RenderUIElement>.GenerateComponentData(Entity, UIComponent)

EntityProcessor<UIComponent, RenderUIElement>.IsAssociatedDataValid(Entity, UIComponent, RenderUIElement)

EntityProcessor<UIComponent, RenderUIElement>.OnEntityComponentAdding(Entity, UIComponent, RenderUIElement)

EntityProcessor<UIComponent, RenderUIElement>.OnEntityComponentRemoved(Entity, UIComponent, RenderUIElement)

EntityProcessor.Tags

EntityProcessor.UpdateProfilingState

EntityProcessor.DrawProfilingState

EntityProcessor.Enabled

EntityProcessor.MainComponentType

EntityProcessor.RequiredTypes

EntityProcessor.HasRequiredComponents

EntityProcessor.Order

EntityProcessor.EntityManager

EntityProcessor.Services

EntityProcessor.Update(GameTime)

EntityProcessor.OnSystemAdd()

EntityProcessor.OnSystemRemove()

EntityProcessor.RemoveAllEntities()

EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, bool)

EntityProcessor.InternalAddEntity(Entity)

EntityProcessor.InternalRemoveEntity(Entity, bool)

Constructors

UIRenderProcessor()

Initializes a new instance of the UIRenderProcessor class.

public UIRenderProcessor()

Properties

UIRoots

public List<RenderUIElement> UIRoots { get; }

Property Value

List<RenderUIElement>

VisibilityGroup

public VisibilityGroup VisibilityGroup { get; set; }

Property Value

VisibilityGroup

Methods

Draw(RenderContext)

Performs work related to this processor.

public override void Draw(RenderContext gameTime)

Parameters

gameTime RenderContext

GenerateComponentData(Entity, UIComponent)

Generates associated data to the given entity.

protected override RenderUIElement GenerateComponentData(Entity entity, UIComponent component)

Parameters

entity Entity

The entity.

component UIComponent

Returns

RenderUIElement

The associated data.

IsAssociatedDataValid(Entity, UIComponent, RenderUIElement)

Checks if the current associated data is valid, or if readding the entity is required.

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

Parameters

entity Entity

The entity.

component UIComponent

associatedData RenderUIElement

The associated data.

Returns

bool

True if the change in associated data requires the entity to be readded, false otherwise.

OnEntityComponentAdding(Entity, UIComponent, RenderUIElement)

Run when a matching entity is added to this entity processor.

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

Parameters

entity Entity

The entity.

uiComponent UIComponent

renderUIElement RenderUIElement

OnEntityComponentRemoved(Entity, UIComponent, RenderUIElement)

Run when a matching entity is removed from this entity processor.

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

Parameters

entity Entity

The entity.

uiComponent UIComponent

renderUIElement RenderUIElement